From 113801bb424368e2fbdfb2a8c80c87193042ac82 Mon Sep 17 00:00:00 2001 From: Ricardo Ribeiro Date: Fri, 11 Oct 2024 10:28:03 +0000 Subject: [PATCH] update: source github.com/jsonnet-libs/k8s@6e8fad37 --- 0.14/_custom/endpoint.libsonnet | 252 + 0.14/_custom/pod_metrics_endpoint.libsonnet | 243 + 0.14/_custom/relabel_config.libsonnet | 40 + 0.14/_gen/monitoring/main.libsonnet | 6 + .../_gen/monitoring/v1/alertmanager.libsonnet | 2988 +++ 0.14/_gen/monitoring/v1/main.libsonnet | 11 + 0.14/_gen/monitoring/v1/podMonitor.libsonnet | 421 + 0.14/_gen/monitoring/v1/probe.libsonnet | 430 + 0.14/_gen/monitoring/v1/prometheus.libsonnet | 4345 ++++ .../monitoring/v1/prometheusRule.libsonnet | 95 + .../monitoring/v1/serviceMonitor.libsonnet | 433 + 0.14/_gen/monitoring/v1/thanosRuler.libsonnet | 2789 +++ .../v1alpha1/alertmanagerConfig.libsonnet | 3587 ++++ 0.14/_gen/monitoring/v1alpha1/main.libsonnet | 7 + .../v1alpha1/prometheusAgent.libsonnet | 3581 ++++ .../v1alpha1/scrapeConfig.libsonnet | 3829 ++++ 0.14/gen.libsonnet | 5 + 0.14/main.libsonnet | 1 + docs/0.14/README.md | 13 + docs/0.14/monitoring/index.md | 10 + docs/0.14/monitoring/v1/alertmanager.md | 11262 +++++++++++ docs/0.14/monitoring/v1/endpoint.md | 629 + docs/0.14/monitoring/v1/index.md | 18 + docs/0.14/monitoring/v1/podMetricsEndpoint.md | 602 + docs/0.14/monitoring/v1/podMonitor.md | 1598 ++ docs/0.14/monitoring/v1/probe.md | 1615 ++ docs/0.14/monitoring/v1/prometheus.md | 16435 ++++++++++++++++ docs/0.14/monitoring/v1/prometheusRule.md | 381 + docs/0.14/monitoring/v1/relabelConfig.md | 75 + docs/0.14/monitoring/v1/serviceMonitor.md | 1654 ++ docs/0.14/monitoring/v1/thanosRuler.md | 10577 ++++++++++ .../monitoring/v1alpha1/alertmanagerConfig.md | 12909 ++++++++++++ docs/0.14/monitoring/v1alpha1/endpoint.md | 629 + docs/0.14/monitoring/v1alpha1/index.md | 14 + .../monitoring/v1alpha1/podMetricsEndpoint.md | 602 + .../monitoring/v1alpha1/prometheusAgent.md | 13578 +++++++++++++ .../0.14/monitoring/v1alpha1/relabelConfig.md | 75 + docs/0.14/monitoring/v1alpha1/scrapeConfig.md | 13972 +++++++++++++ docs/README.md | 1 + 39 files changed, 109712 insertions(+) create mode 100644 0.14/_custom/endpoint.libsonnet create mode 100644 0.14/_custom/pod_metrics_endpoint.libsonnet create mode 100644 0.14/_custom/relabel_config.libsonnet create mode 100644 0.14/_gen/monitoring/main.libsonnet create mode 100644 0.14/_gen/monitoring/v1/alertmanager.libsonnet create mode 100644 0.14/_gen/monitoring/v1/main.libsonnet create mode 100644 0.14/_gen/monitoring/v1/podMonitor.libsonnet create mode 100644 0.14/_gen/monitoring/v1/probe.libsonnet create mode 100644 0.14/_gen/monitoring/v1/prometheus.libsonnet create mode 100644 0.14/_gen/monitoring/v1/prometheusRule.libsonnet create mode 100644 0.14/_gen/monitoring/v1/serviceMonitor.libsonnet create mode 100644 0.14/_gen/monitoring/v1/thanosRuler.libsonnet create mode 100644 0.14/_gen/monitoring/v1alpha1/alertmanagerConfig.libsonnet create mode 100644 0.14/_gen/monitoring/v1alpha1/main.libsonnet create mode 100644 0.14/_gen/monitoring/v1alpha1/prometheusAgent.libsonnet create mode 100644 0.14/_gen/monitoring/v1alpha1/scrapeConfig.libsonnet create mode 100644 0.14/gen.libsonnet create mode 100644 0.14/main.libsonnet create mode 100644 docs/0.14/README.md create mode 100644 docs/0.14/monitoring/index.md create mode 100644 docs/0.14/monitoring/v1/alertmanager.md create mode 100644 docs/0.14/monitoring/v1/endpoint.md create mode 100644 docs/0.14/monitoring/v1/index.md create mode 100644 docs/0.14/monitoring/v1/podMetricsEndpoint.md create mode 100644 docs/0.14/monitoring/v1/podMonitor.md create mode 100644 docs/0.14/monitoring/v1/probe.md create mode 100644 docs/0.14/monitoring/v1/prometheus.md create mode 100644 docs/0.14/monitoring/v1/prometheusRule.md create mode 100644 docs/0.14/monitoring/v1/relabelConfig.md create mode 100644 docs/0.14/monitoring/v1/serviceMonitor.md create mode 100644 docs/0.14/monitoring/v1/thanosRuler.md create mode 100644 docs/0.14/monitoring/v1alpha1/alertmanagerConfig.md create mode 100644 docs/0.14/monitoring/v1alpha1/endpoint.md create mode 100644 docs/0.14/monitoring/v1alpha1/index.md create mode 100644 docs/0.14/monitoring/v1alpha1/podMetricsEndpoint.md create mode 100644 docs/0.14/monitoring/v1alpha1/prometheusAgent.md create mode 100644 docs/0.14/monitoring/v1alpha1/relabelConfig.md create mode 100644 docs/0.14/monitoring/v1alpha1/scrapeConfig.md diff --git a/0.14/_custom/endpoint.libsonnet b/0.14/_custom/endpoint.libsonnet new file mode 100644 index 0000000..53f4d2d --- /dev/null +++ b/0.14/_custom/endpoint.libsonnet @@ -0,0 +1,252 @@ +local d = import 'doc-util/main.libsonnet'; + +local endpoint = { + '#':: d.pkg(name='endpoint', url='', help='Endpoint is a helper to create endpoint configurations in ServiceMonitors. An endpoint defines a scrapeable endpoint serving Prometheus metrics.'), + + '#authorization':: d.obj(help='Authorization section for this endpoint'), + authorization: { + + '#withType':: d.fn('Set the authentication type. Defaults to Bearer, Basic will cause an error', [d.arg('type', d.T.string)]), + withType(type): { authorization+: { type: type } }, + + '#credentials':: d.obj(help="The secret's key that contains the credentials of the request"), + credentials: { + + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { authorization+: { credentials+: { optional: is_optional } } }, + }, + }, + + '#withPort':: d.fn('Name of the service port this endpoint refers to. Mutually exclusive with withTargetPort.', [d.arg('port', d.T.string)]), + withPort(port): { port: port }, + + '#withTargetPort':: d.fn('Name or number of the target port of the Pod behind the Service, the port must be specified with container port property. Mutually exclusive with withPort.', [d.arg('port', d.T.int)]), + withTargetPort(port): { targetPort: port }, + + '#withPath':: d.fn('HTTP path to scrape for metrics.', [d.arg('path', d.T.string)]), + withPath(path): { path: path }, + + '#withScheme':: d.fn('HTTP scheme to use for scraping.', [d.arg('scheme', d.T.string)]), + withScheme(scheme): { scheme: scheme }, + + '#withParams':: d.fn('Optional HTTP URL parameters.', [d.arg('params', d.T.object)]), + withParams(params): { params: params }, + + '#withInterval':: d.fn('Interval at which metrics should be scraped.', [d.arg('interval', d.T.string)]), + withInterval(interval): { interval: interval }, + + '#withScrapeTimeout':: d.fn('Timeout after which the scrape is ended.', [d.arg('timeout', d.T.string)]), + withScrapeTimeout(timeout): { scrapeTimeout: timeout }, + + '#tlsConfig':: d.obj('TLS configuration to use when scraping the endpoint'), + tlsConfig: { + '#ca':: d.obj('Struct containing the CA cert to use for the targets.'), + ca: { + '#secret':: d.obj('Secret containing data to use for the targets. Mutually exclusive with configMap.'), + secret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { ca+: { secret+: { optional: is_optional } } } }, + }, + + '#configMap':: d.obj('ConfigMap containing data to use for the targets. Mutually exclusive with secret.'), + configMap: { + '#withKey':: d.fn('The key to select.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the ConfigMap or its key must be defined.', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { ca+: { configMap+: { optional: is_optional } } } }, + }, + }, + + '#cert':: d.obj('Struct containing the client cert file for the targets.'), + cert: { + '#secret':: d.obj('Secret containing data to use for the targets. Mutually exclusive with configMap.'), + secret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { cert+: { secret+: { optional: is_optional } } } }, + }, + + '#configMap':: d.obj('ConfigMap containing data to use for the targets. Mutually exclusive with secret.'), + configMap: { + '#withKey':: d.fn('The key to select.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the ConfigMap or its key must be defined.', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { cert+: { configMap+: { optional: is_optional } } } }, + }, + }, + + '#keySecret':: d.obj('Secret containing the client key file for the targets.'), + keySecret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { keySecret+: { optional: is_optional } } }, + }, + + '#withServerName':: d.fn('Used to verify the hostname for the targets.', [d.arg('name', d.T.string)]), + withServerName(name): { tlsConfig+: { serverName: name } }, + + '#withInsecureSkipVerify':: d.fn('Disable target certificate validation.', [d.arg('skip_verify', d.T.bool)]), + withInsecureSkipVerify(skip_verify): { tlsConfig+: { insecureSkipVerify: skip_verify } }, + + '#withCaFile':: d.fn('Path to the CA cert in the Prometheus container to use for the targets.', [d.arg('path', d.T.string)]), + withCaFile(path): { tlsConfig+: { caFile: path } }, + + '#withCertFile':: d.fn('Path to the client cert file in the Prometheus container for the targets.', [d.arg('path', d.T.string)]), + withCertFile(path): { tlsConfig+: { certFile: path } }, + + '#withKeyFile':: d.fn('Path to the client key file in the Prometheus container for the targets.', [d.arg('path', d.T.string)]), + withKeyFile(path): { tlsConfig+: { keyFile: path } }, + }, + + '#withBearerTokenFile':: d.fn('File to read bearer token for scraping targets.', [d.arg('path', d.T.string)]), + withBearerTokenFile(path): { bearerTokenFile: path }, + + '#bearerTokenSecret':: d.obj('Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator.'), + bearerTokenSecret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { bearerTokenSecret+: { key: key } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { bearerTokenSecret+: { name: name } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { bearerTokenSecret+: { optional: is_optional } }, + }, + + '#withHonorLabels':: d.fn('HonorLabels chooses the metric’s labels on collisions with target labels.', [d.arg('honor_labels', d.T.bool)]), + withHonorLabels(honor_labels): { honorLabels: honor_labels }, + + '#withHonorTimestamps':: d.fn('HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.', [d.arg('honor_timestamps', d.T.bool)]), + withHonorTimestamps(honor_timestamps): { honorTimestamps: honor_timestamps }, + + '#basicAuth':: d.obj('BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints'), + basicAuth: { + '#username':: d.obj('The secret in the service monitor namespace that contains the username for authentication.'), + username: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { basicAuth+: { username+: { optional: is_optional } } }, + }, + + '#password':: d.obj('The secret in the service monitor namespace that contains the password for authentication.'), + password: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { basicAuth+: { password+: { optional: is_optional } } }, + }, + }, + + '#oauth2':: d.obj('OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.'), + oauth2: { + '#clientId':: d.obj('The secret or configmap containing the OAuth2 client id.'), + clientId: { + '#secret':: d.obj('Secret containing data to use for the targets. Mutually exclusive with configMap.'), + secret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { oauth2+: { clientId+: { secret+: { optional: is_optional } } } }, + }, + + '#configMap':: d.obj('ConfigMap containing data to use for the targets. Mutually exclusive with secret.'), + configMap: { + '#withKey':: d.fn('The key to select.', [d.arg('key', d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the ConfigMap or its key must be defined.', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { oauth2+: { clientId+: { configMap+: { optional: is_optional } } } }, + }, + }, + + '#clientSecret':: d.obj('The secret containing the OAuth2 client secret.'), + clientSecret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { oauth2+: { clientSecret+: { optional: is_optional } } }, + }, + + '#withTokenUrl':: d.fn('The URL to fetch the token from.', [d.arg('url', d.T.string)]), + withTokenUrl(url): { oauth2+: { tokenUrl: url } }, + + '#withScopes':: d.fn('OAuth2 scopes used for the token request.', [d.arg('scopes', d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: scopes } }, + + '#withEndpointParams':: d.fn('Parameters to append to the token URL', [d.arg('params', d.T.object)]), + withEndpointParams(params): { oauth2+: { endpointParams: params } }, + }, + + '#withMetricRelabelings':: d.fn('MetricRelabelConfigs to apply to samples before ingestion.', [d.arg('relabelings', d.T.array)]), + withMetricRelabelings(relabelings): { metricRelabelings: relabelings }, + + '#withRelabelings':: d.fn('RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config', [d.arg('relabelings', d.T.array)]), + withRelabelings(relabelings): { relabelings: relabelings }, + + '#withProxyUrl':: d.fn('ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.', [d.arg('url', d.T.string)]), + withProxyUrl(url): { proxyUrl: url }, + + '#mixin': 'ignore', + mixin: self, +}; + +{ + monitoring+:: { + v1+: { + endpoint: endpoint, + }, + v1alpha1+: { + endpoint: endpoint, + }, + }, +} diff --git a/0.14/_custom/pod_metrics_endpoint.libsonnet b/0.14/_custom/pod_metrics_endpoint.libsonnet new file mode 100644 index 0000000..c23305b --- /dev/null +++ b/0.14/_custom/pod_metrics_endpoint.libsonnet @@ -0,0 +1,243 @@ +local d = import 'doc-util/main.libsonnet'; + +local podMetricsEndpoint = { + '#':: d.pkg(name='podMetricsEndpoint', url='', help='PodMetricsEndpoint defines a scrapeable endpoint of a Kubernetes Pod serving Prometheus metrics.'), + + '#authorization':: d.obj(help='Authorization section for this endpoint'), + authorization: { + + '#withType':: d.fn('Set the authentication type. Defaults to Bearer, Basic will cause an error', [d.arg('type', d.T.string)]), + withType(type): { authorization+: { type: type } }, + + '#credentials':: d.obj(help="The secret's key that contains the credentials of the request"), + credentials: { + + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { authorization+: { credentials+: { optional: is_optional } } }, + }, + }, + + '#withPort':: d.fn('Name of the pod port this endpoint refers to. Mutually exclusive with targetPort.', [d.arg('port', d.T.string)]), + withPort(port): { port: port }, + + '#withTargetPort':: d.fn('Deprecated: Use ‘port’ instead.', [d.arg('port', d.T.int)]), + withTargetPort(port): { targetPort: port }, + + '#withPath':: d.fn('HTTP path to scrape for metrics.', [d.arg('path', d.T.string)]), + withPath(path): { path: path }, + + '#withScheme':: d.fn('HTTP scheme to use for scraping.', [d.arg('scheme', d.T.string)]), + withScheme(scheme): { scheme: scheme }, + + '#withParams':: d.fn('Optional HTTP URL parameters.', [d.arg('params', d.T.object)]), + withParams(params): { params: params }, + + '#withInterval':: d.fn('Interval at which metrics should be scraped.', [d.arg('interval', d.T.string)]), + withInterval(interval): { interval: interval }, + + '#withScrapeTimeout':: d.fn('Timeout after which the scrape is ended.', [d.arg('timeout', d.T.string)]), + withScrapeTimeout(timeout): { scrapeTimeout: timeout }, + + '#tlsConfig':: d.obj('TLS configuration to use when scraping the endpoint'), + tlsConfig: { + '#ca':: d.obj('Struct containing the CA cert to use for the targets.'), + ca: { + '#secret':: d.obj('Secret containing data to use for the targets. Mutually exclusive with configMap.'), + secret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { ca+: { secret+: { optional: is_optional } } } }, + }, + + '#configMap':: d.obj('ConfigMap containing data to use for the targets. Mutually exclusive with secret.'), + configMap: { + '#withKey':: d.fn('The key to select.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the ConfigMap or its key must be defined.', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { ca+: { configMap+: { optional: is_optional } } } }, + }, + }, + + '#cert':: d.obj('Struct containing the client cert file for the targets.'), + cert: { + '#secret':: d.obj('Secret containing data to use for the targets. Mutually exclusive with configMap.'), + secret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { cert+: { secret+: { optional: is_optional } } } }, + }, + + '#configMap':: d.obj('ConfigMap containing data to use for the targets. Mutually exclusive with secret.'), + configMap: { + '#withKey':: d.fn('The key to select.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the ConfigMap or its key must be defined.', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { cert+: { configMap+: { optional: is_optional } } } }, + }, + }, + + '#keySecret':: d.obj('Secret containing the client key file for the targets.'), + keySecret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { tlsConfig+: { keySecret+: { optional: is_optional } } }, + }, + + '#withServerName':: d.fn('Used to verify the hostname for the targets.', [d.arg('name', d.T.string)]), + withServerName(name): { tlsConfig+: { serverName: name } }, + + '#withInsecureSkipVerify':: d.fn('Disable target certificate validation.', [d.arg('skip_verify', d.T.bool)]), + withInsecureSkipVerify(skip_verify): { tlsConfig+: { insecureSkipVerify: skip_verify } }, + }, + + '#withBearerTokenFile':: d.fn('File to read bearer token for scraping targets.', [d.arg('path', d.T.string)]), + withBearerTokenFile(path): { bearerTokenFile: path }, + + '#bearerTokenSecret':: d.obj('Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator.'), + bearerTokenSecret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { bearerTokenSecret+: { key: key } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { bearerTokenSecret+: { name: name } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { bearerTokenSecret+: { optional: is_optional } }, + }, + + '#withHonorLabels':: d.fn('HonorLabels chooses the metric’s labels on collisions with target labels.', [d.arg('honor_labels', d.T.bool)]), + withHonorLabels(honor_labels): { honorLabels: honor_labels }, + + '#withHonorTimestamps':: d.fn('HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.', [d.arg('honor_timestamps', d.T.bool)]), + withHonorTimestamps(honor_timestamps): { honorTimestamps: honor_timestamps }, + + '#basicAuth':: d.obj('BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints'), + basicAuth: { + '#username':: d.obj('The secret in the service monitor namespace that contains the username for authentication.'), + username: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { basicAuth+: { username+: { optional: is_optional } } }, + }, + + '#password':: d.obj('The secret in the service monitor namespace that contains the password for authentication.'), + password: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { basicAuth+: { password+: { optional: is_optional } } }, + }, + }, + + '#oauth2':: d.obj('OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.'), + oauth2: { + '#clientId':: d.obj('The secret or configmap containing the OAuth2 client id.'), + clientId: { + '#secret':: d.obj('Secret containing data to use for the targets. Mutually exclusive with configMap.'), + secret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { oauth2+: { clientId+: { secret+: { optional: is_optional } } } }, + }, + + '#configMap':: d.obj('ConfigMap containing data to use for the targets. Mutually exclusive with secret.'), + configMap: { + '#withKey':: d.fn('The key to select.', [d.arg('key', d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + + '#withOptional':: d.fn('Specify whether the ConfigMap or its key must be defined.', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { oauth2+: { clientId+: { configMap+: { optional: is_optional } } } }, + }, + }, + + '#clientSecret':: d.obj('The secret containing the OAuth2 client secret.'), + clientSecret: { + '#withKey':: d.fn('The key of the secret to select from. Must be a valid secret key.', [d.arg('key', d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + + '#withName':: d.fn('Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names', [d.arg('name', d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + + '#withOptional':: d.fn('Specify whether the Secret or its key must be defined', [d.arg('is_optional', d.T.bool)]), + withOptional(is_optional): { oauth2+: { clientSecret+: { optional: is_optional } } }, + }, + + '#withTokenUrl':: d.fn('The URL to fetch the token from.', [d.arg('url', d.T.string)]), + withTokenUrl(url): { oauth2+: { tokenUrl: url } }, + + '#withScopes':: d.fn('OAuth2 scopes used for the token request.', [d.arg('scopes', d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: scopes } }, + + '#withEndpointParams':: d.fn('Parameters to append to the token URL', [d.arg('params', d.T.object)]), + withEndpointParams(params): { oauth2+: { endpointParams: params } }, + }, + + '#withMetricRelabelings':: d.fn('MetricRelabelConfigs to apply to samples before ingestion.', [d.arg('relabelings', d.T.array)]), + withMetricRelabelings(relabelings): { metricRelabelings: relabelings }, + + '#withRelabelings':: d.fn('RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config', [d.arg('relabelings', d.T.array)]), + withRelabelings(relabelings): { relabelings: relabelings }, + + '#withProxyUrl':: d.fn('ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint.', [d.arg('url', d.T.string)]), + withProxyUrl(url): { proxyUrl: url }, + + '#mixin': 'ignore', + mixin: self, +}; + +{ + monitoring+:: { + v1+: { + podMetricsEndpoint: podMetricsEndpoint, + }, + v1alpha1+: { + podMetricsEndpoint: podMetricsEndpoint, + }, + }, +} diff --git a/0.14/_custom/relabel_config.libsonnet b/0.14/_custom/relabel_config.libsonnet new file mode 100644 index 0000000..eb4d364 --- /dev/null +++ b/0.14/_custom/relabel_config.libsonnet @@ -0,0 +1,40 @@ +local d = import 'doc-util/main.libsonnet'; + +local relabelConfig = { + '#':: d.pkg(name='relabelConfig', url='', help='RelabelConfig is a help to build RelabelConfig objects for ServiceMonitors and PodMonitors'), + + '#withSourceLabels':: d.fn('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.', [d.arg('labels', d.T.array)]), + withSourceLabels(labels): { sourceLabels: labels }, + + '#withSeparator':: d.fn('Separator placed between concatenated source label values. default is ‘;’.', [d.arg('separator', d.T.string)]), + withSeparator(separator): { separator: separator }, + + '#withTargetLabel':: d.fn('Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available.', [d.arg('separator', d.T.string)]), + withTargetLabel(label): { targetLabel: label }, + + '#withRegex':: d.fn('Regular expression against which the extracted value is matched. Default is ‘(.*)’', [d.arg('separator', d.T.string)]), + withRegex(regex): { regex: regex }, + + '#withModulus':: d.fn('Modulus to take of the hash of the source label values.', [d.arg('modulus', d.T.number)]), + withModulus(modulus): { modulus: modulus }, + + '#withReplacement':: d.fn('Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is ‘$1’', [d.arg('separator', d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + + '#withAction':: d.fn('Action to perform based on regex matching. Default is ‘replace’', [d.arg('separator', d.T.string)]), + withAction(action): { action: action }, + + '#mixin': 'ignore', + mixin: self, +}; + +{ + monitoring+:: { + v1+: { + relabelConfig: relabelConfig, + }, + v1alpha1+: { + relabelConfig: relabelConfig, + }, + }, +} diff --git a/0.14/_gen/monitoring/main.libsonnet b/0.14/_gen/monitoring/main.libsonnet new file mode 100644 index 0000000..a25fafd --- /dev/null +++ b/0.14/_gen/monitoring/main.libsonnet @@ -0,0 +1,6 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='monitoring', url='', help=''), + v1: (import 'v1/main.libsonnet'), + v1alpha1: (import 'v1alpha1/main.libsonnet'), +} diff --git a/0.14/_gen/monitoring/v1/alertmanager.libsonnet b/0.14/_gen/monitoring/v1/alertmanager.libsonnet new file mode 100644 index 0000000..eca4aa3 --- /dev/null +++ b/0.14/_gen/monitoring/v1/alertmanager.libsonnet @@ -0,0 +1,2988 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='alertmanager', url='', help='"The `Alertmanager` custom resource definition (CRD) defines a desired [Alertmanager](https://prometheus.io/docs/alerting) setup to run in a Kubernetes cluster. It allows to specify many options such as the number of replicas, persistent storage and many more.\\n\\n\\nFor each `Alertmanager` resource, the Operator deploys a `StatefulSet` in the same namespace. When there are two or more configured replicas, the Operator runs the Alertmanager instances in high-availability mode.\\n\\n\\nThe resource defines via label and namespace selectors which `AlertmanagerConfig` objects should be associated to the deployed Alertmanager instances."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Alertmanager', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1', + kind: 'Alertmanager', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Specification of the desired behavior of the Alertmanager cluster. More info:\\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"'), + spec: { + '#affinity':: d.obj(help="\"If specified, the pod's scheduling constraints.\""), + affinity: { + '#nodeAffinity':: d.obj(help='"Describes node affinity scheduling rules for the pod."'), + nodeAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#preference':: d.obj(help='"A node selector term, associated with the corresponding weight."'), + preference: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { preference+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { preference+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { preference+: { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { preference+: { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + }, + '#withWeight':: d.fn(help='"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to an update), the system\\nmay or may not try to eventually evict the pod from its node."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#nodeSelectorTerms':: d.obj(help='"Required. A list of node selector terms. The terms are ORed."'), + nodeSelectorTerms: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + }, + '#withNodeSelectorTerms':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTerms(nodeSelectorTerms): { spec+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } }, + '#withNodeSelectorTermsMixin':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTermsMixin(nodeSelectorTerms): { spec+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms+: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + '#podAffinity':: d.obj(help='"Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."'), + podAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm,\\nin the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + '#podAntiAffinity':: d.obj(help='"Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))."'), + podAntiAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm,\\nin the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + }, + '#alertmanagerConfigMatcherStrategy':: d.obj(help='"AlertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects\\nprocess incoming alerts."'), + alertmanagerConfigMatcherStrategy: { + '#withType':: d.fn(help='"AlertmanagerConfigMatcherStrategyType defines the strategy used by\\nAlertmanagerConfig objects to match alerts in the routes and inhibition\\nrules.\\n\\n\\nThe default value is `OnNamespace`."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { alertmanagerConfigMatcherStrategy+: { type: type } } }, + }, + '#alertmanagerConfigNamespaceSelector':: d.obj(help='"Namespaces to be selected for AlertmanagerConfig discovery. If nil, only\\ncheck own namespace."'), + alertmanagerConfigNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { alertmanagerConfigNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { alertmanagerConfigNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { alertmanagerConfigNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { alertmanagerConfigNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#alertmanagerConfigSelector':: d.obj(help='"AlertmanagerConfigs to be selected for to merge and configure Alertmanager with."'), + alertmanagerConfigSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { alertmanagerConfigSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { alertmanagerConfigSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { alertmanagerConfigSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { alertmanagerConfigSelector+: { matchLabels+: matchLabels } } }, + }, + '#alertmanagerConfiguration':: d.obj(help='"alertmanagerConfiguration specifies the configuration of Alertmanager.\\n\\n\\nIf defined, it takes precedence over the `configSecret` field.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."'), + alertmanagerConfiguration: { + '#global':: d.obj(help='"Defines the global parameters of the Alertmanager configuration."'), + global: { + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { authorization+: { credentials+: { key: key } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { authorization+: { credentials+: { name: name } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { authorization+: { credentials+: { optional: optional } } } } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { authorization+: { type: type } } } } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { basicAuth+: { password+: { key: key } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { basicAuth+: { password+: { name: name } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { basicAuth+: { password+: { optional: optional } } } } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { basicAuth+: { username+: { key: key } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { basicAuth+: { username+: { name: name } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { basicAuth+: { username+: { optional: optional } } } } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the Alertmanager\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { bearerTokenSecret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { bearerTokenSecret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { bearerTokenSecret+: { optional: optional } } } } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { endpointParams: endpointParams } } } } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } } } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { noProxy: noProxy } } } } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } } } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } } } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } } } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } } } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } } } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } } } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { minVersion: minVersion } } } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { tlsConfig+: { serverName: serverName } } } } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { followRedirects: followRedirects } } } } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { spec+: { alertmanagerConfiguration+: { global+: { httpConfig+: { proxyURL: proxyURL } } } } }, + }, + '#opsGenieApiKey':: d.obj(help='"The default OpsGenie API Key."'), + opsGenieApiKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { opsGenieApiKey+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { opsGenieApiKey+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { opsGenieApiKey+: { optional: optional } } } } }, + }, + '#opsGenieApiUrl':: d.obj(help='"The default OpsGenie API URL."'), + opsGenieApiUrl: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { opsGenieApiUrl+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { opsGenieApiUrl+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { opsGenieApiUrl+: { optional: optional } } } } }, + }, + '#slackApiUrl':: d.obj(help='"The default Slack API URL."'), + slackApiUrl: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { slackApiUrl+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { slackApiUrl+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { slackApiUrl+: { optional: optional } } } } }, + }, + '#smtp':: d.obj(help='"Configures global SMTP parameters."'), + smtp: { + '#authPassword':: d.obj(help='"SMTP Auth using LOGIN and PLAIN."'), + authPassword: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { authPassword+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { authPassword+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { authPassword+: { optional: optional } } } } } }, + }, + '#authSecret':: d.obj(help='"SMTP Auth using CRAM-MD5."'), + authSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { authSecret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { authSecret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { authSecret+: { optional: optional } } } } } }, + }, + '#smartHost':: d.obj(help='"The default SMTP smarthost used for sending emails."'), + smartHost: { + '#withHost':: d.fn(help="\"Defines the host's address, it can be a DNS name or a literal IP address.\"", args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { smartHost+: { host: host } } } } } }, + '#withPort':: d.fn(help="\"Defines the host's port, it can be a literal port number or a port name.\"", args=[d.arg(name='port', type=d.T.string)]), + withPort(port): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { smartHost+: { port: port } } } } } }, + }, + '#withAuthIdentity':: d.fn(help='"SMTP Auth using PLAIN"', args=[d.arg(name='authIdentity', type=d.T.string)]), + withAuthIdentity(authIdentity): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { authIdentity: authIdentity } } } } }, + '#withAuthUsername':: d.fn(help="\"SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.\"", args=[d.arg(name='authUsername', type=d.T.string)]), + withAuthUsername(authUsername): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { authUsername: authUsername } } } } }, + '#withFrom':: d.fn(help='"The default SMTP From header field."', args=[d.arg(name='from', type=d.T.string)]), + withFrom(from): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { from: from } } } } }, + '#withHello':: d.fn(help='"The default hostname to identify to the SMTP server."', args=[d.arg(name='hello', type=d.T.string)]), + withHello(hello): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { hello: hello } } } } }, + '#withRequireTLS':: d.fn(help='"The default SMTP TLS requirement.\\nNote that Go does not support unencrypted connections to remote SMTP endpoints."', args=[d.arg(name='requireTLS', type=d.T.boolean)]), + withRequireTLS(requireTLS): { spec+: { alertmanagerConfiguration+: { global+: { smtp+: { requireTLS: requireTLS } } } } }, + }, + '#withPagerdutyUrl':: d.fn(help='"The default Pagerduty URL."', args=[d.arg(name='pagerdutyUrl', type=d.T.string)]), + withPagerdutyUrl(pagerdutyUrl): { spec+: { alertmanagerConfiguration+: { global+: { pagerdutyUrl: pagerdutyUrl } } } }, + '#withResolveTimeout':: d.fn(help='"ResolveTimeout is the default value used by alertmanager if the alert does\\nnot include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated.\\nThis has no impact on alerts from Prometheus, as they always include EndsAt."', args=[d.arg(name='resolveTimeout', type=d.T.string)]), + withResolveTimeout(resolveTimeout): { spec+: { alertmanagerConfiguration+: { global+: { resolveTimeout: resolveTimeout } } } }, + }, + '#templates':: d.obj(help='"Custom notification templates."'), + templates: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { configMap+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { secret+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secret+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + }, + }, + '#withName':: d.fn(help='"The name of the AlertmanagerConfig resource which is used to generate the Alertmanager configuration.\\nIt must be defined in the same namespace as the Alertmanager object.\\nThe operator will not enforce a `namespace` label for routes and inhibition rules."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagerConfiguration+: { name: name } } }, + '#withTemplates':: d.fn(help='"Custom notification templates."', args=[d.arg(name='templates', type=d.T.array)]), + withTemplates(templates): { spec+: { alertmanagerConfiguration+: { templates: if std.isArray(v=templates) then templates else [templates] } } }, + '#withTemplatesMixin':: d.fn(help='"Custom notification templates."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='templates', type=d.T.array)]), + withTemplatesMixin(templates): { spec+: { alertmanagerConfiguration+: { templates+: if std.isArray(v=templates) then templates else [templates] } } }, + }, + '#containers':: d.obj(help='"Containers allows injecting additional containers. This is meant to\\nallow adding an authentication proxy to an Alertmanager pod.\\nContainers described here modify an operator generated container if they\\nshare the same name and modifications are done via a strategic merge\\npatch. The current container names are: `alertmanager` and\\n`config-reloader`. Overriding containers is entirely outside the scope\\nof what the maintainers will support and by doing so, you accept that\\nthis behaviour may break at any time without notice."'), + containers: { + '#env':: d.obj(help='"List of environment variables to set in the container.\\nCannot be updated."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded\\nusing the previously defined environment variables in the container and\\nany service environment variables. If a variable cannot be resolved,\\nthe reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\\n\\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\".\\nEscaped references will never be expanded, regardless of whether the variable\\nexists or not.\\nDefaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#envFrom':: d.obj(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."'), + envFrom: { + '#configMapRef':: d.obj(help='"The ConfigMap to select from"'), + configMapRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMapRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMapRef+: { optional: optional } }, + }, + '#secretRef':: d.obj(help='"The Secret to select from"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretRef+: { optional: optional } }, + }, + '#withPrefix':: d.fn(help='"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { prefix: prefix }, + }, + '#lifecycle':: d.obj(help='"Actions that the management system should take in response to container lifecycle events.\\nCannot be updated."'), + lifecycle: { + '#postStart':: d.obj(help='"PostStart is called immediately after a container is created. If the handler fails,\\nthe container is terminated and restarted according to its restart policy.\\nOther management of the container blocks until the hook completes.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"'), + postStart: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { postStart+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { postStart+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { postStart+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { postStart+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { postStart+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { tcpSocket+: { port: port } } } }, + }, + }, + '#preStop':: d.obj(help="\"PreStop is called immediately before a container is terminated due to an\\nAPI request or management event such as liveness/startup probe failure,\\npreemption, resource contention, etc. The handler is not called if the\\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\\nPreStop hook is executed. Regardless of the outcome of the handler, the\\ncontainer will eventually terminate within the Pod's termination grace\\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\\nor until the termination grace period is reached.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\""), + preStop: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { preStop+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { preStop+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { preStop+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { preStop+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { preStop+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { tcpSocket+: { port: port } } } }, + }, + }, + }, + '#livenessProbe':: d.obj(help='"Periodic probe of container liveness.\\nContainer will be restarted if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + livenessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { livenessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { livenessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { livenessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { livenessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { livenessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { livenessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { livenessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { livenessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { livenessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { livenessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { livenessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { livenessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#ports':: d.obj(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."'), + ports: { + '#withContainerPort':: d.fn(help="\"Number of port to expose on the pod's IP address.\\nThis must be a valid port number, 0 \u003c x \u003c 65536.\"", args=[d.arg(name='containerPort', type=d.T.integer)]), + withContainerPort(containerPort): { containerPort: containerPort }, + '#withHostIP':: d.fn(help='"What host IP to bind the external port to."', args=[d.arg(name='hostIP', type=d.T.string)]), + withHostIP(hostIP): { hostIP: hostIP }, + '#withHostPort':: d.fn(help='"Number of port to expose on the host.\\nIf specified, this must be a valid port number, 0 < x < 65536.\\nIf HostNetwork is specified, this must match ContainerPort.\\nMost containers do not need this."', args=[d.arg(name='hostPort', type=d.T.integer)]), + withHostPort(hostPort): { hostPort: hostPort }, + '#withName':: d.fn(help='"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\\nnamed port in a pod must have a unique name. Name for the port that can be\\nreferred to by services."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withProtocol':: d.fn(help='"Protocol for port. Must be UDP, TCP, or SCTP.\\nDefaults to \\"TCP\\"."', args=[d.arg(name='protocol', type=d.T.string)]), + withProtocol(protocol): { protocol: protocol }, + }, + '#readinessProbe':: d.obj(help='"Periodic probe of container service readiness.\\nContainer will be removed from service endpoints if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + readinessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { readinessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { readinessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { readinessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { readinessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { readinessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { readinessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { readinessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { readinessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { readinessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { readinessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { readinessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { readinessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#resizePolicy':: d.obj(help='"Resources resize policy for the container."'), + resizePolicy: { + '#withResourceName':: d.fn(help='"Name of the resource to which this resource resize policy applies.\\nSupported values: cpu, memory."', args=[d.arg(name='resourceName', type=d.T.string)]), + withResourceName(resourceName): { resourceName: resourceName }, + '#withRestartPolicy':: d.fn(help='"Restart policy to apply when specified resource is resized.\\nIf not specified, it defaults to NotRequired."', args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + }, + '#resources':: d.obj(help='"Compute Resources required by this container.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { resources+: { limits: limits } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { resources+: { limits+: limits } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { resources+: { requests: requests } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { resources+: { requests+: requests } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with.\\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#appArmorProfile':: d.obj(help="\"appArmorProfile is the AppArmor options to use by this container. If set, this profile\\noverrides the pod's appArmorProfile.\\nNote that this field cannot be set when spec.os.name is windows.\""), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { appArmorProfile+: { type: type } } }, + }, + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers.\\nDefaults to the default set of capabilities granted by the container runtime.\\nNote that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { securityContext+: { seLinuxOptions+: { level: level } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { securityContext+: { seLinuxOptions+: { role: role } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seLinuxOptions+: { type: type } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { securityContext+: { seLinuxOptions+: { user: user } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are\\nprovided at both the pod & container level, the container options\\noverride the pod options.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seccompProfile+: { type: type } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers.\\nIf unspecified, the options from the PodSecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more\\nprivileges than its parent process. This bool directly controls if\\nthe no_new_privs flag will be set on the container process.\\nAllowPrivilegeEscalation is true always when the container is:\\n1) run as Privileged\\n2) has CAP_SYS_ADMIN\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode.\\nProcesses in privileged containers are essentially equivalent to root on the host.\\nDefaults to false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { securityContext+: { privileged: privileged } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers.\\nThe default is DefaultProcMount which uses the container runtime defaults for\\nreadonly paths and masked paths.\\nThis requires the ProcMountType feature flag to be enabled.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { securityContext+: { procMount: procMount } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem.\\nDefault is false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { securityContext+: { runAsGroup: runAsGroup } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { securityContext+: { runAsNonRoot: runAsNonRoot } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { securityContext+: { runAsUser: runAsUser } }, + }, + '#startupProbe':: d.obj(help="\"StartupProbe indicates that the Pod has successfully initialized.\\nIf specified, no other probes are executed until this completes successfully.\\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\\nThis cannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\""), + startupProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { startupProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { startupProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { startupProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { startupProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { startupProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { startupProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { startupProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { startupProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { startupProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { startupProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { startupProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { startupProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#volumeDevices':: d.obj(help='"volumeDevices is the list of block devices to be used by the container."'), + volumeDevices: { + '#withDevicePath':: d.fn(help='"devicePath is the path inside of the container that the device will be mapped to."', args=[d.arg(name='devicePath', type=d.T.string)]), + withDevicePath(devicePath): { devicePath: devicePath }, + '#withName':: d.fn(help='"name must match the name of a persistentVolumeClaim in the pod"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#volumeMounts':: d.obj(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withArgs':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='args', type=d.T.array)]), + withArgs(args): { args: if std.isArray(v=args) then args else [args] }, + '#withArgsMixin':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='args', type=d.T.array)]), + withArgsMixin(args): { args+: if std.isArray(v=args) then args else [args] }, + '#withCommand':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { command: if std.isArray(v=command) then command else [command] }, + '#withCommandMixin':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { command+: if std.isArray(v=command) then command else [command] }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { env: if std.isArray(v=env) then env else [env] }, + '#withEnvFrom':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFrom(envFrom): { envFrom: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvFromMixin':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFromMixin(envFrom): { envFrom+: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { env+: if std.isArray(v=env) then env else [env] }, + '#withImage':: d.fn(help='"Container image name.\\nMore info: https://kubernetes.io/docs/concepts/containers/images\\nThis field is optional to allow higher level config management to default or override\\ncontainer images in workload controllers like Deployments and StatefulSets."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { image: image }, + '#withImagePullPolicy':: d.fn(help='"Image pull policy.\\nOne of Always, Never, IfNotPresent.\\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images"', args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { imagePullPolicy: imagePullPolicy }, + '#withName':: d.fn(help='"Name of the container specified as a DNS_LABEL.\\nEach container in a pod must have a unique name (DNS_LABEL).\\nCannot be updated."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPorts':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."', args=[d.arg(name='ports', type=d.T.array)]), + withPorts(ports): { ports: if std.isArray(v=ports) then ports else [ports] }, + '#withPortsMixin':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ports', type=d.T.array)]), + withPortsMixin(ports): { ports+: if std.isArray(v=ports) then ports else [ports] }, + '#withResizePolicy':: d.fn(help='"Resources resize policy for the container."', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicy(resizePolicy): { resizePolicy: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withResizePolicyMixin':: d.fn(help='"Resources resize policy for the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicyMixin(resizePolicy): { resizePolicy+: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withRestartPolicy':: d.fn(help="\"RestartPolicy defines the restart behavior of individual containers in a pod.\\nThis field may only be set for init containers, and the only allowed value is \\\"Always\\\".\\nFor non-init containers or when this field is not specified,\\nthe restart behavior is defined by the Pod's restart policy and the container type.\\nSetting the RestartPolicy as \\\"Always\\\" for the init container will have the following effect:\\nthis init container will be continually restarted on\\nexit until all regular containers have terminated. Once all regular\\ncontainers have completed, all init containers with restartPolicy \\\"Always\\\"\\nwill be shut down. This lifecycle differs from normal init containers and\\nis often referred to as a \\\"sidecar\\\" container. Although this init\\ncontainer still starts in the init container sequence, it does not wait\\nfor the container to complete before proceeding to the next init\\ncontainer. Instead, the next init container starts immediately after this\\ninit container is started, or after any startupProbe has successfully\\ncompleted.\"", args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + '#withStdin':: d.fn(help='"Whether this container should allocate a buffer for stdin in the container runtime. If this\\nis not set, reads from stdin in the container will always result in EOF.\\nDefault is false."', args=[d.arg(name='stdin', type=d.T.boolean)]), + withStdin(stdin): { stdin: stdin }, + '#withStdinOnce':: d.fn(help='"Whether the container runtime should close the stdin channel after it has been opened by\\na single attach. When stdin is true the stdin stream will remain open across multiple attach\\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\\nat which time stdin is closed and remains closed until the container is restarted. If this\\nflag is false, a container processes that reads from stdin will never receive an EOF.\\nDefault is false"', args=[d.arg(name='stdinOnce', type=d.T.boolean)]), + withStdinOnce(stdinOnce): { stdinOnce: stdinOnce }, + '#withTerminationMessagePath':: d.fn(help="\"Optional: Path at which the file to which the container's termination message\\nwill be written is mounted into the container's filesystem.\\nMessage written is intended to be brief final status, such as an assertion failure message.\\nWill be truncated by the node if greater than 4096 bytes. The total message length across\\nall containers will be limited to 12kb.\\nDefaults to /dev/termination-log.\\nCannot be updated.\"", args=[d.arg(name='terminationMessagePath', type=d.T.string)]), + withTerminationMessagePath(terminationMessagePath): { terminationMessagePath: terminationMessagePath }, + '#withTerminationMessagePolicy':: d.fn(help='"Indicate how the termination message should be populated. File will use the contents of\\nterminationMessagePath to populate the container status message on both success and failure.\\nFallbackToLogsOnError will use the last chunk of container log output if the termination\\nmessage file is empty and the container exited with an error.\\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\\nDefaults to File.\\nCannot be updated."', args=[d.arg(name='terminationMessagePolicy', type=d.T.string)]), + withTerminationMessagePolicy(terminationMessagePolicy): { terminationMessagePolicy: terminationMessagePolicy }, + '#withTty':: d.fn(help="\"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\\nDefault is false.\"", args=[d.arg(name='tty', type=d.T.boolean)]), + withTty(tty): { tty: tty }, + '#withVolumeDevices':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevices(volumeDevices): { volumeDevices: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeDevicesMixin':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevicesMixin(volumeDevices): { volumeDevices+: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeMounts':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withVolumeMountsMixin':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withWorkingDir':: d.fn(help="\"Container's working directory.\\nIf not specified, the container runtime's default will be used, which\\nmight be configured in the container image.\\nCannot be updated.\"", args=[d.arg(name='workingDir', type=d.T.string)]), + withWorkingDir(workingDir): { workingDir: workingDir }, + }, + '#hostAliases':: d.obj(help="\"Pods' hostAliases configuration\""), + hostAliases: { + '#withHostnames':: d.fn(help='"Hostnames for the above IP address."', args=[d.arg(name='hostnames', type=d.T.array)]), + withHostnames(hostnames): { hostnames: if std.isArray(v=hostnames) then hostnames else [hostnames] }, + '#withHostnamesMixin':: d.fn(help='"Hostnames for the above IP address."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='hostnames', type=d.T.array)]), + withHostnamesMixin(hostnames): { hostnames+: if std.isArray(v=hostnames) then hostnames else [hostnames] }, + '#withIp':: d.fn(help='"IP address of the host file entry."', args=[d.arg(name='ip', type=d.T.string)]), + withIp(ip): { ip: ip }, + }, + '#imagePullSecrets':: d.obj(help='"An optional list of references to secrets in the same namespace\\nto use for pulling prometheus and alertmanager images from registries\\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"'), + imagePullSecrets: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#initContainers':: d.obj(help='"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\\nfetch secrets for injection into the Alertmanager configuration from external sources. Any\\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nInitContainers described here modify an operator\\ngenerated init containers if they share the same name and modifications are\\ndone via a strategic merge patch. The current init container name is:\\n`init-config-reloader`. Overriding init containers is entirely outside the\\nscope of what the maintainers will support and by doing so, you accept that\\nthis behaviour may break at any time without notice."'), + initContainers: { + '#env':: d.obj(help='"List of environment variables to set in the container.\\nCannot be updated."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded\\nusing the previously defined environment variables in the container and\\nany service environment variables. If a variable cannot be resolved,\\nthe reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\\n\\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\".\\nEscaped references will never be expanded, regardless of whether the variable\\nexists or not.\\nDefaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#envFrom':: d.obj(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."'), + envFrom: { + '#configMapRef':: d.obj(help='"The ConfigMap to select from"'), + configMapRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMapRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMapRef+: { optional: optional } }, + }, + '#secretRef':: d.obj(help='"The Secret to select from"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretRef+: { optional: optional } }, + }, + '#withPrefix':: d.fn(help='"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { prefix: prefix }, + }, + '#lifecycle':: d.obj(help='"Actions that the management system should take in response to container lifecycle events.\\nCannot be updated."'), + lifecycle: { + '#postStart':: d.obj(help='"PostStart is called immediately after a container is created. If the handler fails,\\nthe container is terminated and restarted according to its restart policy.\\nOther management of the container blocks until the hook completes.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"'), + postStart: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { postStart+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { postStart+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { postStart+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { postStart+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { postStart+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { tcpSocket+: { port: port } } } }, + }, + }, + '#preStop':: d.obj(help="\"PreStop is called immediately before a container is terminated due to an\\nAPI request or management event such as liveness/startup probe failure,\\npreemption, resource contention, etc. The handler is not called if the\\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\\nPreStop hook is executed. Regardless of the outcome of the handler, the\\ncontainer will eventually terminate within the Pod's termination grace\\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\\nor until the termination grace period is reached.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\""), + preStop: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { preStop+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { preStop+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { preStop+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { preStop+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { preStop+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { tcpSocket+: { port: port } } } }, + }, + }, + }, + '#livenessProbe':: d.obj(help='"Periodic probe of container liveness.\\nContainer will be restarted if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + livenessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { livenessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { livenessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { livenessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { livenessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { livenessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { livenessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { livenessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { livenessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { livenessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { livenessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { livenessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { livenessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#ports':: d.obj(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."'), + ports: { + '#withContainerPort':: d.fn(help="\"Number of port to expose on the pod's IP address.\\nThis must be a valid port number, 0 \u003c x \u003c 65536.\"", args=[d.arg(name='containerPort', type=d.T.integer)]), + withContainerPort(containerPort): { containerPort: containerPort }, + '#withHostIP':: d.fn(help='"What host IP to bind the external port to."', args=[d.arg(name='hostIP', type=d.T.string)]), + withHostIP(hostIP): { hostIP: hostIP }, + '#withHostPort':: d.fn(help='"Number of port to expose on the host.\\nIf specified, this must be a valid port number, 0 < x < 65536.\\nIf HostNetwork is specified, this must match ContainerPort.\\nMost containers do not need this."', args=[d.arg(name='hostPort', type=d.T.integer)]), + withHostPort(hostPort): { hostPort: hostPort }, + '#withName':: d.fn(help='"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\\nnamed port in a pod must have a unique name. Name for the port that can be\\nreferred to by services."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withProtocol':: d.fn(help='"Protocol for port. Must be UDP, TCP, or SCTP.\\nDefaults to \\"TCP\\"."', args=[d.arg(name='protocol', type=d.T.string)]), + withProtocol(protocol): { protocol: protocol }, + }, + '#readinessProbe':: d.obj(help='"Periodic probe of container service readiness.\\nContainer will be removed from service endpoints if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + readinessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { readinessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { readinessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { readinessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { readinessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { readinessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { readinessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { readinessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { readinessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { readinessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { readinessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { readinessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { readinessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#resizePolicy':: d.obj(help='"Resources resize policy for the container."'), + resizePolicy: { + '#withResourceName':: d.fn(help='"Name of the resource to which this resource resize policy applies.\\nSupported values: cpu, memory."', args=[d.arg(name='resourceName', type=d.T.string)]), + withResourceName(resourceName): { resourceName: resourceName }, + '#withRestartPolicy':: d.fn(help='"Restart policy to apply when specified resource is resized.\\nIf not specified, it defaults to NotRequired."', args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + }, + '#resources':: d.obj(help='"Compute Resources required by this container.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { resources+: { limits: limits } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { resources+: { limits+: limits } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { resources+: { requests: requests } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { resources+: { requests+: requests } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with.\\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#appArmorProfile':: d.obj(help="\"appArmorProfile is the AppArmor options to use by this container. If set, this profile\\noverrides the pod's appArmorProfile.\\nNote that this field cannot be set when spec.os.name is windows.\""), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { appArmorProfile+: { type: type } } }, + }, + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers.\\nDefaults to the default set of capabilities granted by the container runtime.\\nNote that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { securityContext+: { seLinuxOptions+: { level: level } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { securityContext+: { seLinuxOptions+: { role: role } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seLinuxOptions+: { type: type } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { securityContext+: { seLinuxOptions+: { user: user } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are\\nprovided at both the pod & container level, the container options\\noverride the pod options.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seccompProfile+: { type: type } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers.\\nIf unspecified, the options from the PodSecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more\\nprivileges than its parent process. This bool directly controls if\\nthe no_new_privs flag will be set on the container process.\\nAllowPrivilegeEscalation is true always when the container is:\\n1) run as Privileged\\n2) has CAP_SYS_ADMIN\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode.\\nProcesses in privileged containers are essentially equivalent to root on the host.\\nDefaults to false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { securityContext+: { privileged: privileged } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers.\\nThe default is DefaultProcMount which uses the container runtime defaults for\\nreadonly paths and masked paths.\\nThis requires the ProcMountType feature flag to be enabled.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { securityContext+: { procMount: procMount } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem.\\nDefault is false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { securityContext+: { runAsGroup: runAsGroup } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { securityContext+: { runAsNonRoot: runAsNonRoot } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { securityContext+: { runAsUser: runAsUser } }, + }, + '#startupProbe':: d.obj(help="\"StartupProbe indicates that the Pod has successfully initialized.\\nIf specified, no other probes are executed until this completes successfully.\\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\\nThis cannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\""), + startupProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { startupProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { startupProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { startupProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { startupProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { startupProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { startupProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { startupProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { startupProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { startupProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { startupProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { startupProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { startupProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#volumeDevices':: d.obj(help='"volumeDevices is the list of block devices to be used by the container."'), + volumeDevices: { + '#withDevicePath':: d.fn(help='"devicePath is the path inside of the container that the device will be mapped to."', args=[d.arg(name='devicePath', type=d.T.string)]), + withDevicePath(devicePath): { devicePath: devicePath }, + '#withName':: d.fn(help='"name must match the name of a persistentVolumeClaim in the pod"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#volumeMounts':: d.obj(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withArgs':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='args', type=d.T.array)]), + withArgs(args): { args: if std.isArray(v=args) then args else [args] }, + '#withArgsMixin':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='args', type=d.T.array)]), + withArgsMixin(args): { args+: if std.isArray(v=args) then args else [args] }, + '#withCommand':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { command: if std.isArray(v=command) then command else [command] }, + '#withCommandMixin':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { command+: if std.isArray(v=command) then command else [command] }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { env: if std.isArray(v=env) then env else [env] }, + '#withEnvFrom':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFrom(envFrom): { envFrom: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvFromMixin':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFromMixin(envFrom): { envFrom+: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { env+: if std.isArray(v=env) then env else [env] }, + '#withImage':: d.fn(help='"Container image name.\\nMore info: https://kubernetes.io/docs/concepts/containers/images\\nThis field is optional to allow higher level config management to default or override\\ncontainer images in workload controllers like Deployments and StatefulSets."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { image: image }, + '#withImagePullPolicy':: d.fn(help='"Image pull policy.\\nOne of Always, Never, IfNotPresent.\\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images"', args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { imagePullPolicy: imagePullPolicy }, + '#withName':: d.fn(help='"Name of the container specified as a DNS_LABEL.\\nEach container in a pod must have a unique name (DNS_LABEL).\\nCannot be updated."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPorts':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."', args=[d.arg(name='ports', type=d.T.array)]), + withPorts(ports): { ports: if std.isArray(v=ports) then ports else [ports] }, + '#withPortsMixin':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ports', type=d.T.array)]), + withPortsMixin(ports): { ports+: if std.isArray(v=ports) then ports else [ports] }, + '#withResizePolicy':: d.fn(help='"Resources resize policy for the container."', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicy(resizePolicy): { resizePolicy: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withResizePolicyMixin':: d.fn(help='"Resources resize policy for the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicyMixin(resizePolicy): { resizePolicy+: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withRestartPolicy':: d.fn(help="\"RestartPolicy defines the restart behavior of individual containers in a pod.\\nThis field may only be set for init containers, and the only allowed value is \\\"Always\\\".\\nFor non-init containers or when this field is not specified,\\nthe restart behavior is defined by the Pod's restart policy and the container type.\\nSetting the RestartPolicy as \\\"Always\\\" for the init container will have the following effect:\\nthis init container will be continually restarted on\\nexit until all regular containers have terminated. Once all regular\\ncontainers have completed, all init containers with restartPolicy \\\"Always\\\"\\nwill be shut down. This lifecycle differs from normal init containers and\\nis often referred to as a \\\"sidecar\\\" container. Although this init\\ncontainer still starts in the init container sequence, it does not wait\\nfor the container to complete before proceeding to the next init\\ncontainer. Instead, the next init container starts immediately after this\\ninit container is started, or after any startupProbe has successfully\\ncompleted.\"", args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + '#withStdin':: d.fn(help='"Whether this container should allocate a buffer for stdin in the container runtime. If this\\nis not set, reads from stdin in the container will always result in EOF.\\nDefault is false."', args=[d.arg(name='stdin', type=d.T.boolean)]), + withStdin(stdin): { stdin: stdin }, + '#withStdinOnce':: d.fn(help='"Whether the container runtime should close the stdin channel after it has been opened by\\na single attach. When stdin is true the stdin stream will remain open across multiple attach\\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\\nat which time stdin is closed and remains closed until the container is restarted. If this\\nflag is false, a container processes that reads from stdin will never receive an EOF.\\nDefault is false"', args=[d.arg(name='stdinOnce', type=d.T.boolean)]), + withStdinOnce(stdinOnce): { stdinOnce: stdinOnce }, + '#withTerminationMessagePath':: d.fn(help="\"Optional: Path at which the file to which the container's termination message\\nwill be written is mounted into the container's filesystem.\\nMessage written is intended to be brief final status, such as an assertion failure message.\\nWill be truncated by the node if greater than 4096 bytes. The total message length across\\nall containers will be limited to 12kb.\\nDefaults to /dev/termination-log.\\nCannot be updated.\"", args=[d.arg(name='terminationMessagePath', type=d.T.string)]), + withTerminationMessagePath(terminationMessagePath): { terminationMessagePath: terminationMessagePath }, + '#withTerminationMessagePolicy':: d.fn(help='"Indicate how the termination message should be populated. File will use the contents of\\nterminationMessagePath to populate the container status message on both success and failure.\\nFallbackToLogsOnError will use the last chunk of container log output if the termination\\nmessage file is empty and the container exited with an error.\\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\\nDefaults to File.\\nCannot be updated."', args=[d.arg(name='terminationMessagePolicy', type=d.T.string)]), + withTerminationMessagePolicy(terminationMessagePolicy): { terminationMessagePolicy: terminationMessagePolicy }, + '#withTty':: d.fn(help="\"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\\nDefault is false.\"", args=[d.arg(name='tty', type=d.T.boolean)]), + withTty(tty): { tty: tty }, + '#withVolumeDevices':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevices(volumeDevices): { volumeDevices: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeDevicesMixin':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevicesMixin(volumeDevices): { volumeDevices+: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeMounts':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withVolumeMountsMixin':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withWorkingDir':: d.fn(help="\"Container's working directory.\\nIf not specified, the container runtime's default will be used, which\\nmight be configured in the container image.\\nCannot be updated.\"", args=[d.arg(name='workingDir', type=d.T.string)]), + withWorkingDir(workingDir): { workingDir: workingDir }, + }, + '#podMetadata':: d.obj(help='"PodMetadata configures labels and annotations which are propagated to the Alertmanager pods.\\n\\n\\nThe following items are reserved and cannot be overridden:\\n* \\"alertmanager\\" label, set to the name of the Alertmanager instance.\\n* \\"app.kubernetes.io/instance\\" label, set to the name of the Alertmanager instance.\\n* \\"app.kubernetes.io/managed-by\\" label, set to \\"prometheus-operator\\".\\n* \\"app.kubernetes.io/name\\" label, set to \\"alertmanager\\".\\n* \\"app.kubernetes.io/version\\" label, set to the Alertmanager version.\\n* \\"kubectl.kubernetes.io/default-container\\" annotation, set to \\"alertmanager\\"."'), + podMetadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { podMetadata+: { annotations: annotations } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { podMetadata+: { annotations+: annotations } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { podMetadata+: { labels: labels } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { podMetadata+: { labels+: labels } } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although\\nsome resources may allow a client to request the generation of an appropriate name\\nautomatically. Name is primarily intended for creation idempotence and configuration\\ndefinition.\\nCannot be updated.\\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { podMetadata+: { name: name } } }, + }, + '#resources':: d.obj(help='"Define resources requests and limits for single Pods."'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { spec+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { spec+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { resources+: { limits: limits } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { resources+: { limits+: limits } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { resources+: { requests: requests } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { resources+: { requests+: requests } } }, + }, + '#securityContext':: d.obj(help='"SecurityContext holds pod-level security attributes and common container settings.\\nThis defaults to the default PodSecurityContext."'), + securityContext: { + '#appArmorProfile':: d.obj(help='"appArmorProfile is the AppArmor options to use by the containers in this pod.\\nNote that this field cannot be set when spec.os.name is windows."'), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { appArmorProfile+: { type: type } } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to all containers.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in SecurityContext. If set in\\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\\ntakes precedence for that container.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { spec+: { securityContext+: { seLinuxOptions+: { level: level } } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { spec+: { securityContext+: { seLinuxOptions+: { role: role } } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { seLinuxOptions+: { type: type } } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { spec+: { securityContext+: { seLinuxOptions+: { user: user } } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by the containers in this pod.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { seccompProfile+: { type: type } } } }, + }, + '#sysctls':: d.obj(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."'), + sysctls: { + '#withName':: d.fn(help='"Name of a property to set"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Value of a property to set"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#windowsOptions':: d.obj(help="\"The Windows specific settings applied to all containers.\\nIf unspecified, the options within a container's SecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux.\""), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { spec+: { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { spec+: { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { spec+: { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { spec+: { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } } }, + }, + '#withFsGroup':: d.fn(help="\"A special supplemental group that applies to all containers in a pod.\\nSome volume types allow the Kubelet to change the ownership of that volume\\nto be owned by the pod:\\n\\n\\n1. The owning GID will be the FSGroup\\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\\n3. The permission bits are OR'd with rw-rw----\\n\\n\\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\\nNote that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='fsGroup', type=d.T.integer)]), + withFsGroup(fsGroup): { spec+: { securityContext+: { fsGroup: fsGroup } } }, + '#withFsGroupChangePolicy':: d.fn(help='"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\\nbefore being exposed inside Pod. This field will only apply to\\nvolume types which support fsGroup based ownership(and permissions).\\nIt will have no effect on ephemeral volume types such as: secret, configmaps\\nand emptydir.\\nValid values are \\"OnRootMismatch\\" and \\"Always\\". If not specified, \\"Always\\" is used.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='fsGroupChangePolicy', type=d.T.string)]), + withFsGroupChangePolicy(fsGroupChangePolicy): { spec+: { securityContext+: { fsGroupChangePolicy: fsGroupChangePolicy } } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence\\nfor that container.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { spec+: { securityContext+: { runAsGroup: runAsGroup } } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { spec+: { securityContext+: { runAsNonRoot: runAsNonRoot } } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence\\nfor that container.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { spec+: { securityContext+: { runAsUser: runAsUser } } }, + '#withSupplementalGroups':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition\\nto the container's primary GID, the fsGroup (if specified), and group memberships\\ndefined in the container image for the uid of the container process. If unspecified,\\nno additional groups are added to any container. Note that group memberships\\ndefined in the container image for the uid of the container process are still effective,\\neven if they are not included in this list.\\nNote that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroups(supplementalGroups): { spec+: { securityContext+: { supplementalGroups: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } }, + '#withSupplementalGroupsMixin':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition\\nto the container's primary GID, the fsGroup (if specified), and group memberships\\ndefined in the container image for the uid of the container process. If unspecified,\\nno additional groups are added to any container. Note that group memberships\\ndefined in the container image for the uid of the container process are still effective,\\neven if they are not included in this list.\\nNote that this field cannot be set when spec.os.name is windows.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroupsMixin(supplementalGroups): { spec+: { securityContext+: { supplementalGroups+: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } }, + '#withSysctls':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctls(sysctls): { spec+: { securityContext+: { sysctls: if std.isArray(v=sysctls) then sysctls else [sysctls] } } }, + '#withSysctlsMixin':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctlsMixin(sysctls): { spec+: { securityContext+: { sysctls+: if std.isArray(v=sysctls) then sysctls else [sysctls] } } }, + }, + '#storage':: d.obj(help='"Storage is the definition of how storage will be used by the Alertmanager\\ninstances."'), + storage: { + '#emptyDir':: d.obj(help='"EmptyDirVolumeSource to be used by the StatefulSet.\\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir"'), + emptyDir: { + '#withMedium':: d.fn(help="\"medium represents what type of storage medium should back this directory.\\nThe default is \\\"\\\" which means to use the node's default medium.\\nMust be an empty string (default) or Memory.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\"", args=[d.arg(name='medium', type=d.T.string)]), + withMedium(medium): { spec+: { storage+: { emptyDir+: { medium: medium } } } }, + '#withSizeLimit':: d.fn(help='"sizeLimit is the total amount of local storage required for this EmptyDir volume.\\nThe size limit is also applicable for memory medium.\\nThe maximum usage on memory medium EmptyDir would be the minimum value between\\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\\nThe default is nil which means that the limit is undefined.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"', args=[d.arg(name='sizeLimit', type=d.T.any)]), + withSizeLimit(sizeLimit): { spec+: { storage+: { emptyDir+: { sizeLimit: sizeLimit } } } }, + }, + '#ephemeral':: d.obj(help='"EphemeralVolumeSource to be used by the StatefulSet.\\nThis is a beta field in k8s 1.21 and GA in 1.15.\\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes"'), + ephemeral: { + '#volumeClaimTemplate':: d.obj(help='"Will be used to create a stand-alone PVC to provision the volume.\\nThe pod in which this EphemeralVolumeSource is embedded will be the\\nowner of the PVC, i.e. the PVC will be deleted together with the\\npod. The name of the PVC will be `-` where\\n`` is the name from the `PodSpec.Volumes` array\\nentry. Pod validation will reject the pod if the concatenated name\\nis not valid for a PVC (for example, too long).\\n\\n\\nAn existing PVC with that name that is not owned by the pod\\nwill *not* be used for the pod to avoid using an unrelated\\nvolume by mistake. Starting the pod is then blocked until\\nthe unrelated PVC is removed. If such a pre-created PVC is\\nmeant to be used by the pod, the PVC has to updated with an\\nowner reference to the pod once the pod exists. Normally\\nthis should not be necessary, but it may be useful when\\nmanually reconstructing a broken cluster.\\n\\n\\nThis field is read-only and no changes will be made by Kubernetes\\nto the PVC after it has been created.\\n\\n\\nRequired, must not be nil."'), + volumeClaimTemplate: { + '#spec':: d.obj(help='"The specification for the PersistentVolumeClaim. The entire content is\\ncopied unchanged into the PVC that gets created from this\\ntemplate. The same fields as in a PersistentVolumeClaim\\nare also valid here."'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } } } }, + }, + '#withMetadata':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadata(metadata): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { metadata: metadata } } } } }, + '#withMetadataMixin':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadataMixin(metadata): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { metadata+: metadata } } } } }, + }, + }, + '#volumeClaimTemplate':: d.obj(help='"Defines the PVC spec to be used by the Prometheus StatefulSets.\\nThe easiest way to use a volume that cannot be automatically provisioned\\nis to use a label selector alongside manually created PersistentVolumes."'), + volumeClaimTemplate: { + '#metadata':: d.obj(help='"EmbeddedMetadata contains metadata relevant to an EmbeddedResource."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { annotations: annotations } } } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { annotations+: annotations } } } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { labels: labels } } } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { labels+: labels } } } } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although\\nsome resources may allow a client to request the generation of an appropriate name\\nautomatically. Name is primarily intended for creation idempotence and configuration\\ndefinition.\\nCannot be updated.\\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { name: name } } } } }, + }, + '#spec':: d.obj(help='"Defines the desired characteristics of a volume requested by a pod author.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } } }, + }, + '#withApiVersion':: d.fn(help='"APIVersion defines the versioned schema of this representation of an object.\\nServers should convert recognized schemas to the latest internal value, and\\nmay reject unrecognized values.\\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { storage+: { volumeClaimTemplate+: { apiVersion: apiVersion } } } }, + '#withKind':: d.fn(help='"Kind is a string value representing the REST resource this object represents.\\nServers may infer this from the endpoint the client submits requests to.\\nCannot be updated.\\nIn CamelCase.\\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { kind: kind } } } }, + }, + '#withDisableMountSubPath':: d.fn(help='"Deprecated: subPath usage will be removed in a future release."', args=[d.arg(name='disableMountSubPath', type=d.T.boolean)]), + withDisableMountSubPath(disableMountSubPath): { spec+: { storage+: { disableMountSubPath: disableMountSubPath } } }, + }, + '#tolerations':: d.obj(help="\"If specified, the pod's tolerations.\""), + tolerations: { + '#withEffect':: d.fn(help='"Effect indicates the taint effect to match. Empty means match all taint effects.\\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."', args=[d.arg(name='effect', type=d.T.string)]), + withEffect(effect): { effect: effect }, + '#withKey':: d.fn(help='"Key is the taint key that the toleration applies to. Empty means match all taint keys.\\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Operator represents a key's relationship to the value.\\nValid operators are Exists and Equal. Defaults to Equal.\\nExists is equivalent to wildcard for value, so that a pod can\\ntolerate all taints of a particular category.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withTolerationSeconds':: d.fn(help='"TolerationSeconds represents the period of time the toleration (which must be\\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\\nit is not set, which means tolerate the taint forever (do not evict). Zero and\\nnegative values will be treated as 0 (evict immediately) by the system."', args=[d.arg(name='tolerationSeconds', type=d.T.integer)]), + withTolerationSeconds(tolerationSeconds): { tolerationSeconds: tolerationSeconds }, + '#withValue':: d.fn(help='"Value is the taint value the toleration matches to.\\nIf the operator is Exists, the value should be empty, otherwise just a regular string."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#topologySpreadConstraints':: d.obj(help="\"If specified, the pod's topology spread constraints.\""), + topologySpreadConstraints: { + '#labelSelector':: d.obj(help='"LabelSelector is used to find matching pods.\\nPods that match this label selector are counted to determine the number of pods\\nin their corresponding topology domain."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select the pods over which\\nspreading will be calculated. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are ANDed with labelSelector\\nto select the group of existing pods over which spreading will be calculated\\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\\nMatchLabelKeys cannot be set when LabelSelector isn't set.\\nKeys that don't exist in the incoming pod labels will\\nbe ignored. A null or empty list means only match against labelSelector.\\n\\n\\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select the pods over which\\nspreading will be calculated. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are ANDed with labelSelector\\nto select the group of existing pods over which spreading will be calculated\\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\\nMatchLabelKeys cannot be set when LabelSelector isn't set.\\nKeys that don't exist in the incoming pod labels will\\nbe ignored. A null or empty list means only match against labelSelector.\\n\\n\\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMaxSkew':: d.fn(help="\"MaxSkew describes the degree to which pods may be unevenly distributed.\\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\\nbetween the number of matching pods in the target topology and the global minimum.\\nThe global minimum is the minimum number of matching pods in an eligible domain\\nor zero if the number of eligible domains is less than MinDomains.\\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\\nlabelSelector spread as 2/2/1:\\nIn this case, the global minimum is 1.\\n| zone1 | zone2 | zone3 |\\n| P P | P P | P |\\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\\nviolate MaxSkew(1).\\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\\nto topologies that satisfy it.\\nIt's a required field. Default value is 1 and 0 is not allowed.\"", args=[d.arg(name='maxSkew', type=d.T.integer)]), + withMaxSkew(maxSkew): { maxSkew: maxSkew }, + '#withMinDomains':: d.fn(help="\"MinDomains indicates a minimum number of eligible domains.\\nWhen the number of eligible domains with matching topology keys is less than minDomains,\\nPod Topology Spread treats \\\"global minimum\\\" as 0, and then the calculation of Skew is performed.\\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\\nthis value has no effect on scheduling.\\nAs a result, when the number of eligible domains is less than minDomains,\\nscheduler won't schedule more than maxSkew Pods to those domains.\\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\\nValid values are integers greater than 0.\\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\\n\\n\\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\\nlabelSelector spread as 2/2/2:\\n| zone1 | zone2 | zone3 |\\n| P P | P P | P P |\\nThe number of domains is less than 5(MinDomains), so \\\"global minimum\\\" is treated as 0.\\nIn this situation, new pod with the same labelSelector cannot be scheduled,\\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\\nit will violate MaxSkew.\"", args=[d.arg(name='minDomains', type=d.T.integer)]), + withMinDomains(minDomains): { minDomains: minDomains }, + '#withNodeAffinityPolicy':: d.fn(help="\"NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\\nwhen calculating pod topology spread skew. Options are:\\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\\n\\n\\nIf this value is nil, the behavior is equivalent to the Honor policy.\\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.\"", args=[d.arg(name='nodeAffinityPolicy', type=d.T.string)]), + withNodeAffinityPolicy(nodeAffinityPolicy): { nodeAffinityPolicy: nodeAffinityPolicy }, + '#withNodeTaintsPolicy':: d.fn(help='"NodeTaintsPolicy indicates how we will treat node taints when calculating\\npod topology spread skew. Options are:\\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\\nhas a toleration, are included.\\n- Ignore: node taints are ignored. All nodes are included.\\n\\n\\nIf this value is nil, the behavior is equivalent to the Ignore policy.\\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."', args=[d.arg(name='nodeTaintsPolicy', type=d.T.string)]), + withNodeTaintsPolicy(nodeTaintsPolicy): { nodeTaintsPolicy: nodeTaintsPolicy }, + '#withTopologyKey':: d.fn(help="\"TopologyKey is the key of node labels. Nodes that have a label with this key\\nand identical values are considered to be in the same topology.\\nWe consider each \u003ckey, value\u003e as a \\\"bucket\\\", and try to put balanced number\\nof pods into each bucket.\\nWe define a domain as a particular instance of a topology.\\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\\nnodeAffinityPolicy and nodeTaintsPolicy.\\ne.g. If TopologyKey is \\\"kubernetes.io/hostname\\\", each Node is a domain of that topology.\\nAnd, if TopologyKey is \\\"topology.kubernetes.io/zone\\\", each zone is a domain of that topology.\\nIt's a required field.\"", args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + '#withWhenUnsatisfiable':: d.fn(help="\"WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\\nthe spread constraint.\\n- DoNotSchedule (default) tells the scheduler not to schedule it.\\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\\n but giving higher precedence to topologies that would help reduce the\\n skew.\\nA constraint is considered \\\"Unsatisfiable\\\" for an incoming pod\\nif and only if every possible node assignment for that pod would violate\\n\\\"MaxSkew\\\" on some topology.\\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\\nlabelSelector spread as 3/1/1:\\n| zone1 | zone2 | zone3 |\\n| P P P | P | P |\\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\\nwon't make it *more* imbalanced.\\nIt's a required field.\"", args=[d.arg(name='whenUnsatisfiable', type=d.T.string)]), + withWhenUnsatisfiable(whenUnsatisfiable): { whenUnsatisfiable: whenUnsatisfiable }, + }, + '#volumeMounts':: d.obj(help='"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\\nVolumeMounts specified will be appended to other VolumeMounts in the alertmanager container,\\nthat are generated as a result of StorageSpec objects."'), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#volumes':: d.obj(help='"Volumes allows configuration of additional volumes on the output StatefulSet definition.\\nVolumes specified will be appended to other volumes that are generated as a result of\\nStorageSpec objects."'), + volumes: { + '#awsElasticBlockStore':: d.obj(help="\"awsElasticBlockStore represents an AWS Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\""), + awsElasticBlockStore: { + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { awsElasticBlockStore+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount.\\nIf omitted, the default is to mount by volume name.\\nExamples: For volume /dev/sda1, you specify the partition as \\"1\\".\\nSimilarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty)."', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { awsElasticBlockStore+: { partition: partition } }, + '#withReadOnly':: d.fn(help='"readOnly value true will force the readOnly setting in VolumeMounts.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { awsElasticBlockStore+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { awsElasticBlockStore+: { volumeID: volumeID } }, + }, + '#azureDisk':: d.obj(help='"azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."'), + azureDisk: { + '#withCachingMode':: d.fn(help='"cachingMode is the Host Caching mode: None, Read Only, Read Write."', args=[d.arg(name='cachingMode', type=d.T.string)]), + withCachingMode(cachingMode): { azureDisk+: { cachingMode: cachingMode } }, + '#withDiskName':: d.fn(help='"diskName is the Name of the data disk in the blob storage"', args=[d.arg(name='diskName', type=d.T.string)]), + withDiskName(diskName): { azureDisk+: { diskName: diskName } }, + '#withDiskURI':: d.fn(help='"diskURI is the URI of data disk in the blob storage"', args=[d.arg(name='diskURI', type=d.T.string)]), + withDiskURI(diskURI): { azureDisk+: { diskURI: diskURI } }, + '#withFsType':: d.fn(help='"fsType is Filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { azureDisk+: { fsType: fsType } }, + '#withKind':: d.fn(help='"kind expected values are 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"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { azureDisk+: { kind: kind } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureDisk+: { readOnly: readOnly } }, + }, + '#azureFile':: d.obj(help='"azureFile represents an Azure File Service mount on the host and bind mount to the pod."'), + azureFile: { + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureFile+: { readOnly: readOnly } }, + '#withSecretName':: d.fn(help='"secretName is the name of secret that contains Azure Storage Account Name and Key"', args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { azureFile+: { secretName: secretName } }, + '#withShareName':: d.fn(help='"shareName is the azure share Name"', args=[d.arg(name='shareName', type=d.T.string)]), + withShareName(shareName): { azureFile+: { shareName: shareName } }, + }, + '#cephfs':: d.obj(help="\"cephFS represents a Ceph FS mount on the host that shares a pod's lifetime\""), + cephfs: { + '#secretRef':: d.obj(help='"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cephfs+: { secretRef+: { name: name } } }, + }, + '#withMonitors':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { cephfs+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { cephfs+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPath':: d.fn(help='"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { cephfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts.\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cephfs+: { readOnly: readOnly } }, + '#withSecretFile':: d.fn(help='"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='secretFile', type=d.T.string)]), + withSecretFile(secretFile): { cephfs+: { secretFile: secretFile } }, + '#withUser':: d.fn(help='"user is optional: User is the rados user name, default is admin\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { cephfs+: { user: user } }, + }, + '#cinder':: d.obj(help='"cinder represents a cinder volume attached and mounted on kubelets host machine.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"'), + cinder: { + '#secretRef':: d.obj(help='"secretRef is optional: points to a secret object containing parameters used to connect\\nto OpenStack."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cinder+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { cinder+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cinder+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID used to identify the volume in cinder.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { cinder+: { volumeID: volumeID } }, + }, + '#configMap':: d.obj(help='"configMap represents a configMap that should populate this volume"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is optional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDefaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { configMap+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#csi':: d.obj(help='"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)."'), + csi: { + '#nodePublishSecretRef':: d.obj(help='"nodePublishSecretRef is a reference to the secret object containing\\nsensitive information to pass to the CSI driver to complete the CSI\\nNodePublishVolume and NodeUnpublishVolume calls.\\nThis field is optional, and may be empty if no secret is required. If the\\nsecret object contains more than one secret, all secret references are passed."'), + nodePublishSecretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { csi+: { nodePublishSecretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the CSI driver that handles this volume.\\nConsult with your admin for the correct name as registered in the cluster."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { csi+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType to mount. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\".\\nIf not provided, the empty value is passed to the associated CSI driver\\nwhich will determine the default filesystem to apply."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { csi+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly specifies a read-only configuration for the volume.\\nDefaults to false (read/write)."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { csi+: { readOnly: readOnly } }, + '#withVolumeAttributes':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI\\ndriver. Consult your driver's documentation for supported values.\"", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributes(volumeAttributes): { csi+: { volumeAttributes: volumeAttributes } }, + '#withVolumeAttributesMixin':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI\\ndriver. Consult your driver's documentation for supported values.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributesMixin(volumeAttributes): { csi+: { volumeAttributes+: volumeAttributes } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI represents downward API about the pod that should populate this volume"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of downward API volume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value\\nbetween 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"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 '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"Optional: mode bits to use on created files by default. Must be a\\nOptional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDefaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { downwardAPI+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help='"Items is a list of downward API volume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of downward API volume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#emptyDir':: d.obj(help="\"emptyDir represents a temporary directory that shares a pod's lifetime.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\""), + emptyDir: { + '#withMedium':: d.fn(help="\"medium represents what type of storage medium should back this directory.\\nThe default is \\\"\\\" which means to use the node's default medium.\\nMust be an empty string (default) or Memory.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\"", args=[d.arg(name='medium', type=d.T.string)]), + withMedium(medium): { emptyDir+: { medium: medium } }, + '#withSizeLimit':: d.fn(help='"sizeLimit is the total amount of local storage required for this EmptyDir volume.\\nThe size limit is also applicable for memory medium.\\nThe maximum usage on memory medium EmptyDir would be the minimum value between\\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\\nThe default is nil which means that the limit is undefined.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"', args=[d.arg(name='sizeLimit', type=d.T.any)]), + withSizeLimit(sizeLimit): { emptyDir+: { sizeLimit: sizeLimit } }, + }, + '#ephemeral':: d.obj(help="\"ephemeral represents a volume that is handled by a cluster storage driver.\\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\\nand deleted when the pod is removed.\\n\\n\\nUse this if:\\na) the volume is only needed while the pod runs,\\nb) features of normal volumes like restoring from snapshot or capacity\\n tracking are needed,\\nc) the storage driver is specified through a storage class, and\\nd) the storage driver supports dynamic volume provisioning through\\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\\n information on the connection between this volume type\\n and PersistentVolumeClaim).\\n\\n\\nUse PersistentVolumeClaim or one of the vendor-specific\\nAPIs for volumes that persist for longer than the lifecycle\\nof an individual pod.\\n\\n\\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\\nbe used that way - see the documentation of the driver for\\nmore information.\\n\\n\\nA pod can use both types of ephemeral volumes and\\npersistent volumes at the same time.\""), + ephemeral: { + '#volumeClaimTemplate':: d.obj(help='"Will be used to create a stand-alone PVC to provision the volume.\\nThe pod in which this EphemeralVolumeSource is embedded will be the\\nowner of the PVC, i.e. the PVC will be deleted together with the\\npod. The name of the PVC will be `-` where\\n`` is the name from the `PodSpec.Volumes` array\\nentry. Pod validation will reject the pod if the concatenated name\\nis not valid for a PVC (for example, too long).\\n\\n\\nAn existing PVC with that name that is not owned by the pod\\nwill *not* be used for the pod to avoid using an unrelated\\nvolume by mistake. Starting the pod is then blocked until\\nthe unrelated PVC is removed. If such a pre-created PVC is\\nmeant to be used by the pod, the PVC has to updated with an\\nowner reference to the pod once the pod exists. Normally\\nthis should not be necessary, but it may be useful when\\nmanually reconstructing a broken cluster.\\n\\n\\nThis field is read-only and no changes will be made by Kubernetes\\nto the PVC after it has been created.\\n\\n\\nRequired, must not be nil."'), + volumeClaimTemplate: { + '#spec':: d.obj(help='"The specification for the PersistentVolumeClaim. The entire content is\\ncopied unchanged into the PVC that gets created from this\\ntemplate. The same fields as in a PersistentVolumeClaim\\nare also valid here."'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { ephemeral+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } }, + }, + '#withMetadata':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadata(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata: metadata } } }, + '#withMetadataMixin':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadataMixin(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata+: metadata } } }, + }, + }, + '#fc':: d.obj(help="\"fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\""), + fc: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { fc+: { fsType: fsType } }, + '#withLun':: d.fn(help='"lun is Optional: FC target lun number"', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { fc+: { lun: lun } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { fc+: { readOnly: readOnly } }, + '#withTargetWWNs':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNs(targetWWNs): { fc+: { targetWWNs: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withTargetWWNsMixin':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNsMixin(targetWWNs): { fc+: { targetWWNs+: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withWwids':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids)\\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously."', args=[d.arg(name='wwids', type=d.T.array)]), + withWwids(wwids): { fc+: { wwids: if std.isArray(v=wwids) then wwids else [wwids] } }, + '#withWwidsMixin':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids)\\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='wwids', type=d.T.array)]), + withWwidsMixin(wwids): { fc+: { wwids+: if std.isArray(v=wwids) then wwids else [wwids] } }, + }, + '#flexVolume':: d.obj(help='"flexVolume represents a generic volume resource that is\\nprovisioned/attached using an exec based plugin."'), + flexVolume: { + '#secretRef':: d.obj(help='"secretRef is Optional: secretRef is reference to the secret object containing\\nsensitive information to pass to the plugin scripts. This may be\\nempty if no secret object is specified. If the secret object\\ncontains more than one secret, all secrets are passed to the plugin\\nscripts."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { flexVolume+: { secretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the driver to use for this volume."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { flexVolume+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". The default filesystem depends on FlexVolume script."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { flexVolume+: { fsType: fsType } }, + '#withOptions':: d.fn(help='"options is Optional: this field holds extra command options if any."', args=[d.arg(name='options', type=d.T.object)]), + withOptions(options): { flexVolume+: { options: options } }, + '#withOptionsMixin':: d.fn(help='"options is Optional: this field holds extra command options if any."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='options', type=d.T.object)]), + withOptionsMixin(options): { flexVolume+: { options+: options } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { flexVolume+: { readOnly: readOnly } }, + }, + '#flocker':: d.obj(help="\"flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running\""), + flocker: { + '#withDatasetName':: d.fn(help='"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\\nshould be considered as deprecated"', args=[d.arg(name='datasetName', type=d.T.string)]), + withDatasetName(datasetName): { flocker+: { datasetName: datasetName } }, + '#withDatasetUUID':: d.fn(help='"datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset"', args=[d.arg(name='datasetUUID', type=d.T.string)]), + withDatasetUUID(datasetUUID): { flocker+: { datasetUUID: datasetUUID } }, + }, + '#gcePersistentDisk':: d.obj(help="\"gcePersistentDisk represents a GCE Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\""), + gcePersistentDisk: { + '#withFsType':: d.fn(help='"fsType is filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { gcePersistentDisk+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount.\\nIf omitted, the default is to mount by volume name.\\nExamples: For volume /dev/sda1, you specify the partition as \\"1\\".\\nSimilarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty).\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { gcePersistentDisk+: { partition: partition } }, + '#withPdName':: d.fn(help='"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='pdName', type=d.T.string)]), + withPdName(pdName): { gcePersistentDisk+: { pdName: pdName } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { gcePersistentDisk+: { readOnly: readOnly } }, + }, + '#gitRepo':: d.obj(help="\"gitRepo represents a git repository at a particular revision.\\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\\ninto the Pod's container.\""), + gitRepo: { + '#withDirectory':: d.fn(help="\"directory is the target directory name.\\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\\ngit repository. Otherwise, if specified, the volume will contain the git repository in\\nthe subdirectory with the given name.\"", args=[d.arg(name='directory', type=d.T.string)]), + withDirectory(directory): { gitRepo+: { directory: directory } }, + '#withRepository':: d.fn(help='"repository is the URL"', args=[d.arg(name='repository', type=d.T.string)]), + withRepository(repository): { gitRepo+: { repository: repository } }, + '#withRevision':: d.fn(help='"revision is the commit hash for the specified revision."', args=[d.arg(name='revision', type=d.T.string)]), + withRevision(revision): { gitRepo+: { revision: revision } }, + }, + '#glusterfs':: d.obj(help="\"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md\""), + glusterfs: { + '#withEndpoints':: d.fn(help='"endpoints is the endpoint name that details Glusterfs topology.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='endpoints', type=d.T.string)]), + withEndpoints(endpoints): { glusterfs+: { endpoints: endpoints } }, + '#withPath':: d.fn(help='"path is the Glusterfs volume path.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { glusterfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\\nDefaults to false.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { glusterfs+: { readOnly: readOnly } }, + }, + '#hostPath':: d.obj(help='"hostPath represents a pre-existing file or directory on the host\\nmachine that is directly exposed to the container. This is generally\\nused for system agents or other privileged things that are allowed\\nto see the host machine. Most containers will NOT need this.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\\n---\\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\\nmount host directories as read/write."'), + hostPath: { + '#withPath':: d.fn(help='"path of the directory on the host.\\nIf the path is a symlink, it will follow the link to the real path.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { hostPath+: { path: path } }, + '#withType':: d.fn(help='"type for HostPath Volume\\nDefaults to \\"\\"\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { hostPath+: { type: type } }, + }, + '#iscsi':: d.obj(help="\"iscsi represents an ISCSI Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://examples.k8s.io/volumes/iscsi/README.md\""), + iscsi: { + '#secretRef':: d.obj(help='"secretRef is the CHAP Secret for iSCSI target and initiator authentication"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { iscsi+: { secretRef+: { name: name } } }, + }, + '#withChapAuthDiscovery':: d.fn(help='"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication"', args=[d.arg(name='chapAuthDiscovery', type=d.T.boolean)]), + withChapAuthDiscovery(chapAuthDiscovery): { iscsi+: { chapAuthDiscovery: chapAuthDiscovery } }, + '#withChapAuthSession':: d.fn(help='"chapAuthSession defines whether support iSCSI Session CHAP authentication"', args=[d.arg(name='chapAuthSession', type=d.T.boolean)]), + withChapAuthSession(chapAuthSession): { iscsi+: { chapAuthSession: chapAuthSession } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { iscsi+: { fsType: fsType } }, + '#withInitiatorName':: d.fn(help='"initiatorName is the custom iSCSI Initiator Name.\\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\\n: will be created for the connection."', args=[d.arg(name='initiatorName', type=d.T.string)]), + withInitiatorName(initiatorName): { iscsi+: { initiatorName: initiatorName } }, + '#withIqn':: d.fn(help='"iqn is the target iSCSI Qualified Name."', args=[d.arg(name='iqn', type=d.T.string)]), + withIqn(iqn): { iscsi+: { iqn: iqn } }, + '#withIscsiInterface':: d.fn(help="\"iscsiInterface is the interface Name that uses an iSCSI transport.\\nDefaults to 'default' (tcp).\"", args=[d.arg(name='iscsiInterface', type=d.T.string)]), + withIscsiInterface(iscsiInterface): { iscsi+: { iscsiInterface: iscsiInterface } }, + '#withLun':: d.fn(help='"lun represents iSCSI Target Lun number."', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { iscsi+: { lun: lun } }, + '#withPortals':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='portals', type=d.T.array)]), + withPortals(portals): { iscsi+: { portals: if std.isArray(v=portals) then portals else [portals] } }, + '#withPortalsMixin':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='portals', type=d.T.array)]), + withPortalsMixin(portals): { iscsi+: { portals+: if std.isArray(v=portals) then portals else [portals] } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { iscsi+: { readOnly: readOnly } }, + '#withTargetPortal':: d.fn(help='"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='targetPortal', type=d.T.string)]), + withTargetPortal(targetPortal): { iscsi+: { targetPortal: targetPortal } }, + }, + '#nfs':: d.obj(help="\"nfs represents an NFS mount on the host that shares a pod's lifetime\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\""), + nfs: { + '#withPath':: d.fn(help='"path that is exported by the NFS server.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { nfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the NFS export to be mounted with read-only permissions.\\nDefaults to false.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { nfs+: { readOnly: readOnly } }, + '#withServer':: d.fn(help='"server is the hostname or IP address of the NFS server.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='server', type=d.T.string)]), + withServer(server): { nfs+: { server: server } }, + }, + '#persistentVolumeClaim':: d.obj(help='"persistentVolumeClaimVolumeSource represents a reference to a\\nPersistentVolumeClaim in the same namespace.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"'), + persistentVolumeClaim: { + '#withClaimName':: d.fn(help='"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"', args=[d.arg(name='claimName', type=d.T.string)]), + withClaimName(claimName): { persistentVolumeClaim+: { claimName: claimName } }, + '#withReadOnly':: d.fn(help='"readOnly Will force the ReadOnly setting in VolumeMounts.\\nDefault false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { persistentVolumeClaim+: { readOnly: readOnly } }, + }, + '#photonPersistentDisk':: d.obj(help='"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"'), + photonPersistentDisk: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { photonPersistentDisk+: { fsType: fsType } }, + '#withPdID':: d.fn(help='"pdID is the ID that identifies Photon Controller persistent disk"', args=[d.arg(name='pdID', type=d.T.string)]), + withPdID(pdID): { photonPersistentDisk+: { pdID: pdID } }, + }, + '#portworxVolume':: d.obj(help='"portworxVolume represents a portworx volume attached and mounted on kubelets host machine"'), + portworxVolume: { + '#withFsType':: d.fn(help='"fSType represents the filesystem type to mount\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { portworxVolume+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { portworxVolume+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID uniquely identifies a Portworx volume"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { portworxVolume+: { volumeID: volumeID } }, + }, + '#projected':: d.obj(help='"projected items for all in one resources secrets, configmaps, and downward API"'), + projected: { + '#sources':: d.obj(help='"sources is the list of volume projections"'), + sources: { + '#clusterTrustBundle':: d.obj(help='"ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\\nof ClusterTrustBundle objects in an auto-updating file.\\n\\n\\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\\n\\n\\nClusterTrustBundle objects can either be selected by name, or by the\\ncombination of signer name and a label selector.\\n\\n\\nKubelet performs aggressive normalization of the PEM contents written\\ninto the pod filesystem. Esoteric PEM features such as inter-block\\ncomments and block headers are stripped. Certificates are deduplicated.\\nThe ordering of certificates within the file is arbitrary, and Kubelet\\nmay change the order over time."'), + clusterTrustBundle: { + '#labelSelector':: d.obj(help='"Select all ClusterTrustBundles that match this label selector. Only has\\neffect if signerName is set. Mutually-exclusive with name. If unset,\\ninterpreted as \\"match nothing\\". If set but empty, interpreted as \\"match\\neverything\\"."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { clusterTrustBundle+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { clusterTrustBundle+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { clusterTrustBundle+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { clusterTrustBundle+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#withName':: d.fn(help='"Select a single ClusterTrustBundle by object name. Mutually-exclusive\\nwith signerName and labelSelector."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { clusterTrustBundle+: { name: name } }, + '#withOptional':: d.fn(help="\"If true, don't block pod startup if the referenced ClusterTrustBundle(s)\\naren't available. If using name, then the named ClusterTrustBundle is\\nallowed not to exist. If using signerName, then the combination of\\nsignerName and labelSelector is allowed to match zero\\nClusterTrustBundles.\"", args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { clusterTrustBundle+: { optional: optional } }, + '#withPath':: d.fn(help='"Relative path from the volume root to write the bundle."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { clusterTrustBundle+: { path: path } }, + '#withSignerName':: d.fn(help='"Select all ClusterTrustBundles that match this signer name.\\nMutually-exclusive with name. The contents of all selected\\nClusterTrustBundles will be unified and deduplicated."', args=[d.arg(name='signerName', type=d.T.string)]), + withSignerName(signerName): { clusterTrustBundle+: { signerName: signerName } }, + }, + '#configMap':: d.obj(help='"configMap information about the configMap data to project"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI information about the downwardAPI data to project"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of DownwardAPIVolume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value\\nbetween 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"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 '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help='"Items is a list of DownwardAPIVolume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of DownwardAPIVolume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#secret':: d.obj(help='"secret information about the secret data to project"'), + secret: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secret+: { name: name } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + }, + '#serviceAccountToken':: d.obj(help='"serviceAccountToken is information about the serviceAccountToken data to project"'), + serviceAccountToken: { + '#withAudience':: d.fn(help='"audience is the intended audience of the token. A recipient of a token\\nmust identify itself with an identifier specified in the audience of the\\ntoken, and otherwise should reject the token. The audience defaults to the\\nidentifier of the apiserver."', args=[d.arg(name='audience', type=d.T.string)]), + withAudience(audience): { serviceAccountToken+: { audience: audience } }, + '#withExpirationSeconds':: d.fn(help='"expirationSeconds is the requested duration of validity of the service\\naccount token. As the token approaches expiration, the kubelet volume\\nplugin will proactively rotate the service account token. The kubelet will\\nstart trying to rotate the token if the token is older than 80 percent of\\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\\nand must be at least 10 minutes."', args=[d.arg(name='expirationSeconds', type=d.T.integer)]), + withExpirationSeconds(expirationSeconds): { serviceAccountToken+: { expirationSeconds: expirationSeconds } }, + '#withPath':: d.fn(help='"path is the path relative to the mount point of the file to project the\\ntoken into."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { serviceAccountToken+: { path: path } }, + }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode are the mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { projected+: { defaultMode: defaultMode } }, + '#withSources':: d.fn(help='"sources is the list of volume projections"', args=[d.arg(name='sources', type=d.T.array)]), + withSources(sources): { projected+: { sources: if std.isArray(v=sources) then sources else [sources] } }, + '#withSourcesMixin':: d.fn(help='"sources is the list of volume projections"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sources', type=d.T.array)]), + withSourcesMixin(sources): { projected+: { sources+: if std.isArray(v=sources) then sources else [sources] } }, + }, + '#quobyte':: d.obj(help="\"quobyte represents a Quobyte mount on the host that shares a pod's lifetime\""), + quobyte: { + '#withGroup':: d.fn(help='"group to map volume access to\\nDefault is no group"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { quobyte+: { group: group } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Quobyte volume to be mounted with read-only permissions.\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { quobyte+: { readOnly: readOnly } }, + '#withRegistry':: d.fn(help='"registry represents a single or multiple Quobyte Registry services\\nspecified as a string as host:port pair (multiple entries are separated with commas)\\nwhich acts as the central registry for volumes"', args=[d.arg(name='registry', type=d.T.string)]), + withRegistry(registry): { quobyte+: { registry: registry } }, + '#withTenant':: d.fn(help='"tenant owning the given Quobyte volume in the Backend\\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin"', args=[d.arg(name='tenant', type=d.T.string)]), + withTenant(tenant): { quobyte+: { tenant: tenant } }, + '#withUser':: d.fn(help='"user to map volume access to\\nDefaults to serivceaccount user"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { quobyte+: { user: user } }, + '#withVolume':: d.fn(help='"volume is a string that references an already created Quobyte volume by name."', args=[d.arg(name='volume', type=d.T.string)]), + withVolume(volume): { quobyte+: { volume: volume } }, + }, + '#rbd':: d.obj(help="\"rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md\""), + rbd: { + '#secretRef':: d.obj(help='"secretRef is name of the authentication secret for RBDUser. If provided\\noverrides keyring.\\nDefault is nil.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { rbd+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { rbd+: { fsType: fsType } }, + '#withImage':: d.fn(help='"image is the rados image name.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { rbd+: { image: image } }, + '#withKeyring':: d.fn(help='"keyring is the path to key ring for RBDUser.\\nDefault is /etc/ceph/keyring.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='keyring', type=d.T.string)]), + withKeyring(keyring): { rbd+: { keyring: keyring } }, + '#withMonitors':: d.fn(help='"monitors is a collection of Ceph monitors.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { rbd+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is a collection of Ceph monitors.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { rbd+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPool':: d.fn(help='"pool is the rados pool name.\\nDefault is rbd.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='pool', type=d.T.string)]), + withPool(pool): { rbd+: { pool: pool } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { rbd+: { readOnly: readOnly } }, + '#withUser':: d.fn(help='"user is the rados user name.\\nDefault is admin.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { rbd+: { user: user } }, + }, + '#scaleIO':: d.obj(help='"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."'), + scaleIO: { + '#secretRef':: d.obj(help='"secretRef references to the secret for ScaleIO user and other\\nsensitive information. If this is not provided, Login operation will fail."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { scaleIO+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\".\\nDefault is \\"xfs\\"."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { scaleIO+: { fsType: fsType } }, + '#withGateway':: d.fn(help='"gateway is the host address of the ScaleIO API Gateway."', args=[d.arg(name='gateway', type=d.T.string)]), + withGateway(gateway): { scaleIO+: { gateway: gateway } }, + '#withProtectionDomain':: d.fn(help='"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage."', args=[d.arg(name='protectionDomain', type=d.T.string)]), + withProtectionDomain(protectionDomain): { scaleIO+: { protectionDomain: protectionDomain } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { scaleIO+: { readOnly: readOnly } }, + '#withSslEnabled':: d.fn(help='"sslEnabled Flag enable/disable SSL communication with Gateway, default false"', args=[d.arg(name='sslEnabled', type=d.T.boolean)]), + withSslEnabled(sslEnabled): { scaleIO+: { sslEnabled: sslEnabled } }, + '#withStorageMode':: d.fn(help='"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\\nDefault is ThinProvisioned."', args=[d.arg(name='storageMode', type=d.T.string)]), + withStorageMode(storageMode): { scaleIO+: { storageMode: storageMode } }, + '#withStoragePool':: d.fn(help='"storagePool is the ScaleIO Storage Pool associated with the protection domain."', args=[d.arg(name='storagePool', type=d.T.string)]), + withStoragePool(storagePool): { scaleIO+: { storagePool: storagePool } }, + '#withSystem':: d.fn(help='"system is the name of the storage system as configured in ScaleIO."', args=[d.arg(name='system', type=d.T.string)]), + withSystem(system): { scaleIO+: { system: system } }, + '#withVolumeName':: d.fn(help='"volumeName is the name of a volume already created in the ScaleIO system\\nthat is associated with this volume source."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { scaleIO+: { volumeName: volumeName } }, + }, + '#secret':: d.obj(help='"secret represents a secret that should populate this volume.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret"'), + secret: { + '#items':: d.obj(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is Optional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values\\nfor mode bits. Defaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { secret+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + '#withSecretName':: d.fn(help="\"secretName is the name of the secret in the pod's namespace to use.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\"", args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { secret+: { secretName: secretName } }, + }, + '#storageos':: d.obj(help='"storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."'), + storageos: { + '#secretRef':: d.obj(help='"secretRef specifies the secret to use for obtaining the StorageOS API\\ncredentials. If not specified, default values will be attempted."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storageos+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { storageos+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { storageos+: { readOnly: readOnly } }, + '#withVolumeName':: d.fn(help='"volumeName is the human-readable name of the StorageOS volume. Volume\\nnames are only unique within a namespace."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { storageos+: { volumeName: volumeName } }, + '#withVolumeNamespace':: d.fn(help="\"volumeNamespace specifies the scope of the volume within StorageOS. If no\\nnamespace is specified then the Pod's namespace will be used. This allows the\\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\\nSet VolumeName to any name to override the default behaviour.\\nSet to \\\"default\\\" if you are not using namespaces within StorageOS.\\nNamespaces that do not pre-exist within StorageOS will be created.\"", args=[d.arg(name='volumeNamespace', type=d.T.string)]), + withVolumeNamespace(volumeNamespace): { storageos+: { volumeNamespace: volumeNamespace } }, + }, + '#vsphereVolume':: d.obj(help='"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"'), + vsphereVolume: { + '#withFsType':: d.fn(help='"fsType is filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { vsphereVolume+: { fsType: fsType } }, + '#withStoragePolicyID':: d.fn(help='"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."', args=[d.arg(name='storagePolicyID', type=d.T.string)]), + withStoragePolicyID(storagePolicyID): { vsphereVolume+: { storagePolicyID: storagePolicyID } }, + '#withStoragePolicyName':: d.fn(help='"storagePolicyName is the storage Policy Based Management (SPBM) profile name."', args=[d.arg(name='storagePolicyName', type=d.T.string)]), + withStoragePolicyName(storagePolicyName): { vsphereVolume+: { storagePolicyName: storagePolicyName } }, + '#withVolumePath':: d.fn(help='"volumePath is the path that identifies vSphere volume vmdk"', args=[d.arg(name='volumePath', type=d.T.string)]), + withVolumePath(volumePath): { vsphereVolume+: { volumePath: volumePath } }, + }, + '#withName':: d.fn(help='"name of the volume.\\nMust be a DNS_LABEL and unique within the pod.\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#web':: d.obj(help='"Defines the web command line flags when starting Alertmanager."'), + web: { + '#httpConfig':: d.obj(help='"Defines HTTP parameters for web server."'), + httpConfig: { + '#headers':: d.obj(help='"List of headers that can be added to HTTP responses."'), + headers: { + '#withContentSecurityPolicy':: d.fn(help='"Set the Content-Security-Policy header to HTTP responses.\\nUnset if blank."', args=[d.arg(name='contentSecurityPolicy', type=d.T.string)]), + withContentSecurityPolicy(contentSecurityPolicy): { spec+: { web+: { httpConfig+: { headers+: { contentSecurityPolicy: contentSecurityPolicy } } } } }, + '#withStrictTransportSecurity':: d.fn(help='"Set the Strict-Transport-Security header to HTTP responses.\\nUnset if blank.\\nPlease make sure that you use this with care as this header might force\\nbrowsers to load Prometheus and the other applications hosted on the same\\ndomain and subdomains over HTTPS.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security"', args=[d.arg(name='strictTransportSecurity', type=d.T.string)]), + withStrictTransportSecurity(strictTransportSecurity): { spec+: { web+: { httpConfig+: { headers+: { strictTransportSecurity: strictTransportSecurity } } } } }, + '#withXContentTypeOptions':: d.fn(help='"Set the X-Content-Type-Options header to HTTP responses.\\nUnset if blank. Accepted value is nosniff.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options"', args=[d.arg(name='xContentTypeOptions', type=d.T.string)]), + withXContentTypeOptions(xContentTypeOptions): { spec+: { web+: { httpConfig+: { headers+: { xContentTypeOptions: xContentTypeOptions } } } } }, + '#withXFrameOptions':: d.fn(help='"Set the X-Frame-Options header to HTTP responses.\\nUnset if blank. Accepted values are deny and sameorigin.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options"', args=[d.arg(name='xFrameOptions', type=d.T.string)]), + withXFrameOptions(xFrameOptions): { spec+: { web+: { httpConfig+: { headers+: { xFrameOptions: xFrameOptions } } } } }, + '#withXXSSProtection':: d.fn(help='"Set the X-XSS-Protection header to all responses.\\nUnset if blank.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection"', args=[d.arg(name='xXSSProtection', type=d.T.string)]), + withXXSSProtection(xXSSProtection): { spec+: { web+: { httpConfig+: { headers+: { xXSSProtection: xXSSProtection } } } } }, + }, + '#withHttp2':: d.fn(help='"Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\\nWhenever the value of the field changes, a rolling update will be triggered."', args=[d.arg(name='http2', type=d.T.boolean)]), + withHttp2(http2): { spec+: { web+: { httpConfig+: { http2: http2 } } } }, + }, + '#tlsConfig':: d.obj(help='"Defines the TLS parameters for HTTPS."'), + tlsConfig: { + '#cert':: d.obj(help='"Contains the TLS certificate for the server."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#client_ca':: d.obj(help='"Contains the CA certificate for client certificate authentication to the server."'), + client_ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the TLS key for the server."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withCipherSuites':: d.fn(help='"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\\nGo default cipher suites are used. Available cipher suites are documented\\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"', args=[d.arg(name='cipherSuites', type=d.T.array)]), + withCipherSuites(cipherSuites): { spec+: { web+: { tlsConfig+: { cipherSuites: if std.isArray(v=cipherSuites) then cipherSuites else [cipherSuites] } } } }, + '#withCipherSuitesMixin':: d.fn(help='"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\\nGo default cipher suites are used. Available cipher suites are documented\\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='cipherSuites', type=d.T.array)]), + withCipherSuitesMixin(cipherSuites): { spec+: { web+: { tlsConfig+: { cipherSuites+: if std.isArray(v=cipherSuites) then cipherSuites else [cipherSuites] } } } }, + '#withClientAuthType':: d.fn(help='"Server policy for client authentication. Maps to ClientAuth Policies.\\nFor more detail on clientAuth options:\\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType"', args=[d.arg(name='clientAuthType', type=d.T.string)]), + withClientAuthType(clientAuthType): { spec+: { web+: { tlsConfig+: { clientAuthType: clientAuthType } } } }, + '#withCurvePreferences':: d.fn(help='"Elliptic curves that will be used in an ECDHE handshake, in preference\\norder. Available curves are documented in the go documentation:\\nhttps://golang.org/pkg/crypto/tls/#CurveID"', args=[d.arg(name='curvePreferences', type=d.T.array)]), + withCurvePreferences(curvePreferences): { spec+: { web+: { tlsConfig+: { curvePreferences: if std.isArray(v=curvePreferences) then curvePreferences else [curvePreferences] } } } }, + '#withCurvePreferencesMixin':: d.fn(help='"Elliptic curves that will be used in an ECDHE handshake, in preference\\norder. Available curves are documented in the go documentation:\\nhttps://golang.org/pkg/crypto/tls/#CurveID"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='curvePreferences', type=d.T.array)]), + withCurvePreferencesMixin(curvePreferences): { spec+: { web+: { tlsConfig+: { curvePreferences+: if std.isArray(v=curvePreferences) then curvePreferences else [curvePreferences] } } } }, + '#withMaxVersion':: d.fn(help='"Maximum TLS version that is acceptable. Defaults to TLS13."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { web+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum TLS version that is acceptable. Defaults to TLS12."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { web+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withPreferServerCipherSuites':: d.fn(help="\"Controls whether the server selects the\\nclient's most preferred cipher suite, or the server's most preferred\\ncipher suite. If true then the server's preference, as expressed in\\nthe order of elements in cipherSuites, is used.\"", args=[d.arg(name='preferServerCipherSuites', type=d.T.boolean)]), + withPreferServerCipherSuites(preferServerCipherSuites): { spec+: { web+: { tlsConfig+: { preferServerCipherSuites: preferServerCipherSuites } } } }, + }, + '#withGetConcurrency':: d.fn(help="\"Maximum number of GET requests processed concurrently. This corresponds to the\\nAlertmanager's `--web.get-concurrency` flag.\"", args=[d.arg(name='getConcurrency', type=d.T.integer)]), + withGetConcurrency(getConcurrency): { spec+: { web+: { getConcurrency: getConcurrency } } }, + '#withTimeout':: d.fn(help="\"Timeout for HTTP requests. This corresponds to the Alertmanager's\\n`--web.timeout` flag.\"", args=[d.arg(name='timeout', type=d.T.integer)]), + withTimeout(timeout): { spec+: { web+: { timeout: timeout } } }, + }, + '#withAdditionalPeers':: d.fn(help='"AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster."', args=[d.arg(name='additionalPeers', type=d.T.array)]), + withAdditionalPeers(additionalPeers): { spec+: { additionalPeers: if std.isArray(v=additionalPeers) then additionalPeers else [additionalPeers] } }, + '#withAdditionalPeersMixin':: d.fn(help='"AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='additionalPeers', type=d.T.array)]), + withAdditionalPeersMixin(additionalPeers): { spec+: { additionalPeers+: if std.isArray(v=additionalPeers) then additionalPeers else [additionalPeers] } }, + '#withAutomountServiceAccountToken':: d.fn(help='"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\\nIf the service account has `automountServiceAccountToken: true`, set the field to `false` to opt out of automounting API credentials."', args=[d.arg(name='automountServiceAccountToken', type=d.T.boolean)]), + withAutomountServiceAccountToken(automountServiceAccountToken): { spec+: { automountServiceAccountToken: automountServiceAccountToken } }, + '#withBaseImage':: d.fn(help="\"Base image that is used to deploy pods, without tag.\\nDeprecated: use 'image' instead.\"", args=[d.arg(name='baseImage', type=d.T.string)]), + withBaseImage(baseImage): { spec+: { baseImage: baseImage } }, + '#withClusterAdvertiseAddress':: d.fn(help='"ClusterAdvertiseAddress is the explicit address to advertise in cluster.\\nNeeds to be provided for non RFC1918 [1] (public) addresses.\\n[1] RFC1918: https://tools.ietf.org/html/rfc1918"', args=[d.arg(name='clusterAdvertiseAddress', type=d.T.string)]), + withClusterAdvertiseAddress(clusterAdvertiseAddress): { spec+: { clusterAdvertiseAddress: clusterAdvertiseAddress } }, + '#withClusterGossipInterval':: d.fn(help='"Interval between gossip attempts."', args=[d.arg(name='clusterGossipInterval', type=d.T.string)]), + withClusterGossipInterval(clusterGossipInterval): { spec+: { clusterGossipInterval: clusterGossipInterval } }, + '#withClusterLabel':: d.fn(help='"Defines the identifier that uniquely identifies the Alertmanager cluster.\\nYou should only set it when the Alertmanager cluster includes Alertmanager instances which are external to this Alertmanager resource. In practice, the addresses of the external instances are provided via the `.spec.additionalPeers` field."', args=[d.arg(name='clusterLabel', type=d.T.string)]), + withClusterLabel(clusterLabel): { spec+: { clusterLabel: clusterLabel } }, + '#withClusterPeerTimeout':: d.fn(help='"Timeout for cluster peering."', args=[d.arg(name='clusterPeerTimeout', type=d.T.string)]), + withClusterPeerTimeout(clusterPeerTimeout): { spec+: { clusterPeerTimeout: clusterPeerTimeout } }, + '#withClusterPushpullInterval':: d.fn(help='"Interval between pushpull attempts."', args=[d.arg(name='clusterPushpullInterval', type=d.T.string)]), + withClusterPushpullInterval(clusterPushpullInterval): { spec+: { clusterPushpullInterval: clusterPushpullInterval } }, + '#withConfigMaps':: d.fn(help="\"ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager\\nobject, which shall be mounted into the Alertmanager Pods.\\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-\u003cconfigmap-name\u003e`.\\nThe ConfigMaps are mounted into `/etc/alertmanager/configmaps/\u003cconfigmap-name\u003e` in the 'alertmanager' container.\"", args=[d.arg(name='configMaps', type=d.T.array)]), + withConfigMaps(configMaps): { spec+: { configMaps: if std.isArray(v=configMaps) then configMaps else [configMaps] } }, + '#withConfigMapsMixin':: d.fn(help="\"ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager\\nobject, which shall be mounted into the Alertmanager Pods.\\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-\u003cconfigmap-name\u003e`.\\nThe ConfigMaps are mounted into `/etc/alertmanager/configmaps/\u003cconfigmap-name\u003e` in the 'alertmanager' container.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='configMaps', type=d.T.array)]), + withConfigMapsMixin(configMaps): { spec+: { configMaps+: if std.isArray(v=configMaps) then configMaps else [configMaps] } }, + '#withConfigSecret':: d.fn(help='"ConfigSecret is the name of a Kubernetes Secret in the same namespace as the\\nAlertmanager object, which contains the configuration for this Alertmanager\\ninstance. If empty, it defaults to `alertmanager-`.\\n\\n\\nThe Alertmanager configuration should be available under the\\n`alertmanager.yaml` key. Additional keys from the original secret are\\ncopied to the generated secret and mounted into the\\n`/etc/alertmanager/config` directory in the `alertmanager` container.\\n\\n\\nIf either the secret or the `alertmanager.yaml` key is missing, the\\noperator provisions a minimal Alertmanager configuration with one empty\\nreceiver (effectively dropping alert notifications)."', args=[d.arg(name='configSecret', type=d.T.string)]), + withConfigSecret(configSecret): { spec+: { configSecret: configSecret } }, + '#withContainers':: d.fn(help='"Containers allows injecting additional containers. This is meant to\\nallow adding an authentication proxy to an Alertmanager pod.\\nContainers described here modify an operator generated container if they\\nshare the same name and modifications are done via a strategic merge\\npatch. The current container names are: `alertmanager` and\\n`config-reloader`. Overriding containers is entirely outside the scope\\nof what the maintainers will support and by doing so, you accept that\\nthis behaviour may break at any time without notice."', args=[d.arg(name='containers', type=d.T.array)]), + withContainers(containers): { spec+: { containers: if std.isArray(v=containers) then containers else [containers] } }, + '#withContainersMixin':: d.fn(help='"Containers allows injecting additional containers. This is meant to\\nallow adding an authentication proxy to an Alertmanager pod.\\nContainers described here modify an operator generated container if they\\nshare the same name and modifications are done via a strategic merge\\npatch. The current container names are: `alertmanager` and\\n`config-reloader`. Overriding containers is entirely outside the scope\\nof what the maintainers will support and by doing so, you accept that\\nthis behaviour may break at any time without notice."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='containers', type=d.T.array)]), + withContainersMixin(containers): { spec+: { containers+: if std.isArray(v=containers) then containers else [containers] } }, + '#withEnableFeatures':: d.fn(help='"Enable access to Alertmanager feature flags. By default, no features are enabled.\\nEnabling features which are disabled by default is entirely outside the\\nscope of what the maintainers will support and by doing so, you accept\\nthat this behaviour may break at any time without notice.\\n\\n\\nIt requires Alertmanager >= 0.27.0."', args=[d.arg(name='enableFeatures', type=d.T.array)]), + withEnableFeatures(enableFeatures): { spec+: { enableFeatures: if std.isArray(v=enableFeatures) then enableFeatures else [enableFeatures] } }, + '#withEnableFeaturesMixin':: d.fn(help='"Enable access to Alertmanager feature flags. By default, no features are enabled.\\nEnabling features which are disabled by default is entirely outside the\\nscope of what the maintainers will support and by doing so, you accept\\nthat this behaviour may break at any time without notice.\\n\\n\\nIt requires Alertmanager >= 0.27.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='enableFeatures', type=d.T.array)]), + withEnableFeaturesMixin(enableFeatures): { spec+: { enableFeatures+: if std.isArray(v=enableFeatures) then enableFeatures else [enableFeatures] } }, + '#withExternalUrl':: d.fn(help='"The external URL the Alertmanager instances will be available under. This is\\nnecessary to generate correct URLs. This is necessary if Alertmanager is not\\nserved from root of a DNS name."', args=[d.arg(name='externalUrl', type=d.T.string)]), + withExternalUrl(externalUrl): { spec+: { externalUrl: externalUrl } }, + '#withForceEnableClusterMode':: d.fn(help='"ForceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica.\\nUse case is e.g. spanning an Alertmanager cluster across Kubernetes clusters with a single replica in each."', args=[d.arg(name='forceEnableClusterMode', type=d.T.boolean)]), + withForceEnableClusterMode(forceEnableClusterMode): { spec+: { forceEnableClusterMode: forceEnableClusterMode } }, + '#withHostAliases':: d.fn(help="\"Pods' hostAliases configuration\"", args=[d.arg(name='hostAliases', type=d.T.array)]), + withHostAliases(hostAliases): { spec+: { hostAliases: if std.isArray(v=hostAliases) then hostAliases else [hostAliases] } }, + '#withHostAliasesMixin':: d.fn(help="\"Pods' hostAliases configuration\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='hostAliases', type=d.T.array)]), + withHostAliasesMixin(hostAliases): { spec+: { hostAliases+: if std.isArray(v=hostAliases) then hostAliases else [hostAliases] } }, + '#withImage':: d.fn(help='"Image if specified has precedence over baseImage, tag and sha\\ncombinations. Specifying the version is still necessary to ensure the\\nPrometheus Operator knows what version of Alertmanager is being\\nconfigured."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { spec+: { image: image } }, + '#withImagePullPolicy':: d.fn(help="\"Image pull policy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers.\\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.\"", args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { spec+: { imagePullPolicy: imagePullPolicy } }, + '#withImagePullSecrets':: d.fn(help='"An optional list of references to secrets in the same namespace\\nto use for pulling prometheus and alertmanager images from registries\\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"', args=[d.arg(name='imagePullSecrets', type=d.T.array)]), + withImagePullSecrets(imagePullSecrets): { spec+: { imagePullSecrets: if std.isArray(v=imagePullSecrets) then imagePullSecrets else [imagePullSecrets] } }, + '#withImagePullSecretsMixin':: d.fn(help='"An optional list of references to secrets in the same namespace\\nto use for pulling prometheus and alertmanager images from registries\\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='imagePullSecrets', type=d.T.array)]), + withImagePullSecretsMixin(imagePullSecrets): { spec+: { imagePullSecrets+: if std.isArray(v=imagePullSecrets) then imagePullSecrets else [imagePullSecrets] } }, + '#withInitContainers':: d.fn(help='"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\\nfetch secrets for injection into the Alertmanager configuration from external sources. Any\\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nInitContainers described here modify an operator\\ngenerated init containers if they share the same name and modifications are\\ndone via a strategic merge patch. The current init container name is:\\n`init-config-reloader`. Overriding init containers is entirely outside the\\nscope of what the maintainers will support and by doing so, you accept that\\nthis behaviour may break at any time without notice."', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainers(initContainers): { spec+: { initContainers: if std.isArray(v=initContainers) then initContainers else [initContainers] } }, + '#withInitContainersMixin':: d.fn(help='"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\\nfetch secrets for injection into the Alertmanager configuration from external sources. Any\\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nInitContainers described here modify an operator\\ngenerated init containers if they share the same name and modifications are\\ndone via a strategic merge patch. The current init container name is:\\n`init-config-reloader`. Overriding init containers is entirely outside the\\nscope of what the maintainers will support and by doing so, you accept that\\nthis behaviour may break at any time without notice."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainersMixin(initContainers): { spec+: { initContainers+: if std.isArray(v=initContainers) then initContainers else [initContainers] } }, + '#withListenLocal':: d.fn(help='"ListenLocal makes the Alertmanager server listen on loopback, so that it\\ndoes not bind against the Pod IP. Note this is only for the Alertmanager\\nUI, not the gossip communication."', args=[d.arg(name='listenLocal', type=d.T.boolean)]), + withListenLocal(listenLocal): { spec+: { listenLocal: listenLocal } }, + '#withLogFormat':: d.fn(help='"Log format for Alertmanager to be configured with."', args=[d.arg(name='logFormat', type=d.T.string)]), + withLogFormat(logFormat): { spec+: { logFormat: logFormat } }, + '#withLogLevel':: d.fn(help='"Log level for Alertmanager to be configured with."', args=[d.arg(name='logLevel', type=d.T.string)]), + withLogLevel(logLevel): { spec+: { logLevel: logLevel } }, + '#withMinReadySeconds':: d.fn(help='"Minimum number of seconds for which a newly created pod should be ready\\nwithout any of its container crashing for it to be considered available.\\nDefaults to 0 (pod will be considered available as soon as it is ready)\\nThis is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate."', args=[d.arg(name='minReadySeconds', type=d.T.integer)]), + withMinReadySeconds(minReadySeconds): { spec+: { minReadySeconds: minReadySeconds } }, + '#withNodeSelector':: d.fn(help='"Define which Nodes the Pods are scheduled on."', args=[d.arg(name='nodeSelector', type=d.T.object)]), + withNodeSelector(nodeSelector): { spec+: { nodeSelector: nodeSelector } }, + '#withNodeSelectorMixin':: d.fn(help='"Define which Nodes the Pods are scheduled on."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeSelector', type=d.T.object)]), + withNodeSelectorMixin(nodeSelector): { spec+: { nodeSelector+: nodeSelector } }, + '#withPaused':: d.fn(help='"If set to true all actions on the underlying managed objects are not\\ngoint to be performed, except for delete actions."', args=[d.arg(name='paused', type=d.T.boolean)]), + withPaused(paused): { spec+: { paused: paused } }, + '#withPortName':: d.fn(help='"Port name used for the pods and governing service.\\nDefaults to `web`."', args=[d.arg(name='portName', type=d.T.string)]), + withPortName(portName): { spec+: { portName: portName } }, + '#withPriorityClassName':: d.fn(help='"Priority class assigned to the Pods"', args=[d.arg(name='priorityClassName', type=d.T.string)]), + withPriorityClassName(priorityClassName): { spec+: { priorityClassName: priorityClassName } }, + '#withReplicas':: d.fn(help='"Size is the expected size of the alertmanager cluster. The controller will\\neventually make the size of the running cluster equal to the expected\\nsize."', args=[d.arg(name='replicas', type=d.T.integer)]), + withReplicas(replicas): { spec+: { replicas: replicas } }, + '#withRetention':: d.fn(help="\"Time duration Alertmanager shall retain data for. Default is '120h',\\nand must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds seconds minutes hours).\"", args=[d.arg(name='retention', type=d.T.string)]), + withRetention(retention): { spec+: { retention: retention } }, + '#withRoutePrefix':: d.fn(help='"The route prefix Alertmanager registers HTTP handlers for. This is useful,\\nif using ExternalURL and a proxy is rewriting HTTP routes of a request,\\nand the actual ExternalURL is still true, but the server serves requests\\nunder a different route prefix. For example for use with `kubectl proxy`."', args=[d.arg(name='routePrefix', type=d.T.string)]), + withRoutePrefix(routePrefix): { spec+: { routePrefix: routePrefix } }, + '#withSecrets':: d.fn(help="\"Secrets is a list of Secrets in the same namespace as the Alertmanager\\nobject, which shall be mounted into the Alertmanager Pods.\\nEach Secret is added to the StatefulSet definition as a volume named `secret-\u003csecret-name\u003e`.\\nThe Secrets are mounted into `/etc/alertmanager/secrets/\u003csecret-name\u003e` in the 'alertmanager' container.\"", args=[d.arg(name='secrets', type=d.T.array)]), + withSecrets(secrets): { spec+: { secrets: if std.isArray(v=secrets) then secrets else [secrets] } }, + '#withSecretsMixin':: d.fn(help="\"Secrets is a list of Secrets in the same namespace as the Alertmanager\\nobject, which shall be mounted into the Alertmanager Pods.\\nEach Secret is added to the StatefulSet definition as a volume named `secret-\u003csecret-name\u003e`.\\nThe Secrets are mounted into `/etc/alertmanager/secrets/\u003csecret-name\u003e` in the 'alertmanager' container.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='secrets', type=d.T.array)]), + withSecretsMixin(secrets): { spec+: { secrets+: if std.isArray(v=secrets) then secrets else [secrets] } }, + '#withServiceAccountName':: d.fn(help='"ServiceAccountName is the name of the ServiceAccount to use to run the\\nPrometheus Pods."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withSha':: d.fn(help="\"SHA of Alertmanager container image to be deployed. Defaults to the value of `version`.\\nSimilar to a tag, but the SHA explicitly deploys an immutable container image.\\nVersion and Tag are ignored if SHA is set.\\nDeprecated: use 'image' instead. The image digest can be specified as part of the image URL.\"", args=[d.arg(name='sha', type=d.T.string)]), + withSha(sha): { spec+: { sha: sha } }, + '#withTag':: d.fn(help="\"Tag of Alertmanager container image to be deployed. Defaults to the value of `version`.\\nVersion is ignored if Tag is set.\\nDeprecated: use 'image' instead. The image tag can be specified as part of the image URL.\"", args=[d.arg(name='tag', type=d.T.string)]), + withTag(tag): { spec+: { tag: tag } }, + '#withTolerations':: d.fn(help="\"If specified, the pod's tolerations.\"", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerations(tolerations): { spec+: { tolerations: if std.isArray(v=tolerations) then tolerations else [tolerations] } }, + '#withTolerationsMixin':: d.fn(help="\"If specified, the pod's tolerations.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerationsMixin(tolerations): { spec+: { tolerations+: if std.isArray(v=tolerations) then tolerations else [tolerations] } }, + '#withTopologySpreadConstraints':: d.fn(help="\"If specified, the pod's topology spread constraints.\"", args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), + withTopologySpreadConstraints(topologySpreadConstraints): { spec+: { topologySpreadConstraints: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, + '#withTopologySpreadConstraintsMixin':: d.fn(help="\"If specified, the pod's topology spread constraints.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), + withTopologySpreadConstraintsMixin(topologySpreadConstraints): { spec+: { topologySpreadConstraints+: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, + '#withVersion':: d.fn(help='"Version the cluster should be on."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { version: version } }, + '#withVolumeMounts':: d.fn(help='"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\\nVolumeMounts specified will be appended to other VolumeMounts in the alertmanager container,\\nthat are generated as a result of StorageSpec objects."', args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { spec+: { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } }, + '#withVolumeMountsMixin':: d.fn(help='"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\\nVolumeMounts specified will be appended to other VolumeMounts in the alertmanager container,\\nthat are generated as a result of StorageSpec objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { spec+: { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } }, + '#withVolumes':: d.fn(help='"Volumes allows configuration of additional volumes on the output StatefulSet definition.\\nVolumes specified will be appended to other volumes that are generated as a result of\\nStorageSpec objects."', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumes(volumes): { spec+: { volumes: if std.isArray(v=volumes) then volumes else [volumes] } }, + '#withVolumesMixin':: d.fn(help='"Volumes allows configuration of additional volumes on the output StatefulSet definition.\\nVolumes specified will be appended to other volumes that are generated as a result of\\nStorageSpec objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumesMixin(volumes): { spec+: { volumes+: if std.isArray(v=volumes) then volumes else [volumes] } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/_gen/monitoring/v1/main.libsonnet b/0.14/_gen/monitoring/v1/main.libsonnet new file mode 100644 index 0000000..35ee044 --- /dev/null +++ b/0.14/_gen/monitoring/v1/main.libsonnet @@ -0,0 +1,11 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1', url='', help=''), + alertmanager: (import 'alertmanager.libsonnet'), + podMonitor: (import 'podMonitor.libsonnet'), + probe: (import 'probe.libsonnet'), + prometheus: (import 'prometheus.libsonnet'), + prometheusRule: (import 'prometheusRule.libsonnet'), + serviceMonitor: (import 'serviceMonitor.libsonnet'), + thanosRuler: (import 'thanosRuler.libsonnet'), +} diff --git a/0.14/_gen/monitoring/v1/podMonitor.libsonnet b/0.14/_gen/monitoring/v1/podMonitor.libsonnet new file mode 100644 index 0000000..5b7a66f --- /dev/null +++ b/0.14/_gen/monitoring/v1/podMonitor.libsonnet @@ -0,0 +1,421 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='podMonitor', url='', help='"The `PodMonitor` custom resource definition (CRD) defines how `Prometheus` and `PrometheusAgent` can scrape metrics from a group of pods.\\nAmong other things, it allows to specify:\\n* The pods to scrape via label selectors.\\n* The container ports to scrape.\\n* Authentication credentials to use.\\n* Target and metric relabeling.\\n\\n\\n`Prometheus` and `PrometheusAgent` objects select `PodMonitor` objects using label and namespace selectors."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of PodMonitor', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1', + kind: 'PodMonitor', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Specification of desired Pod selection for target discovery by Prometheus."'), + spec: { + '#attachMetadata':: d.obj(help='"`attachMetadata` defines additional metadata which is added to the\\ndiscovered targets.\\n\\n\\nIt requires Prometheus >= v2.35.0."'), + attachMetadata: { + '#withNode':: d.fn(help='"When set to true, Prometheus attaches node metadata to the discovered\\ntargets.\\n\\n\\nThe Prometheus service account must have the `list` and `watch`\\npermissions on the `Nodes` objects."', args=[d.arg(name='node', type=d.T.boolean)]), + withNode(node): { spec+: { attachMetadata+: { node: node } } }, + }, + '#namespaceSelector':: d.obj(help='"`namespaceSelector` defines in which namespace(s) Prometheus should discover the pods.\\nBy default, the pods are discovered in the same namespace as the `PodMonitor` object but it is possible to select pods across different/all namespaces."'), + namespaceSelector: { + '#withAny':: d.fn(help='"Boolean describing whether all namespaces are selected in contrast to a\\nlist restricting them."', args=[d.arg(name='any', type=d.T.boolean)]), + withAny(any): { spec+: { namespaceSelector+: { any: any } } }, + '#withMatchNames':: d.fn(help='"List of namespace names to select from."', args=[d.arg(name='matchNames', type=d.T.array)]), + withMatchNames(matchNames): { spec+: { namespaceSelector+: { matchNames: if std.isArray(v=matchNames) then matchNames else [matchNames] } } }, + '#withMatchNamesMixin':: d.fn(help='"List of namespace names to select from."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchNames', type=d.T.array)]), + withMatchNamesMixin(matchNames): { spec+: { namespaceSelector+: { matchNames+: if std.isArray(v=matchNames) then matchNames else [matchNames] } } }, + }, + '#podMetricsEndpoints':: d.obj(help='"Defines how to scrape metrics from the selected pods."'), + podMetricsEndpoints: { + '#authorization':: d.obj(help='"`authorization` configures the Authorization header credentials to use when\\nscraping the target.\\n\\n\\nCannot be set at the same time as `basicAuth`, or `oauth2`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"`basicAuth` configures the Basic Authentication credentials to use when\\nscraping the target.\\n\\n\\nCannot be set at the same time as `authorization`, or `oauth2`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help='"`bearerTokenSecret` specifies a key of a Secret containing the bearer\\ntoken for scraping targets. The secret needs to be in the same namespace\\nas the PodMonitor object and readable by the Prometheus Operator.\\n\\n\\nDeprecated: use `authorization` instead."'), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { bearerTokenSecret+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { bearerTokenSecret+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { bearerTokenSecret+: { optional: optional } }, + }, + '#metricRelabelings':: d.obj(help='"`metricRelabelings` configures the relabeling rules to apply to the\\nsamples before ingestion."'), + metricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#oauth2':: d.obj(help='"`oauth2` configures the OAuth2 settings to use when scraping the target.\\n\\n\\nIt requires Prometheus >= 2.27.0.\\n\\n\\nCannot be set at the same time as `authorization`, or `basicAuth`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#relabelings':: d.obj(help="\"`relabelings` configures the relabeling rules to apply the target's\\nmetadata labels.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\\n\\n\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\""), + relabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when scraping the target."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withEnableHttp2':: d.fn(help='"`enableHttp2` can be used to disable HTTP2 when scraping the target."', args=[d.arg(name='enableHttp2', type=d.T.boolean)]), + withEnableHttp2(enableHttp2): { enableHttp2: enableHttp2 }, + '#withFilterRunning':: d.fn(help='"When true, the pods which are not running (e.g. either in Failed or\\nSucceeded state) are dropped during the target discovery.\\n\\n\\nIf unset, the filtering is enabled.\\n\\n\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase"', args=[d.arg(name='filterRunning', type=d.T.boolean)]), + withFilterRunning(filterRunning): { filterRunning: filterRunning }, + '#withFollowRedirects':: d.fn(help='"`followRedirects` defines whether the scrape requests should follow HTTP\\n3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withHonorLabels':: d.fn(help="\"When true, `honorLabels` preserves the metric's labels when they collide\\nwith the target's labels.\"", args=[d.arg(name='honorLabels', type=d.T.boolean)]), + withHonorLabels(honorLabels): { honorLabels: honorLabels }, + '#withHonorTimestamps':: d.fn(help='"`honorTimestamps` controls whether Prometheus preserves the timestamps\\nwhen exposed by the target."', args=[d.arg(name='honorTimestamps', type=d.T.boolean)]), + withHonorTimestamps(honorTimestamps): { honorTimestamps: honorTimestamps }, + '#withInterval':: d.fn(help='"Interval at which Prometheus scrapes the metrics from the target.\\n\\n\\nIf empty, Prometheus uses the global scrape interval."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { interval: interval }, + '#withMetricRelabelings':: d.fn(help='"`metricRelabelings` configures the relabeling rules to apply to the\\nsamples before ingestion."', args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelings(metricRelabelings): { metricRelabelings: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] }, + '#withMetricRelabelingsMixin':: d.fn(help='"`metricRelabelings` configures the relabeling rules to apply to the\\nsamples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelingsMixin(metricRelabelings): { metricRelabelings+: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] }, + '#withParams':: d.fn(help='"`params` define optional HTTP URL parameters."', args=[d.arg(name='params', type=d.T.object)]), + withParams(params): { params: params }, + '#withParamsMixin':: d.fn(help='"`params` define optional HTTP URL parameters."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='params', type=d.T.object)]), + withParamsMixin(params): { params+: params }, + '#withPath':: d.fn(help='"HTTP path from which to scrape for metrics.\\n\\n\\nIf empty, Prometheus uses the default value (e.g. `/metrics`)."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + '#withPort':: d.fn(help='"Name of the Pod port which this endpoint refers to.\\n\\n\\nIt takes precedence over `targetPort`."', args=[d.arg(name='port', type=d.T.string)]), + withPort(port): { port: port }, + '#withProxyUrl':: d.fn(help='"`proxyURL` configures the HTTP Proxy URL (e.g.\\n\\"http://proxyserver:2195\\") to go through when scraping the target."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRelabelings':: d.fn(help="\"`relabelings` configures the relabeling rules to apply the target's\\nmetadata labels.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\\n\\n\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\"", args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelings(relabelings): { relabelings: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + '#withRelabelingsMixin':: d.fn(help="\"`relabelings` configures the relabeling rules to apply the target's\\nmetadata labels.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\\n\\n\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelingsMixin(relabelings): { relabelings+: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + '#withScheme':: d.fn(help='"HTTP scheme to use for scraping.\\n\\n\\n`http` and `https` are the expected values unless you rewrite the\\n`__scheme__` label via relabeling.\\n\\n\\nIf empty, Prometheus uses the default value `http`."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { scheme: scheme }, + '#withScrapeTimeout':: d.fn(help="\"Timeout after which Prometheus considers the scrape to be failed.\\n\\n\\nIf empty, Prometheus uses the global scrape timeout unless it is less\\nthan the target's scrape interval value in which the latter is used.\"", args=[d.arg(name='scrapeTimeout', type=d.T.string)]), + withScrapeTimeout(scrapeTimeout): { scrapeTimeout: scrapeTimeout }, + '#withTargetPort':: d.fn(help="\"Name or number of the target port of the `Pod` object behind the Service, the\\nport must be specified with container port property.\\n\\n\\nDeprecated: use 'port' instead.\"", args=[d.arg(name='targetPort', type=d.T.any)]), + withTargetPort(targetPort): { targetPort: targetPort }, + '#withTrackTimestampsStaleness':: d.fn(help='"`trackTimestampsStaleness` defines whether Prometheus tracks staleness of\\nthe metrics that have an explicit timestamp present in scraped data.\\nHas no effect if `honorTimestamps` is false.\\n\\n\\nIt requires Prometheus >= v2.48.0."', args=[d.arg(name='trackTimestampsStaleness', type=d.T.boolean)]), + withTrackTimestampsStaleness(trackTimestampsStaleness): { trackTimestampsStaleness: trackTimestampsStaleness }, + }, + '#selector':: d.obj(help='"Label selector to select the Kubernetes `Pod` objects to scrape metrics from."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { selector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { selector+: { matchLabels+: matchLabels } } }, + }, + '#withBodySizeLimit':: d.fn(help='"When defined, bodySizeLimit specifies a job level limit on the size\\nof uncompressed response body that will be accepted by Prometheus.\\n\\n\\nIt requires Prometheus >= v2.28.0."', args=[d.arg(name='bodySizeLimit', type=d.T.string)]), + withBodySizeLimit(bodySizeLimit): { spec+: { bodySizeLimit: bodySizeLimit } }, + '#withJobLabel':: d.fn(help='"The label to use to retrieve the job name from.\\n`jobLabel` selects the label from the associated Kubernetes `Pod`\\nobject which will be used as the `job` label for all metrics.\\n\\n\\nFor example if `jobLabel` is set to `foo` and the Kubernetes `Pod`\\nobject is labeled with `foo: bar`, then Prometheus adds the `job=\\"bar\\"`\\nlabel to all ingested metrics.\\n\\n\\nIf the value of this field is empty, the `job` label of the metrics\\ndefaults to the namespace and name of the PodMonitor object (e.g. `/`)."', args=[d.arg(name='jobLabel', type=d.T.string)]), + withJobLabel(jobLabel): { spec+: { jobLabel: jobLabel } }, + '#withKeepDroppedTargets':: d.fn(help='"Per-scrape limit on the number of targets dropped by relabeling\\nthat will be kept in memory. 0 means no limit.\\n\\n\\nIt requires Prometheus >= v2.47.0."', args=[d.arg(name='keepDroppedTargets', type=d.T.integer)]), + withKeepDroppedTargets(keepDroppedTargets): { spec+: { keepDroppedTargets: keepDroppedTargets } }, + '#withLabelLimit':: d.fn(help='"Per-scrape limit on number of labels that will be accepted for a sample.\\n\\n\\nIt requires Prometheus >= v2.27.0."', args=[d.arg(name='labelLimit', type=d.T.integer)]), + withLabelLimit(labelLimit): { spec+: { labelLimit: labelLimit } }, + '#withLabelNameLengthLimit':: d.fn(help='"Per-scrape limit on length of labels name that will be accepted for a sample.\\n\\n\\nIt requires Prometheus >= v2.27.0."', args=[d.arg(name='labelNameLengthLimit', type=d.T.integer)]), + withLabelNameLengthLimit(labelNameLengthLimit): { spec+: { labelNameLengthLimit: labelNameLengthLimit } }, + '#withLabelValueLengthLimit':: d.fn(help='"Per-scrape limit on length of labels value that will be accepted for a sample.\\n\\n\\nIt requires Prometheus >= v2.27.0."', args=[d.arg(name='labelValueLengthLimit', type=d.T.integer)]), + withLabelValueLengthLimit(labelValueLengthLimit): { spec+: { labelValueLengthLimit: labelValueLengthLimit } }, + '#withPodMetricsEndpoints':: d.fn(help='"Defines how to scrape metrics from the selected pods."', args=[d.arg(name='podMetricsEndpoints', type=d.T.array)]), + withPodMetricsEndpoints(podMetricsEndpoints): { spec+: { podMetricsEndpoints: if std.isArray(v=podMetricsEndpoints) then podMetricsEndpoints else [podMetricsEndpoints] } }, + '#withPodMetricsEndpointsMixin':: d.fn(help='"Defines how to scrape metrics from the selected pods."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podMetricsEndpoints', type=d.T.array)]), + withPodMetricsEndpointsMixin(podMetricsEndpoints): { spec+: { podMetricsEndpoints+: if std.isArray(v=podMetricsEndpoints) then podMetricsEndpoints else [podMetricsEndpoints] } }, + '#withPodTargetLabels':: d.fn(help='"`podTargetLabels` defines the labels which are transferred from the\\nassociated Kubernetes `Pod` object onto the ingested metrics."', args=[d.arg(name='podTargetLabels', type=d.T.array)]), + withPodTargetLabels(podTargetLabels): { spec+: { podTargetLabels: if std.isArray(v=podTargetLabels) then podTargetLabels else [podTargetLabels] } }, + '#withPodTargetLabelsMixin':: d.fn(help='"`podTargetLabels` defines the labels which are transferred from the\\nassociated Kubernetes `Pod` object onto the ingested metrics."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podTargetLabels', type=d.T.array)]), + withPodTargetLabelsMixin(podTargetLabels): { spec+: { podTargetLabels+: if std.isArray(v=podTargetLabels) then podTargetLabels else [podTargetLabels] } }, + '#withSampleLimit':: d.fn(help='"`sampleLimit` defines a per-scrape limit on the number of scraped samples\\nthat will be accepted."', args=[d.arg(name='sampleLimit', type=d.T.integer)]), + withSampleLimit(sampleLimit): { spec+: { sampleLimit: sampleLimit } }, + '#withScrapeClass':: d.fn(help='"The scrape class to apply."', args=[d.arg(name='scrapeClass', type=d.T.string)]), + withScrapeClass(scrapeClass): { spec+: { scrapeClass: scrapeClass } }, + '#withScrapeProtocols':: d.fn(help='"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocols(scrapeProtocols): { spec+: { scrapeProtocols: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeProtocolsMixin':: d.fn(help='"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocolsMixin(scrapeProtocols): { spec+: { scrapeProtocols+: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withTargetLimit':: d.fn(help='"`targetLimit` defines a limit on the number of scraped targets that will\\nbe accepted."', args=[d.arg(name='targetLimit', type=d.T.integer)]), + withTargetLimit(targetLimit): { spec+: { targetLimit: targetLimit } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/_gen/monitoring/v1/probe.libsonnet b/0.14/_gen/monitoring/v1/probe.libsonnet new file mode 100644 index 0000000..6024f4e --- /dev/null +++ b/0.14/_gen/monitoring/v1/probe.libsonnet @@ -0,0 +1,430 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='probe', url='', help='"The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).\\n\\n\\nThe `Probe` resource needs 2 pieces of information:\\n* The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects.\\n* The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.\\n\\n\\n`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Probe', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1', + kind: 'Probe', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Specification of desired Ingress selection for target discovery by Prometheus."'), + spec: { + '#authorization':: d.obj(help='"Authorization section for this endpoint"'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth allow an endpoint to authenticate over basic authentication.\\nMore info: https://prometheus.io/docs/operating/configuration/#endpoint"'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help='"Secret to mount to read bearer token for scraping targets. The secret\\nneeds to be in the same namespace as the probe and accessible by\\nthe Prometheus Operator."'), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#metricRelabelings':: d.obj(help='"MetricRelabelConfigs to apply to samples before ingestion."'), + metricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#oauth2':: d.obj(help='"OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { spec+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { spec+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { spec+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { spec+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { spec+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { spec+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { spec+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { spec+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { spec+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { spec+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#prober':: d.obj(help='"Specification for the prober to use for probing targets.\\nThe prober.URL parameter is required. Targets cannot be probed if left empty."'), + prober: { + '#withPath':: d.fn(help='"Path to collect metrics from.\\nDefaults to `/probe`."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { spec+: { prober+: { path: path } } }, + '#withProxyUrl':: d.fn(help='"Optional ProxyURL."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { spec+: { prober+: { proxyUrl: proxyUrl } } }, + '#withScheme':: d.fn(help='"HTTP scheme to use for scraping.\\n`http` and `https` are the expected values unless you rewrite the `__scheme__` label via relabeling.\\nIf empty, Prometheus uses the default value `http`."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { spec+: { prober+: { scheme: scheme } } }, + '#withUrl':: d.fn(help='"Mandatory URL of the prober."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { spec+: { prober+: { url: url } } }, + }, + '#targets':: d.obj(help='"Targets defines a set of static or dynamically discovered targets to probe."'), + targets: { + '#ingress':: d.obj(help='"ingress defines the Ingress objects to probe and the relabeling\\nconfiguration.\\nIf `staticConfig` is also defined, `staticConfig` takes precedence."'), + ingress: { + '#namespaceSelector':: d.obj(help='"From which namespaces to select Ingress objects."'), + namespaceSelector: { + '#withAny':: d.fn(help='"Boolean describing whether all namespaces are selected in contrast to a\\nlist restricting them."', args=[d.arg(name='any', type=d.T.boolean)]), + withAny(any): { spec+: { targets+: { ingress+: { namespaceSelector+: { any: any } } } } }, + '#withMatchNames':: d.fn(help='"List of namespace names to select from."', args=[d.arg(name='matchNames', type=d.T.array)]), + withMatchNames(matchNames): { spec+: { targets+: { ingress+: { namespaceSelector+: { matchNames: if std.isArray(v=matchNames) then matchNames else [matchNames] } } } } }, + '#withMatchNamesMixin':: d.fn(help='"List of namespace names to select from."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchNames', type=d.T.array)]), + withMatchNamesMixin(matchNames): { spec+: { targets+: { ingress+: { namespaceSelector+: { matchNames+: if std.isArray(v=matchNames) then matchNames else [matchNames] } } } } }, + }, + '#relabelingConfigs':: d.obj(help="\"RelabelConfigs to apply to the label set of the target before it gets\\nscraped.\\nThe original ingress address is available via the\\n`__tmp_prometheus_ingress_address` label. It can be used to customize the\\nprobed URL.\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\""), + relabelingConfigs: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#selector':: d.obj(help='"Selector to select the Ingress objects."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { targets+: { ingress+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { targets+: { ingress+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { targets+: { ingress+: { selector+: { matchLabels: matchLabels } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { targets+: { ingress+: { selector+: { matchLabels+: matchLabels } } } } }, + }, + '#withRelabelingConfigs':: d.fn(help="\"RelabelConfigs to apply to the label set of the target before it gets\\nscraped.\\nThe original ingress address is available via the\\n`__tmp_prometheus_ingress_address` label. It can be used to customize the\\nprobed URL.\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\"", args=[d.arg(name='relabelingConfigs', type=d.T.array)]), + withRelabelingConfigs(relabelingConfigs): { spec+: { targets+: { ingress+: { relabelingConfigs: if std.isArray(v=relabelingConfigs) then relabelingConfigs else [relabelingConfigs] } } } }, + '#withRelabelingConfigsMixin':: d.fn(help="\"RelabelConfigs to apply to the label set of the target before it gets\\nscraped.\\nThe original ingress address is available via the\\n`__tmp_prometheus_ingress_address` label. It can be used to customize the\\nprobed URL.\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='relabelingConfigs', type=d.T.array)]), + withRelabelingConfigsMixin(relabelingConfigs): { spec+: { targets+: { ingress+: { relabelingConfigs+: if std.isArray(v=relabelingConfigs) then relabelingConfigs else [relabelingConfigs] } } } }, + }, + '#staticConfig':: d.obj(help='"staticConfig defines the static list of targets to probe and the\\nrelabeling configuration.\\nIf `ingress` is also defined, `staticConfig` takes precedence.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config."'), + staticConfig: { + '#relabelingConfigs':: d.obj(help='"RelabelConfigs to apply to the label set of the targets before it gets\\nscraped.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"'), + relabelingConfigs: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#withLabels':: d.fn(help='"Labels assigned to all metrics scraped from the targets."', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { targets+: { staticConfig+: { labels: labels } } } }, + '#withLabelsMixin':: d.fn(help='"Labels assigned to all metrics scraped from the targets."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { targets+: { staticConfig+: { labels+: labels } } } }, + '#withRelabelingConfigs':: d.fn(help='"RelabelConfigs to apply to the label set of the targets before it gets\\nscraped.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"', args=[d.arg(name='relabelingConfigs', type=d.T.array)]), + withRelabelingConfigs(relabelingConfigs): { spec+: { targets+: { staticConfig+: { relabelingConfigs: if std.isArray(v=relabelingConfigs) then relabelingConfigs else [relabelingConfigs] } } } }, + '#withRelabelingConfigsMixin':: d.fn(help='"RelabelConfigs to apply to the label set of the targets before it gets\\nscraped.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='relabelingConfigs', type=d.T.array)]), + withRelabelingConfigsMixin(relabelingConfigs): { spec+: { targets+: { staticConfig+: { relabelingConfigs+: if std.isArray(v=relabelingConfigs) then relabelingConfigs else [relabelingConfigs] } } } }, + '#withStatic':: d.fn(help='"The list of hosts to probe."', args=[d.arg(name='static', type=d.T.array)]), + withStatic(static): { spec+: { targets+: { staticConfig+: { static: if std.isArray(v=static) then static else [static] } } } }, + '#withStaticMixin':: d.fn(help='"The list of hosts to probe."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='static', type=d.T.array)]), + withStaticMixin(static): { spec+: { targets+: { staticConfig+: { static+: if std.isArray(v=static) then static else [static] } } } }, + }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when scraping the endpoint."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withInterval':: d.fn(help="\"Interval at which targets are probed using the configured prober.\\nIf not specified Prometheus' global scrape interval is used.\"", args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { spec+: { interval: interval } }, + '#withJobName':: d.fn(help='"The job name assigned to scraped metrics by default."', args=[d.arg(name='jobName', type=d.T.string)]), + withJobName(jobName): { spec+: { jobName: jobName } }, + '#withKeepDroppedTargets':: d.fn(help='"Per-scrape limit on the number of targets dropped by relabeling\\nthat will be kept in memory. 0 means no limit.\\n\\n\\nIt requires Prometheus >= v2.47.0."', args=[d.arg(name='keepDroppedTargets', type=d.T.integer)]), + withKeepDroppedTargets(keepDroppedTargets): { spec+: { keepDroppedTargets: keepDroppedTargets } }, + '#withLabelLimit':: d.fn(help='"Per-scrape limit on number of labels that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.27.0 and newer."', args=[d.arg(name='labelLimit', type=d.T.integer)]), + withLabelLimit(labelLimit): { spec+: { labelLimit: labelLimit } }, + '#withLabelNameLengthLimit':: d.fn(help='"Per-scrape limit on length of labels name that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.27.0 and newer."', args=[d.arg(name='labelNameLengthLimit', type=d.T.integer)]), + withLabelNameLengthLimit(labelNameLengthLimit): { spec+: { labelNameLengthLimit: labelNameLengthLimit } }, + '#withLabelValueLengthLimit':: d.fn(help='"Per-scrape limit on length of labels value that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.27.0 and newer."', args=[d.arg(name='labelValueLengthLimit', type=d.T.integer)]), + withLabelValueLengthLimit(labelValueLengthLimit): { spec+: { labelValueLengthLimit: labelValueLengthLimit } }, + '#withMetricRelabelings':: d.fn(help='"MetricRelabelConfigs to apply to samples before ingestion."', args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelings(metricRelabelings): { spec+: { metricRelabelings: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] } }, + '#withMetricRelabelingsMixin':: d.fn(help='"MetricRelabelConfigs to apply to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelingsMixin(metricRelabelings): { spec+: { metricRelabelings+: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] } }, + '#withModule':: d.fn(help='"The module to use for probing specifying how to probe the target.\\nExample module configuring in the blackbox exporter:\\nhttps://github.com/prometheus/blackbox_exporter/blob/master/example.yml"', args=[d.arg(name='module', type=d.T.string)]), + withModule(module): { spec+: { module: module } }, + '#withSampleLimit':: d.fn(help='"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted."', args=[d.arg(name='sampleLimit', type=d.T.integer)]), + withSampleLimit(sampleLimit): { spec+: { sampleLimit: sampleLimit } }, + '#withScrapeClass':: d.fn(help='"The scrape class to apply."', args=[d.arg(name='scrapeClass', type=d.T.string)]), + withScrapeClass(scrapeClass): { spec+: { scrapeClass: scrapeClass } }, + '#withScrapeProtocols':: d.fn(help='"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocols(scrapeProtocols): { spec+: { scrapeProtocols: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeProtocolsMixin':: d.fn(help='"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocolsMixin(scrapeProtocols): { spec+: { scrapeProtocols+: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeTimeout':: d.fn(help='"Timeout for scraping metrics from the Prometheus exporter.\\nIf not specified, the Prometheus global scrape timeout is used."', args=[d.arg(name='scrapeTimeout', type=d.T.string)]), + withScrapeTimeout(scrapeTimeout): { spec+: { scrapeTimeout: scrapeTimeout } }, + '#withTargetLimit':: d.fn(help='"TargetLimit defines a limit on the number of scraped targets that will be accepted."', args=[d.arg(name='targetLimit', type=d.T.integer)]), + withTargetLimit(targetLimit): { spec+: { targetLimit: targetLimit } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/_gen/monitoring/v1/prometheus.libsonnet b/0.14/_gen/monitoring/v1/prometheus.libsonnet new file mode 100644 index 0000000..5ddff2d --- /dev/null +++ b/0.14/_gen/monitoring/v1/prometheus.libsonnet @@ -0,0 +1,4345 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='prometheus', url='', help='"The `Prometheus` custom resource definition (CRD) defines a desired [Prometheus](https://prometheus.io/docs/prometheus) setup to run in a Kubernetes cluster. It allows to specify many options such as the number of replicas, persistent storage, and Alertmanagers where firing alerts should be sent and many more.\\n\\n\\nFor each `Prometheus` resource, the Operator deploys one or several `StatefulSet` objects in the same namespace. The number of StatefulSets is equal to the number of shards which is 1 by default.\\n\\n\\nThe resource defines via label and namespace selectors which `ServiceMonitor`, `PodMonitor`, `Probe` and `PrometheusRule` objects should be associated to the deployed Prometheus instances.\\n\\n\\nThe Operator continuously reconciles the scrape and rules configuration and a sidecar container running in the Prometheus pods triggers a reload of the configuration when needed."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of Prometheus', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1', + kind: 'Prometheus', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Specification of the desired behavior of the Prometheus cluster. More info:\\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"'), + spec: { + '#additionalAlertManagerConfigs':: d.obj(help='"AdditionalAlertManagerConfigs specifies a key of a Secret containing\\nadditional Prometheus Alertmanager configurations. The Alertmanager\\nconfigurations are appended to the configuration generated by the\\nPrometheus Operator. They must be formatted according to the official\\nPrometheus documentation:\\n\\n\\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config\\n\\n\\nThe user is responsible for making sure that the configurations are valid\\n\\n\\nNote that using this feature may expose the possibility to break\\nupgrades of Prometheus. It is advised to review Prometheus release notes\\nto ensure that no incompatible AlertManager configs are going to break\\nPrometheus after the upgrade."'), + additionalAlertManagerConfigs: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { additionalAlertManagerConfigs+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { additionalAlertManagerConfigs+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { additionalAlertManagerConfigs+: { optional: optional } } }, + }, + '#additionalAlertRelabelConfigs':: d.obj(help='"AdditionalAlertRelabelConfigs specifies a key of a Secret containing\\nadditional Prometheus alert relabel configurations. The alert relabel\\nconfigurations are appended to the configuration generated by the\\nPrometheus Operator. They must be formatted according to the official\\nPrometheus documentation:\\n\\n\\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\\n\\n\\nThe user is responsible for making sure that the configurations are valid\\n\\n\\nNote that using this feature may expose the possibility to break\\nupgrades of Prometheus. It is advised to review Prometheus release notes\\nto ensure that no incompatible alert relabel configs are going to break\\nPrometheus after the upgrade."'), + additionalAlertRelabelConfigs: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { additionalAlertRelabelConfigs+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { additionalAlertRelabelConfigs+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { additionalAlertRelabelConfigs+: { optional: optional } } }, + }, + '#additionalArgs':: d.obj(help="\"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\\n\\n\\nIt is intended for e.g. activating hidden flags which are not supported by\\nthe dedicated configuration options yet. The arguments are passed as-is to the\\nPrometheus container which may cause issues if they are invalid or not supported\\nby the given Prometheus version.\\n\\n\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument, the reconciliation will\\nfail and an error will be logged.\""), + additionalArgs: { + '#withName':: d.fn(help='"Name of the argument, e.g. \\"scrape.discovery-reload-interval\\"."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#additionalScrapeConfigs':: d.obj(help='"AdditionalScrapeConfigs allows specifying a key of a Secret containing\\nadditional Prometheus scrape configurations. Scrape configurations\\nspecified are appended to the configurations generated by the Prometheus\\nOperator. Job configurations specified must have the form as specified\\nin the official Prometheus documentation:\\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.\\nAs scrape configs are appended, the user is responsible to make sure it\\nis valid. Note that using this feature may expose the possibility to\\nbreak upgrades of Prometheus. It is advised to review Prometheus release\\nnotes to ensure that no incompatible scrape configs are going to break\\nPrometheus after the upgrade."'), + additionalScrapeConfigs: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { additionalScrapeConfigs+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { additionalScrapeConfigs+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { additionalScrapeConfigs+: { optional: optional } } }, + }, + '#affinity':: d.obj(help="\"Defines the Pods' affinity scheduling rules if specified.\""), + affinity: { + '#nodeAffinity':: d.obj(help='"Describes node affinity scheduling rules for the pod."'), + nodeAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#preference':: d.obj(help='"A node selector term, associated with the corresponding weight."'), + preference: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { preference+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { preference+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { preference+: { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { preference+: { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + }, + '#withWeight':: d.fn(help='"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to an update), the system\\nmay or may not try to eventually evict the pod from its node."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#nodeSelectorTerms':: d.obj(help='"Required. A list of node selector terms. The terms are ORed."'), + nodeSelectorTerms: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + }, + '#withNodeSelectorTerms':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTerms(nodeSelectorTerms): { spec+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } }, + '#withNodeSelectorTermsMixin':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTermsMixin(nodeSelectorTerms): { spec+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms+: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + '#podAffinity':: d.obj(help='"Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."'), + podAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm,\\nin the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + '#podAntiAffinity':: d.obj(help='"Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))."'), + podAntiAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm,\\nin the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + }, + '#alerting':: d.obj(help='"Defines the settings related to Alertmanager."'), + alerting: { + '#alertmanagers':: d.obj(help='"Alertmanager endpoints where Prometheus should send alerts to."'), + alertmanagers: { + '#alertRelabelings':: d.obj(help='"Relabeling configs applied before sending alerts to a specific Alertmanager.\\nIt requires Prometheus >= v2.51.0."'), + alertRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#authorization':: d.obj(help='"Authorization section for Alertmanager.\\n\\n\\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `sigv4`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth configuration for Alertmanager.\\n\\n\\nCannot be set at the same time as `bearerTokenFile`, `authorization` or `sigv4`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#relabelings':: d.obj(help='"Relabel configuration applied to the discovered Alertmanagers."'), + relabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#sigv4':: d.obj(help="\"Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\\n\\n\\nIt requires Prometheus \u003e= v2.48.0.\\n\\n\\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `authorization`.\""), + sigv4: { + '#accessKey':: d.obj(help='"AccessKey is the AWS API key. If not specified, the environment variable\\n`AWS_ACCESS_KEY_ID` is used."'), + accessKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { sigv4+: { accessKey+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { sigv4+: { accessKey+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { sigv4+: { accessKey+: { optional: optional } } }, + }, + '#secretKey':: d.obj(help='"SecretKey is the AWS API secret. If not specified, the environment\\nvariable `AWS_SECRET_ACCESS_KEY` is used."'), + secretKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { sigv4+: { secretKey+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { sigv4+: { secretKey+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { sigv4+: { secretKey+: { optional: optional } } }, + }, + '#withProfile':: d.fn(help='"Profile is the named AWS profile used to authenticate."', args=[d.arg(name='profile', type=d.T.string)]), + withProfile(profile): { sigv4+: { profile: profile } }, + '#withRegion':: d.fn(help='"Region is the AWS region. If blank, the region from the default credentials chain used."', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { sigv4+: { region: region } }, + '#withRoleArn':: d.fn(help='"RoleArn is the named AWS profile used to authenticate."', args=[d.arg(name='roleArn', type=d.T.string)]), + withRoleArn(roleArn): { sigv4+: { roleArn: roleArn } }, + }, + '#tlsConfig':: d.obj(help='"TLS Config to use for Alertmanager."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { tlsConfig+: { caFile: caFile } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { tlsConfig+: { certFile: certFile } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { tlsConfig+: { keyFile: keyFile } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withAlertRelabelings':: d.fn(help='"Relabeling configs applied before sending alerts to a specific Alertmanager.\\nIt requires Prometheus >= v2.51.0."', args=[d.arg(name='alertRelabelings', type=d.T.array)]), + withAlertRelabelings(alertRelabelings): { alertRelabelings: if std.isArray(v=alertRelabelings) then alertRelabelings else [alertRelabelings] }, + '#withAlertRelabelingsMixin':: d.fn(help='"Relabeling configs applied before sending alerts to a specific Alertmanager.\\nIt requires Prometheus >= v2.51.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='alertRelabelings', type=d.T.array)]), + withAlertRelabelingsMixin(alertRelabelings): { alertRelabelings+: if std.isArray(v=alertRelabelings) then alertRelabelings else [alertRelabelings] }, + '#withApiVersion':: d.fn(help='"Version of the Alertmanager API that Prometheus uses to send alerts.\\nIt can be \\"v1\\" or \\"v2\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { apiVersion: apiVersion }, + '#withBearerTokenFile':: d.fn(help='"File to read bearer token for Alertmanager.\\n\\n\\nCannot be set at the same time as `basicAuth`, `authorization`, or `sigv4`.\\n\\n\\nDeprecated: this will be removed in a future release. Prefer using `authorization`."', args=[d.arg(name='bearerTokenFile', type=d.T.string)]), + withBearerTokenFile(bearerTokenFile): { bearerTokenFile: bearerTokenFile }, + '#withEnableHttp2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHttp2', type=d.T.boolean)]), + withEnableHttp2(enableHttp2): { enableHttp2: enableHttp2 }, + '#withName':: d.fn(help='"Name of the Endpoints object in the namespace."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the Endpoints object.\\n\\n\\nIf not set, the object will be discovered in the namespace of the\\nPrometheus object."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + '#withPathPrefix':: d.fn(help='"Prefix for the HTTP path alerts are pushed to."', args=[d.arg(name='pathPrefix', type=d.T.string)]), + withPathPrefix(pathPrefix): { pathPrefix: pathPrefix }, + '#withPort':: d.fn(help='"Port on which the Alertmanager API is exposed."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { port: port }, + '#withRelabelings':: d.fn(help='"Relabel configuration applied to the discovered Alertmanagers."', args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelings(relabelings): { relabelings: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + '#withRelabelingsMixin':: d.fn(help='"Relabel configuration applied to the discovered Alertmanagers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelingsMixin(relabelings): { relabelings+: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + '#withScheme':: d.fn(help='"Scheme to use when firing alerts."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { scheme: scheme }, + '#withTimeout':: d.fn(help='"Timeout is a per-target Alertmanager timeout when pushing alerts."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { timeout: timeout }, + }, + '#withAlertmanagers':: d.fn(help='"Alertmanager endpoints where Prometheus should send alerts to."', args=[d.arg(name='alertmanagers', type=d.T.array)]), + withAlertmanagers(alertmanagers): { spec+: { alerting+: { alertmanagers: if std.isArray(v=alertmanagers) then alertmanagers else [alertmanagers] } } }, + '#withAlertmanagersMixin':: d.fn(help='"Alertmanager endpoints where Prometheus should send alerts to."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='alertmanagers', type=d.T.array)]), + withAlertmanagersMixin(alertmanagers): { spec+: { alerting+: { alertmanagers+: if std.isArray(v=alertmanagers) then alertmanagers else [alertmanagers] } } }, + }, + '#apiserverConfig':: d.obj(help="\"APIServerConfig allows specifying a host and auth methods to access the\\nKuberntees API server.\\nIf null, Prometheus is assumed to run inside of the cluster: it will\\ndiscover the API servers automatically and use the Pod's CA certificate\\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.\""), + apiserverConfig: { + '#authorization':: d.obj(help='"Authorization section for the API server.\\n\\n\\nCannot be set at the same time as `basicAuth`, `bearerToken`, or\\n`bearerTokenFile`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { authorization+: { credentials+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { authorization+: { credentials+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { authorization+: { credentials+: { optional: optional } } } } }, + }, + '#withCredentialsFile':: d.fn(help='"File to read a secret from, mutually exclusive with `credentials`."', args=[d.arg(name='credentialsFile', type=d.T.string)]), + withCredentialsFile(credentialsFile): { spec+: { apiserverConfig+: { authorization+: { credentialsFile: credentialsFile } } } }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { apiserverConfig+: { authorization+: { type: type } } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth configuration for the API server.\\n\\n\\nCannot be set at the same time as `authorization`, `bearerToken`, or\\n`bearerTokenFile`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { basicAuth+: { password+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { basicAuth+: { password+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { basicAuth+: { password+: { optional: optional } } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { basicAuth+: { username+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { basicAuth+: { username+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { basicAuth+: { username+: { optional: optional } } } } }, + }, + }, + '#tlsConfig':: d.obj(help='"TLS Config to use for the API server."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { spec+: { apiserverConfig+: { tlsConfig+: { caFile: caFile } } } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { spec+: { apiserverConfig+: { tlsConfig+: { certFile: certFile } } } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { apiserverConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { spec+: { apiserverConfig+: { tlsConfig+: { keyFile: keyFile } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { apiserverConfig+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { apiserverConfig+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { apiserverConfig+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withBearerToken':: d.fn(help="\"*Warning: this field shouldn't be used because the token value appears\\nin clear-text. Prefer using `authorization`.*\\n\\n\\nDeprecated: this will be removed in a future release.\"", args=[d.arg(name='bearerToken', type=d.T.string)]), + withBearerToken(bearerToken): { spec+: { apiserverConfig+: { bearerToken: bearerToken } } }, + '#withBearerTokenFile':: d.fn(help='"File to read bearer token for accessing apiserver.\\n\\n\\nCannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`.\\n\\n\\nDeprecated: this will be removed in a future release. Prefer using `authorization`."', args=[d.arg(name='bearerTokenFile', type=d.T.string)]), + withBearerTokenFile(bearerTokenFile): { spec+: { apiserverConfig+: { bearerTokenFile: bearerTokenFile } } }, + '#withHost':: d.fn(help='"Kubernetes API address consisting of a hostname or IP address followed\\nby an optional port number."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { spec+: { apiserverConfig+: { host: host } } }, + }, + '#arbitraryFSAccessThroughSMs':: d.obj(help="\"When true, ServiceMonitor, PodMonitor and Probe object are forbidden to\\nreference arbitrary files on the file system of the 'prometheus'\\ncontainer.\\nWhen a ServiceMonitor's endpoint specifies a `bearerTokenFile` value\\n(e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a\\nmalicious target can get access to the Prometheus service account's\\ntoken in the Prometheus' scrape request. Setting\\n`spec.arbitraryFSAccessThroughSM` to 'true' would prevent the attack.\\nUsers should instead provide the credentials using the\\n`spec.bearerTokenSecret` field.\""), + arbitraryFSAccessThroughSMs: { + '#withDeny':: d.fn(help='', args=[d.arg(name='deny', type=d.T.boolean)]), + withDeny(deny): { spec+: { arbitraryFSAccessThroughSMs+: { deny: deny } } }, + }, + '#containers':: d.obj(help='"Containers allows injecting additional containers or modifying operator\\ngenerated containers. This can be used to allow adding an authentication\\nproxy to the Pods or to change the behavior of an operator generated\\ncontainer. Containers described here modify an operator generated\\ncontainer if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of containers managed by the operator are:\\n* `prometheus`\\n* `config-reloader`\\n* `thanos-sidecar`\\n\\n\\nOverriding containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."'), + containers: { + '#env':: d.obj(help='"List of environment variables to set in the container.\\nCannot be updated."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded\\nusing the previously defined environment variables in the container and\\nany service environment variables. If a variable cannot be resolved,\\nthe reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\\n\\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\".\\nEscaped references will never be expanded, regardless of whether the variable\\nexists or not.\\nDefaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#envFrom':: d.obj(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."'), + envFrom: { + '#configMapRef':: d.obj(help='"The ConfigMap to select from"'), + configMapRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMapRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMapRef+: { optional: optional } }, + }, + '#secretRef':: d.obj(help='"The Secret to select from"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretRef+: { optional: optional } }, + }, + '#withPrefix':: d.fn(help='"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { prefix: prefix }, + }, + '#lifecycle':: d.obj(help='"Actions that the management system should take in response to container lifecycle events.\\nCannot be updated."'), + lifecycle: { + '#postStart':: d.obj(help='"PostStart is called immediately after a container is created. If the handler fails,\\nthe container is terminated and restarted according to its restart policy.\\nOther management of the container blocks until the hook completes.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"'), + postStart: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { postStart+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { postStart+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { postStart+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { postStart+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { postStart+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { tcpSocket+: { port: port } } } }, + }, + }, + '#preStop':: d.obj(help="\"PreStop is called immediately before a container is terminated due to an\\nAPI request or management event such as liveness/startup probe failure,\\npreemption, resource contention, etc. The handler is not called if the\\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\\nPreStop hook is executed. Regardless of the outcome of the handler, the\\ncontainer will eventually terminate within the Pod's termination grace\\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\\nor until the termination grace period is reached.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\""), + preStop: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { preStop+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { preStop+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { preStop+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { preStop+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { preStop+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { tcpSocket+: { port: port } } } }, + }, + }, + }, + '#livenessProbe':: d.obj(help='"Periodic probe of container liveness.\\nContainer will be restarted if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + livenessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { livenessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { livenessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { livenessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { livenessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { livenessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { livenessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { livenessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { livenessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { livenessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { livenessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { livenessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { livenessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#ports':: d.obj(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."'), + ports: { + '#withContainerPort':: d.fn(help="\"Number of port to expose on the pod's IP address.\\nThis must be a valid port number, 0 \u003c x \u003c 65536.\"", args=[d.arg(name='containerPort', type=d.T.integer)]), + withContainerPort(containerPort): { containerPort: containerPort }, + '#withHostIP':: d.fn(help='"What host IP to bind the external port to."', args=[d.arg(name='hostIP', type=d.T.string)]), + withHostIP(hostIP): { hostIP: hostIP }, + '#withHostPort':: d.fn(help='"Number of port to expose on the host.\\nIf specified, this must be a valid port number, 0 < x < 65536.\\nIf HostNetwork is specified, this must match ContainerPort.\\nMost containers do not need this."', args=[d.arg(name='hostPort', type=d.T.integer)]), + withHostPort(hostPort): { hostPort: hostPort }, + '#withName':: d.fn(help='"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\\nnamed port in a pod must have a unique name. Name for the port that can be\\nreferred to by services."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withProtocol':: d.fn(help='"Protocol for port. Must be UDP, TCP, or SCTP.\\nDefaults to \\"TCP\\"."', args=[d.arg(name='protocol', type=d.T.string)]), + withProtocol(protocol): { protocol: protocol }, + }, + '#readinessProbe':: d.obj(help='"Periodic probe of container service readiness.\\nContainer will be removed from service endpoints if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + readinessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { readinessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { readinessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { readinessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { readinessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { readinessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { readinessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { readinessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { readinessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { readinessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { readinessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { readinessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { readinessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#resizePolicy':: d.obj(help='"Resources resize policy for the container."'), + resizePolicy: { + '#withResourceName':: d.fn(help='"Name of the resource to which this resource resize policy applies.\\nSupported values: cpu, memory."', args=[d.arg(name='resourceName', type=d.T.string)]), + withResourceName(resourceName): { resourceName: resourceName }, + '#withRestartPolicy':: d.fn(help='"Restart policy to apply when specified resource is resized.\\nIf not specified, it defaults to NotRequired."', args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + }, + '#resources':: d.obj(help='"Compute Resources required by this container.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { resources+: { limits: limits } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { resources+: { limits+: limits } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { resources+: { requests: requests } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { resources+: { requests+: requests } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with.\\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#appArmorProfile':: d.obj(help="\"appArmorProfile is the AppArmor options to use by this container. If set, this profile\\noverrides the pod's appArmorProfile.\\nNote that this field cannot be set when spec.os.name is windows.\""), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { appArmorProfile+: { type: type } } }, + }, + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers.\\nDefaults to the default set of capabilities granted by the container runtime.\\nNote that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { securityContext+: { seLinuxOptions+: { level: level } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { securityContext+: { seLinuxOptions+: { role: role } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seLinuxOptions+: { type: type } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { securityContext+: { seLinuxOptions+: { user: user } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are\\nprovided at both the pod & container level, the container options\\noverride the pod options.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seccompProfile+: { type: type } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers.\\nIf unspecified, the options from the PodSecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more\\nprivileges than its parent process. This bool directly controls if\\nthe no_new_privs flag will be set on the container process.\\nAllowPrivilegeEscalation is true always when the container is:\\n1) run as Privileged\\n2) has CAP_SYS_ADMIN\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode.\\nProcesses in privileged containers are essentially equivalent to root on the host.\\nDefaults to false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { securityContext+: { privileged: privileged } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers.\\nThe default is DefaultProcMount which uses the container runtime defaults for\\nreadonly paths and masked paths.\\nThis requires the ProcMountType feature flag to be enabled.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { securityContext+: { procMount: procMount } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem.\\nDefault is false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { securityContext+: { runAsGroup: runAsGroup } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { securityContext+: { runAsNonRoot: runAsNonRoot } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { securityContext+: { runAsUser: runAsUser } }, + }, + '#startupProbe':: d.obj(help="\"StartupProbe indicates that the Pod has successfully initialized.\\nIf specified, no other probes are executed until this completes successfully.\\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\\nThis cannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\""), + startupProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { startupProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { startupProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { startupProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { startupProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { startupProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { startupProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { startupProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { startupProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { startupProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { startupProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { startupProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { startupProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#volumeDevices':: d.obj(help='"volumeDevices is the list of block devices to be used by the container."'), + volumeDevices: { + '#withDevicePath':: d.fn(help='"devicePath is the path inside of the container that the device will be mapped to."', args=[d.arg(name='devicePath', type=d.T.string)]), + withDevicePath(devicePath): { devicePath: devicePath }, + '#withName':: d.fn(help='"name must match the name of a persistentVolumeClaim in the pod"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#volumeMounts':: d.obj(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withArgs':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='args', type=d.T.array)]), + withArgs(args): { args: if std.isArray(v=args) then args else [args] }, + '#withArgsMixin':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='args', type=d.T.array)]), + withArgsMixin(args): { args+: if std.isArray(v=args) then args else [args] }, + '#withCommand':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { command: if std.isArray(v=command) then command else [command] }, + '#withCommandMixin':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { command+: if std.isArray(v=command) then command else [command] }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { env: if std.isArray(v=env) then env else [env] }, + '#withEnvFrom':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFrom(envFrom): { envFrom: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvFromMixin':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFromMixin(envFrom): { envFrom+: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { env+: if std.isArray(v=env) then env else [env] }, + '#withImage':: d.fn(help='"Container image name.\\nMore info: https://kubernetes.io/docs/concepts/containers/images\\nThis field is optional to allow higher level config management to default or override\\ncontainer images in workload controllers like Deployments and StatefulSets."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { image: image }, + '#withImagePullPolicy':: d.fn(help='"Image pull policy.\\nOne of Always, Never, IfNotPresent.\\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images"', args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { imagePullPolicy: imagePullPolicy }, + '#withName':: d.fn(help='"Name of the container specified as a DNS_LABEL.\\nEach container in a pod must have a unique name (DNS_LABEL).\\nCannot be updated."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPorts':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."', args=[d.arg(name='ports', type=d.T.array)]), + withPorts(ports): { ports: if std.isArray(v=ports) then ports else [ports] }, + '#withPortsMixin':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ports', type=d.T.array)]), + withPortsMixin(ports): { ports+: if std.isArray(v=ports) then ports else [ports] }, + '#withResizePolicy':: d.fn(help='"Resources resize policy for the container."', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicy(resizePolicy): { resizePolicy: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withResizePolicyMixin':: d.fn(help='"Resources resize policy for the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicyMixin(resizePolicy): { resizePolicy+: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withRestartPolicy':: d.fn(help="\"RestartPolicy defines the restart behavior of individual containers in a pod.\\nThis field may only be set for init containers, and the only allowed value is \\\"Always\\\".\\nFor non-init containers or when this field is not specified,\\nthe restart behavior is defined by the Pod's restart policy and the container type.\\nSetting the RestartPolicy as \\\"Always\\\" for the init container will have the following effect:\\nthis init container will be continually restarted on\\nexit until all regular containers have terminated. Once all regular\\ncontainers have completed, all init containers with restartPolicy \\\"Always\\\"\\nwill be shut down. This lifecycle differs from normal init containers and\\nis often referred to as a \\\"sidecar\\\" container. Although this init\\ncontainer still starts in the init container sequence, it does not wait\\nfor the container to complete before proceeding to the next init\\ncontainer. Instead, the next init container starts immediately after this\\ninit container is started, or after any startupProbe has successfully\\ncompleted.\"", args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + '#withStdin':: d.fn(help='"Whether this container should allocate a buffer for stdin in the container runtime. If this\\nis not set, reads from stdin in the container will always result in EOF.\\nDefault is false."', args=[d.arg(name='stdin', type=d.T.boolean)]), + withStdin(stdin): { stdin: stdin }, + '#withStdinOnce':: d.fn(help='"Whether the container runtime should close the stdin channel after it has been opened by\\na single attach. When stdin is true the stdin stream will remain open across multiple attach\\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\\nat which time stdin is closed and remains closed until the container is restarted. If this\\nflag is false, a container processes that reads from stdin will never receive an EOF.\\nDefault is false"', args=[d.arg(name='stdinOnce', type=d.T.boolean)]), + withStdinOnce(stdinOnce): { stdinOnce: stdinOnce }, + '#withTerminationMessagePath':: d.fn(help="\"Optional: Path at which the file to which the container's termination message\\nwill be written is mounted into the container's filesystem.\\nMessage written is intended to be brief final status, such as an assertion failure message.\\nWill be truncated by the node if greater than 4096 bytes. The total message length across\\nall containers will be limited to 12kb.\\nDefaults to /dev/termination-log.\\nCannot be updated.\"", args=[d.arg(name='terminationMessagePath', type=d.T.string)]), + withTerminationMessagePath(terminationMessagePath): { terminationMessagePath: terminationMessagePath }, + '#withTerminationMessagePolicy':: d.fn(help='"Indicate how the termination message should be populated. File will use the contents of\\nterminationMessagePath to populate the container status message on both success and failure.\\nFallbackToLogsOnError will use the last chunk of container log output if the termination\\nmessage file is empty and the container exited with an error.\\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\\nDefaults to File.\\nCannot be updated."', args=[d.arg(name='terminationMessagePolicy', type=d.T.string)]), + withTerminationMessagePolicy(terminationMessagePolicy): { terminationMessagePolicy: terminationMessagePolicy }, + '#withTty':: d.fn(help="\"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\\nDefault is false.\"", args=[d.arg(name='tty', type=d.T.boolean)]), + withTty(tty): { tty: tty }, + '#withVolumeDevices':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevices(volumeDevices): { volumeDevices: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeDevicesMixin':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevicesMixin(volumeDevices): { volumeDevices+: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeMounts':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withVolumeMountsMixin':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withWorkingDir':: d.fn(help="\"Container's working directory.\\nIf not specified, the container runtime's default will be used, which\\nmight be configured in the container image.\\nCannot be updated.\"", args=[d.arg(name='workingDir', type=d.T.string)]), + withWorkingDir(workingDir): { workingDir: workingDir }, + }, + '#excludedFromEnforcement':: d.obj(help='"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\\nto be excluded from enforcing a namespace label of origin.\\n\\n\\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true."'), + excludedFromEnforcement: { + '#withGroup':: d.fn(help='"Group of the referent. When not specified, it defaults to `monitoring.coreos.com`"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { group: group }, + '#withName':: d.fn(help='"Name of the referent. When not set, all resources in the namespace are matched."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent.\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + '#withResource':: d.fn(help='"Resource of the referent."', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resource: resource }, + }, + '#exemplars':: d.obj(help='"Exemplars related settings that are runtime reloadable.\\nIt requires to enable the `exemplar-storage` feature flag to be effective."'), + exemplars: { + '#withMaxSize':: d.fn(help='"Maximum number of exemplars stored in memory for all series.\\n\\n\\nexemplar-storage itself must be enabled using the `spec.enableFeature`\\noption for exemplars to be scraped in the first place.\\n\\n\\nIf not set, Prometheus uses its default value. A value of zero or less\\nthan zero disables the storage."', args=[d.arg(name='maxSize', type=d.T.integer)]), + withMaxSize(maxSize): { spec+: { exemplars+: { maxSize: maxSize } } }, + }, + '#hostAliases':: d.obj(help="\"Optional list of hosts and IPs that will be injected into the Pod's\\nhosts file if specified.\""), + hostAliases: { + '#withHostnames':: d.fn(help='"Hostnames for the above IP address."', args=[d.arg(name='hostnames', type=d.T.array)]), + withHostnames(hostnames): { hostnames: if std.isArray(v=hostnames) then hostnames else [hostnames] }, + '#withHostnamesMixin':: d.fn(help='"Hostnames for the above IP address."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='hostnames', type=d.T.array)]), + withHostnamesMixin(hostnames): { hostnames+: if std.isArray(v=hostnames) then hostnames else [hostnames] }, + '#withIp':: d.fn(help='"IP address of the host file entry."', args=[d.arg(name='ip', type=d.T.string)]), + withIp(ip): { ip: ip }, + }, + '#imagePullSecrets':: d.obj(help='"An optional list of references to Secrets in the same namespace\\nto use for pulling images from registries.\\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"'), + imagePullSecrets: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#initContainers':: d.obj(help='"InitContainers allows injecting initContainers to the Pod definition. Those\\ncan be used to e.g. fetch secrets for injection into the Prometheus\\nconfiguration from external sources. Any errors during the execution of\\nan initContainer will lead to a restart of the Pod. More info:\\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nInitContainers described here modify an operator generated init\\ncontainers if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of init container name managed by the operator are:\\n* `init-config-reloader`.\\n\\n\\nOverriding init containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."'), + initContainers: { + '#env':: d.obj(help='"List of environment variables to set in the container.\\nCannot be updated."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded\\nusing the previously defined environment variables in the container and\\nany service environment variables. If a variable cannot be resolved,\\nthe reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\\n\\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\".\\nEscaped references will never be expanded, regardless of whether the variable\\nexists or not.\\nDefaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#envFrom':: d.obj(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."'), + envFrom: { + '#configMapRef':: d.obj(help='"The ConfigMap to select from"'), + configMapRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMapRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMapRef+: { optional: optional } }, + }, + '#secretRef':: d.obj(help='"The Secret to select from"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretRef+: { optional: optional } }, + }, + '#withPrefix':: d.fn(help='"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { prefix: prefix }, + }, + '#lifecycle':: d.obj(help='"Actions that the management system should take in response to container lifecycle events.\\nCannot be updated."'), + lifecycle: { + '#postStart':: d.obj(help='"PostStart is called immediately after a container is created. If the handler fails,\\nthe container is terminated and restarted according to its restart policy.\\nOther management of the container blocks until the hook completes.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"'), + postStart: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { postStart+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { postStart+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { postStart+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { postStart+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { postStart+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { tcpSocket+: { port: port } } } }, + }, + }, + '#preStop':: d.obj(help="\"PreStop is called immediately before a container is terminated due to an\\nAPI request or management event such as liveness/startup probe failure,\\npreemption, resource contention, etc. The handler is not called if the\\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\\nPreStop hook is executed. Regardless of the outcome of the handler, the\\ncontainer will eventually terminate within the Pod's termination grace\\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\\nor until the termination grace period is reached.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\""), + preStop: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { preStop+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { preStop+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { preStop+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { preStop+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { preStop+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { tcpSocket+: { port: port } } } }, + }, + }, + }, + '#livenessProbe':: d.obj(help='"Periodic probe of container liveness.\\nContainer will be restarted if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + livenessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { livenessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { livenessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { livenessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { livenessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { livenessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { livenessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { livenessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { livenessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { livenessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { livenessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { livenessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { livenessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#ports':: d.obj(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."'), + ports: { + '#withContainerPort':: d.fn(help="\"Number of port to expose on the pod's IP address.\\nThis must be a valid port number, 0 \u003c x \u003c 65536.\"", args=[d.arg(name='containerPort', type=d.T.integer)]), + withContainerPort(containerPort): { containerPort: containerPort }, + '#withHostIP':: d.fn(help='"What host IP to bind the external port to."', args=[d.arg(name='hostIP', type=d.T.string)]), + withHostIP(hostIP): { hostIP: hostIP }, + '#withHostPort':: d.fn(help='"Number of port to expose on the host.\\nIf specified, this must be a valid port number, 0 < x < 65536.\\nIf HostNetwork is specified, this must match ContainerPort.\\nMost containers do not need this."', args=[d.arg(name='hostPort', type=d.T.integer)]), + withHostPort(hostPort): { hostPort: hostPort }, + '#withName':: d.fn(help='"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\\nnamed port in a pod must have a unique name. Name for the port that can be\\nreferred to by services."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withProtocol':: d.fn(help='"Protocol for port. Must be UDP, TCP, or SCTP.\\nDefaults to \\"TCP\\"."', args=[d.arg(name='protocol', type=d.T.string)]), + withProtocol(protocol): { protocol: protocol }, + }, + '#readinessProbe':: d.obj(help='"Periodic probe of container service readiness.\\nContainer will be removed from service endpoints if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + readinessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { readinessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { readinessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { readinessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { readinessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { readinessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { readinessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { readinessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { readinessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { readinessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { readinessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { readinessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { readinessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#resizePolicy':: d.obj(help='"Resources resize policy for the container."'), + resizePolicy: { + '#withResourceName':: d.fn(help='"Name of the resource to which this resource resize policy applies.\\nSupported values: cpu, memory."', args=[d.arg(name='resourceName', type=d.T.string)]), + withResourceName(resourceName): { resourceName: resourceName }, + '#withRestartPolicy':: d.fn(help='"Restart policy to apply when specified resource is resized.\\nIf not specified, it defaults to NotRequired."', args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + }, + '#resources':: d.obj(help='"Compute Resources required by this container.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { resources+: { limits: limits } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { resources+: { limits+: limits } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { resources+: { requests: requests } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { resources+: { requests+: requests } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with.\\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#appArmorProfile':: d.obj(help="\"appArmorProfile is the AppArmor options to use by this container. If set, this profile\\noverrides the pod's appArmorProfile.\\nNote that this field cannot be set when spec.os.name is windows.\""), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { appArmorProfile+: { type: type } } }, + }, + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers.\\nDefaults to the default set of capabilities granted by the container runtime.\\nNote that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { securityContext+: { seLinuxOptions+: { level: level } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { securityContext+: { seLinuxOptions+: { role: role } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seLinuxOptions+: { type: type } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { securityContext+: { seLinuxOptions+: { user: user } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are\\nprovided at both the pod & container level, the container options\\noverride the pod options.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seccompProfile+: { type: type } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers.\\nIf unspecified, the options from the PodSecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more\\nprivileges than its parent process. This bool directly controls if\\nthe no_new_privs flag will be set on the container process.\\nAllowPrivilegeEscalation is true always when the container is:\\n1) run as Privileged\\n2) has CAP_SYS_ADMIN\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode.\\nProcesses in privileged containers are essentially equivalent to root on the host.\\nDefaults to false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { securityContext+: { privileged: privileged } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers.\\nThe default is DefaultProcMount which uses the container runtime defaults for\\nreadonly paths and masked paths.\\nThis requires the ProcMountType feature flag to be enabled.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { securityContext+: { procMount: procMount } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem.\\nDefault is false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { securityContext+: { runAsGroup: runAsGroup } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { securityContext+: { runAsNonRoot: runAsNonRoot } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { securityContext+: { runAsUser: runAsUser } }, + }, + '#startupProbe':: d.obj(help="\"StartupProbe indicates that the Pod has successfully initialized.\\nIf specified, no other probes are executed until this completes successfully.\\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\\nThis cannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\""), + startupProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { startupProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { startupProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { startupProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { startupProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { startupProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { startupProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { startupProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { startupProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { startupProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { startupProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { startupProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { startupProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#volumeDevices':: d.obj(help='"volumeDevices is the list of block devices to be used by the container."'), + volumeDevices: { + '#withDevicePath':: d.fn(help='"devicePath is the path inside of the container that the device will be mapped to."', args=[d.arg(name='devicePath', type=d.T.string)]), + withDevicePath(devicePath): { devicePath: devicePath }, + '#withName':: d.fn(help='"name must match the name of a persistentVolumeClaim in the pod"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#volumeMounts':: d.obj(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withArgs':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='args', type=d.T.array)]), + withArgs(args): { args: if std.isArray(v=args) then args else [args] }, + '#withArgsMixin':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='args', type=d.T.array)]), + withArgsMixin(args): { args+: if std.isArray(v=args) then args else [args] }, + '#withCommand':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { command: if std.isArray(v=command) then command else [command] }, + '#withCommandMixin':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { command+: if std.isArray(v=command) then command else [command] }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { env: if std.isArray(v=env) then env else [env] }, + '#withEnvFrom':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFrom(envFrom): { envFrom: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvFromMixin':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFromMixin(envFrom): { envFrom+: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { env+: if std.isArray(v=env) then env else [env] }, + '#withImage':: d.fn(help='"Container image name.\\nMore info: https://kubernetes.io/docs/concepts/containers/images\\nThis field is optional to allow higher level config management to default or override\\ncontainer images in workload controllers like Deployments and StatefulSets."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { image: image }, + '#withImagePullPolicy':: d.fn(help='"Image pull policy.\\nOne of Always, Never, IfNotPresent.\\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images"', args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { imagePullPolicy: imagePullPolicy }, + '#withName':: d.fn(help='"Name of the container specified as a DNS_LABEL.\\nEach container in a pod must have a unique name (DNS_LABEL).\\nCannot be updated."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPorts':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."', args=[d.arg(name='ports', type=d.T.array)]), + withPorts(ports): { ports: if std.isArray(v=ports) then ports else [ports] }, + '#withPortsMixin':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ports', type=d.T.array)]), + withPortsMixin(ports): { ports+: if std.isArray(v=ports) then ports else [ports] }, + '#withResizePolicy':: d.fn(help='"Resources resize policy for the container."', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicy(resizePolicy): { resizePolicy: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withResizePolicyMixin':: d.fn(help='"Resources resize policy for the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicyMixin(resizePolicy): { resizePolicy+: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withRestartPolicy':: d.fn(help="\"RestartPolicy defines the restart behavior of individual containers in a pod.\\nThis field may only be set for init containers, and the only allowed value is \\\"Always\\\".\\nFor non-init containers or when this field is not specified,\\nthe restart behavior is defined by the Pod's restart policy and the container type.\\nSetting the RestartPolicy as \\\"Always\\\" for the init container will have the following effect:\\nthis init container will be continually restarted on\\nexit until all regular containers have terminated. Once all regular\\ncontainers have completed, all init containers with restartPolicy \\\"Always\\\"\\nwill be shut down. This lifecycle differs from normal init containers and\\nis often referred to as a \\\"sidecar\\\" container. Although this init\\ncontainer still starts in the init container sequence, it does not wait\\nfor the container to complete before proceeding to the next init\\ncontainer. Instead, the next init container starts immediately after this\\ninit container is started, or after any startupProbe has successfully\\ncompleted.\"", args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + '#withStdin':: d.fn(help='"Whether this container should allocate a buffer for stdin in the container runtime. If this\\nis not set, reads from stdin in the container will always result in EOF.\\nDefault is false."', args=[d.arg(name='stdin', type=d.T.boolean)]), + withStdin(stdin): { stdin: stdin }, + '#withStdinOnce':: d.fn(help='"Whether the container runtime should close the stdin channel after it has been opened by\\na single attach. When stdin is true the stdin stream will remain open across multiple attach\\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\\nat which time stdin is closed and remains closed until the container is restarted. If this\\nflag is false, a container processes that reads from stdin will never receive an EOF.\\nDefault is false"', args=[d.arg(name='stdinOnce', type=d.T.boolean)]), + withStdinOnce(stdinOnce): { stdinOnce: stdinOnce }, + '#withTerminationMessagePath':: d.fn(help="\"Optional: Path at which the file to which the container's termination message\\nwill be written is mounted into the container's filesystem.\\nMessage written is intended to be brief final status, such as an assertion failure message.\\nWill be truncated by the node if greater than 4096 bytes. The total message length across\\nall containers will be limited to 12kb.\\nDefaults to /dev/termination-log.\\nCannot be updated.\"", args=[d.arg(name='terminationMessagePath', type=d.T.string)]), + withTerminationMessagePath(terminationMessagePath): { terminationMessagePath: terminationMessagePath }, + '#withTerminationMessagePolicy':: d.fn(help='"Indicate how the termination message should be populated. File will use the contents of\\nterminationMessagePath to populate the container status message on both success and failure.\\nFallbackToLogsOnError will use the last chunk of container log output if the termination\\nmessage file is empty and the container exited with an error.\\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\\nDefaults to File.\\nCannot be updated."', args=[d.arg(name='terminationMessagePolicy', type=d.T.string)]), + withTerminationMessagePolicy(terminationMessagePolicy): { terminationMessagePolicy: terminationMessagePolicy }, + '#withTty':: d.fn(help="\"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\\nDefault is false.\"", args=[d.arg(name='tty', type=d.T.boolean)]), + withTty(tty): { tty: tty }, + '#withVolumeDevices':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevices(volumeDevices): { volumeDevices: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeDevicesMixin':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevicesMixin(volumeDevices): { volumeDevices+: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeMounts':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withVolumeMountsMixin':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withWorkingDir':: d.fn(help="\"Container's working directory.\\nIf not specified, the container runtime's default will be used, which\\nmight be configured in the container image.\\nCannot be updated.\"", args=[d.arg(name='workingDir', type=d.T.string)]), + withWorkingDir(workingDir): { workingDir: workingDir }, + }, + '#persistentVolumeClaimRetentionPolicy':: d.obj(help='"The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\\nThe default behavior is all PVCs are retained.\\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\\nIt requires enabling the StatefulSetAutoDeletePVC feature gate."'), + persistentVolumeClaimRetentionPolicy: { + '#withWhenDeleted':: d.fn(help='"WhenDeleted specifies what happens to PVCs created from StatefulSet\\nVolumeClaimTemplates when the StatefulSet is deleted. The default policy\\nof `Retain` causes PVCs to not be affected by StatefulSet deletion. The\\n`Delete` policy causes those PVCs to be deleted."', args=[d.arg(name='whenDeleted', type=d.T.string)]), + withWhenDeleted(whenDeleted): { spec+: { persistentVolumeClaimRetentionPolicy+: { whenDeleted: whenDeleted } } }, + '#withWhenScaled':: d.fn(help='"WhenScaled specifies what happens to PVCs created from StatefulSet\\nVolumeClaimTemplates when the StatefulSet is scaled down. The default\\npolicy of `Retain` causes PVCs to not be affected by a scaledown. The\\n`Delete` policy causes the associated PVCs for any excess pods above\\nthe replica count to be deleted."', args=[d.arg(name='whenScaled', type=d.T.string)]), + withWhenScaled(whenScaled): { spec+: { persistentVolumeClaimRetentionPolicy+: { whenScaled: whenScaled } } }, + }, + '#podMetadata':: d.obj(help='"PodMetadata configures labels and annotations which are propagated to the Prometheus pods.\\n\\n\\nThe following items are reserved and cannot be overridden:\\n* \\"prometheus\\" label, set to the name of the Prometheus object.\\n* \\"app.kubernetes.io/instance\\" label, set to the name of the Prometheus object.\\n* \\"app.kubernetes.io/managed-by\\" label, set to \\"prometheus-operator\\".\\n* \\"app.kubernetes.io/name\\" label, set to \\"prometheus\\".\\n* \\"app.kubernetes.io/version\\" label, set to the Prometheus version.\\n* \\"operator.prometheus.io/name\\" label, set to the name of the Prometheus object.\\n* \\"operator.prometheus.io/shard\\" label, set to the shard number of the Prometheus object.\\n* \\"kubectl.kubernetes.io/default-container\\" annotation, set to \\"prometheus\\"."'), + podMetadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { podMetadata+: { annotations: annotations } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { podMetadata+: { annotations+: annotations } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { podMetadata+: { labels: labels } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { podMetadata+: { labels+: labels } } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although\\nsome resources may allow a client to request the generation of an appropriate name\\nautomatically. Name is primarily intended for creation idempotence and configuration\\ndefinition.\\nCannot be updated.\\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { podMetadata+: { name: name } } }, + }, + '#podMonitorNamespaceSelector':: d.obj(help='"Namespaces to match for PodMonitors discovery. An empty label selector\\nmatches all namespaces. A null label selector (default value) matches the current\\nnamespace only."'), + podMonitorNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { podMonitorNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { podMonitorNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { podMonitorNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { podMonitorNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#podMonitorSelector':: d.obj(help="\"PodMonitors to be selected for target discovery. An empty label selector\\nmatches all objects. A null label selector matches no objects.\\n\\n\\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\\nThe Prometheus operator will ensure that the Prometheus configuration's\\nSecret exists, but it is the responsibility of the user to provide the raw\\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\\nThis behavior is *deprecated* and will be removed in the next major version\\nof the custom resource definition. It is recommended to use\\n`spec.additionalScrapeConfigs` instead.\""), + podMonitorSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { podMonitorSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { podMonitorSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { podMonitorSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { podMonitorSelector+: { matchLabels+: matchLabels } } }, + }, + '#probeNamespaceSelector':: d.obj(help='"Namespaces to match for Probe discovery. An empty label\\nselector matches all namespaces. A null label selector matches the\\ncurrent namespace only."'), + probeNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { probeNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { probeNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { probeNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { probeNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#probeSelector':: d.obj(help="\"Probes to be selected for target discovery. An empty label selector\\nmatches all objects. A null label selector matches no objects.\\n\\n\\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\\nThe Prometheus operator will ensure that the Prometheus configuration's\\nSecret exists, but it is the responsibility of the user to provide the raw\\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\\nThis behavior is *deprecated* and will be removed in the next major version\\nof the custom resource definition. It is recommended to use\\n`spec.additionalScrapeConfigs` instead.\""), + probeSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { probeSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { probeSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { probeSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { probeSelector+: { matchLabels+: matchLabels } } }, + }, + '#prometheusRulesExcludedFromEnforce':: d.obj(help="\"Defines the list of PrometheusRule objects to which the namespace label\\nenforcement doesn't apply.\\nThis is only relevant when `spec.enforcedNamespaceLabel` is set to true.\\nDeprecated: use `spec.excludedFromEnforcement` instead.\""), + prometheusRulesExcludedFromEnforce: { + '#withRuleName':: d.fn(help='"Name of the excluded PrometheusRule object."', args=[d.arg(name='ruleName', type=d.T.string)]), + withRuleName(ruleName): { ruleName: ruleName }, + '#withRuleNamespace':: d.fn(help='"Namespace of the excluded PrometheusRule object."', args=[d.arg(name='ruleNamespace', type=d.T.string)]), + withRuleNamespace(ruleNamespace): { ruleNamespace: ruleNamespace }, + }, + '#query':: d.obj(help='"QuerySpec defines the configuration of the Promethus query service."'), + query: { + '#withLookbackDelta':: d.fn(help='"The delta difference allowed for retrieving metrics during expression evaluations."', args=[d.arg(name='lookbackDelta', type=d.T.string)]), + withLookbackDelta(lookbackDelta): { spec+: { query+: { lookbackDelta: lookbackDelta } } }, + '#withMaxConcurrency':: d.fn(help='"Number of concurrent queries that can be run at once."', args=[d.arg(name='maxConcurrency', type=d.T.integer)]), + withMaxConcurrency(maxConcurrency): { spec+: { query+: { maxConcurrency: maxConcurrency } } }, + '#withMaxSamples':: d.fn(help='"Maximum number of samples a single query can load into memory. Note that\\nqueries will fail if they would load more samples than this into memory,\\nso this also limits the number of samples a query can return."', args=[d.arg(name='maxSamples', type=d.T.integer)]), + withMaxSamples(maxSamples): { spec+: { query+: { maxSamples: maxSamples } } }, + '#withTimeout':: d.fn(help='"Maximum time a query may take before being aborted."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { query+: { timeout: timeout } } }, + }, + '#remoteRead':: d.obj(help='"Defines the list of remote read configurations."'), + remoteRead: { + '#authorization':: d.obj(help='"Authorization section for the URL.\\n\\n\\nIt requires Prometheus >= v2.26.0.\\n\\n\\nCannot be set at the same time as `basicAuth`, or `oauth2`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withCredentialsFile':: d.fn(help='"File to read a secret from, mutually exclusive with `credentials`."', args=[d.arg(name='credentialsFile', type=d.T.string)]), + withCredentialsFile(credentialsFile): { authorization+: { credentialsFile: credentialsFile } }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth configuration for the URL.\\n\\n\\nCannot be set at the same time as `authorization`, or `oauth2`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#oauth2':: d.obj(help='"OAuth2 configuration for the URL.\\n\\n\\nIt requires Prometheus >= v2.27.0.\\n\\n\\nCannot be set at the same time as `authorization`, or `basicAuth`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS Config to use for the URL."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { tlsConfig+: { caFile: caFile } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { tlsConfig+: { certFile: certFile } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { tlsConfig+: { keyFile: keyFile } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withBearerToken':: d.fn(help="\"*Warning: this field shouldn't be used because the token value appears\\nin clear-text. Prefer using `authorization`.*\\n\\n\\nDeprecated: this will be removed in a future release.\"", args=[d.arg(name='bearerToken', type=d.T.string)]), + withBearerToken(bearerToken): { bearerToken: bearerToken }, + '#withBearerTokenFile':: d.fn(help='"File from which to read the bearer token for the URL.\\n\\n\\nDeprecated: this will be removed in a future release. Prefer using `authorization`."', args=[d.arg(name='bearerTokenFile', type=d.T.string)]), + withBearerTokenFile(bearerTokenFile): { bearerTokenFile: bearerTokenFile }, + '#withFilterExternalLabels':: d.fn(help='"Whether to use the external labels as selectors for the remote read endpoint.\\n\\n\\nIt requires Prometheus >= v2.34.0."', args=[d.arg(name='filterExternalLabels', type=d.T.boolean)]), + withFilterExternalLabels(filterExternalLabels): { filterExternalLabels: filterExternalLabels }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects.\\n\\n\\nIt requires Prometheus >= v2.26.0."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withHeaders':: d.fn(help="\"Custom HTTP headers to be sent along with each remote read request.\\nBe aware that headers that are set by Prometheus itself can't be overwritten.\\nOnly valid in Prometheus versions 2.26.0 and newer.\"", args=[d.arg(name='headers', type=d.T.object)]), + withHeaders(headers): { headers: headers }, + '#withHeadersMixin':: d.fn(help="\"Custom HTTP headers to be sent along with each remote read request.\\nBe aware that headers that are set by Prometheus itself can't be overwritten.\\nOnly valid in Prometheus versions 2.26.0 and newer.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='headers', type=d.T.object)]), + withHeadersMixin(headers): { headers+: headers }, + '#withName':: d.fn(help='"The name of the remote read queue, it must be unique if specified. The\\nname is used in metrics and logging in order to differentiate read\\nconfigurations.\\n\\n\\nIt requires Prometheus >= v2.15.0."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withReadRecent':: d.fn(help='"Whether reads should be made for queries for time ranges that\\nthe local storage should have complete data for."', args=[d.arg(name='readRecent', type=d.T.boolean)]), + withReadRecent(readRecent): { readRecent: readRecent }, + '#withRemoteTimeout':: d.fn(help='"Timeout for requests to the remote read endpoint."', args=[d.arg(name='remoteTimeout', type=d.T.string)]), + withRemoteTimeout(remoteTimeout): { remoteTimeout: remoteTimeout }, + '#withRequiredMatchers':: d.fn(help='"An optional list of equality matchers which have to be present\\nin a selector to query the remote read endpoint."', args=[d.arg(name='requiredMatchers', type=d.T.object)]), + withRequiredMatchers(requiredMatchers): { requiredMatchers: requiredMatchers }, + '#withRequiredMatchersMixin':: d.fn(help='"An optional list of equality matchers which have to be present\\nin a selector to query the remote read endpoint."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredMatchers', type=d.T.object)]), + withRequiredMatchersMixin(requiredMatchers): { requiredMatchers+: requiredMatchers }, + '#withUrl':: d.fn(help='"The URL of the endpoint to query from."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { url: url }, + }, + '#remoteWrite':: d.obj(help='"Defines the list of remote write configurations."'), + remoteWrite: { + '#authorization':: d.obj(help='"Authorization section for the URL.\\n\\n\\nIt requires Prometheus >= v2.26.0.\\n\\n\\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withCredentialsFile':: d.fn(help='"File to read a secret from, mutually exclusive with `credentials`."', args=[d.arg(name='credentialsFile', type=d.T.string)]), + withCredentialsFile(credentialsFile): { authorization+: { credentialsFile: credentialsFile } }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#azureAd':: d.obj(help='"AzureAD for the URL.\\n\\n\\nIt requires Prometheus >= v2.45.0.\\n\\n\\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`."'), + azureAd: { + '#managedIdentity':: d.obj(help='"ManagedIdentity defines the Azure User-assigned Managed identity.\\nCannot be set at the same time as `oauth` or `sdk`."'), + managedIdentity: { + '#withClientId':: d.fn(help='"The client id"', args=[d.arg(name='clientId', type=d.T.string)]), + withClientId(clientId): { azureAd+: { managedIdentity+: { clientId: clientId } } }, + }, + '#oauth':: d.obj(help='"OAuth defines the oauth config that is being used to authenticate.\\nCannot be set at the same time as `managedIdentity` or `sdk`.\\n\\n\\nIt requires Prometheus >= v2.48.0."'), + oauth: { + '#clientSecret':: d.obj(help='"`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate."'), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { azureAd+: { oauth+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { azureAd+: { oauth+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { azureAd+: { oauth+: { clientSecret+: { optional: optional } } } }, + }, + '#withClientId':: d.fn(help='"`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate."', args=[d.arg(name='clientId', type=d.T.string)]), + withClientId(clientId): { azureAd+: { oauth+: { clientId: clientId } } }, + '#withTenantId':: d.fn(help='"`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate."', args=[d.arg(name='tenantId', type=d.T.string)]), + withTenantId(tenantId): { azureAd+: { oauth+: { tenantId: tenantId } } }, + }, + '#sdk':: d.obj(help='"SDK defines the Azure SDK config that is being used to authenticate.\\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\\nCannot be set at the same time as `oauth` or `managedIdentity`.\\n\\n\\nIt requires Prometheus >= 2.52.0."'), + sdk: { + '#withTenantId':: d.fn(help='"`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate."', args=[d.arg(name='tenantId', type=d.T.string)]), + withTenantId(tenantId): { azureAd+: { sdk+: { tenantId: tenantId } } }, + }, + '#withCloud':: d.fn(help="\"The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.\"", args=[d.arg(name='cloud', type=d.T.string)]), + withCloud(cloud): { azureAd+: { cloud: cloud } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth configuration for the URL.\\n\\n\\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#metadataConfig':: d.obj(help='"MetadataConfig configures the sending of series metadata to the remote storage."'), + metadataConfig: { + '#withSend':: d.fn(help='"Defines whether metric metadata is sent to the remote storage or not."', args=[d.arg(name='send', type=d.T.boolean)]), + withSend(send): { metadataConfig+: { send: send } }, + '#withSendInterval':: d.fn(help='"Defines how frequently metric metadata is sent to the remote storage."', args=[d.arg(name='sendInterval', type=d.T.string)]), + withSendInterval(sendInterval): { metadataConfig+: { sendInterval: sendInterval } }, + }, + '#oauth2':: d.obj(help='"OAuth2 configuration for the URL.\\n\\n\\nIt requires Prometheus >= v2.27.0.\\n\\n\\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#queueConfig':: d.obj(help='"QueueConfig allows tuning of the remote write queue parameters."'), + queueConfig: { + '#withBatchSendDeadline':: d.fn(help='"BatchSendDeadline is the maximum time a sample will wait in buffer."', args=[d.arg(name='batchSendDeadline', type=d.T.string)]), + withBatchSendDeadline(batchSendDeadline): { queueConfig+: { batchSendDeadline: batchSendDeadline } }, + '#withCapacity':: d.fn(help='"Capacity is the number of samples to buffer per shard before we start\\ndropping them."', args=[d.arg(name='capacity', type=d.T.integer)]), + withCapacity(capacity): { queueConfig+: { capacity: capacity } }, + '#withMaxBackoff':: d.fn(help='"MaxBackoff is the maximum retry delay."', args=[d.arg(name='maxBackoff', type=d.T.string)]), + withMaxBackoff(maxBackoff): { queueConfig+: { maxBackoff: maxBackoff } }, + '#withMaxRetries':: d.fn(help='"MaxRetries is the maximum number of times to retry a batch on recoverable errors."', args=[d.arg(name='maxRetries', type=d.T.integer)]), + withMaxRetries(maxRetries): { queueConfig+: { maxRetries: maxRetries } }, + '#withMaxSamplesPerSend':: d.fn(help='"MaxSamplesPerSend is the maximum number of samples per send."', args=[d.arg(name='maxSamplesPerSend', type=d.T.integer)]), + withMaxSamplesPerSend(maxSamplesPerSend): { queueConfig+: { maxSamplesPerSend: maxSamplesPerSend } }, + '#withMaxShards':: d.fn(help='"MaxShards is the maximum number of shards, i.e. amount of concurrency."', args=[d.arg(name='maxShards', type=d.T.integer)]), + withMaxShards(maxShards): { queueConfig+: { maxShards: maxShards } }, + '#withMinBackoff':: d.fn(help='"MinBackoff is the initial retry delay. Gets doubled for every retry."', args=[d.arg(name='minBackoff', type=d.T.string)]), + withMinBackoff(minBackoff): { queueConfig+: { minBackoff: minBackoff } }, + '#withMinShards':: d.fn(help='"MinShards is the minimum number of shards, i.e. amount of concurrency."', args=[d.arg(name='minShards', type=d.T.integer)]), + withMinShards(minShards): { queueConfig+: { minShards: minShards } }, + '#withRetryOnRateLimit':: d.fn(help='"Retry upon receiving a 429 status code from the remote-write storage.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."', args=[d.arg(name='retryOnRateLimit', type=d.T.boolean)]), + withRetryOnRateLimit(retryOnRateLimit): { queueConfig+: { retryOnRateLimit: retryOnRateLimit } }, + '#withSampleAgeLimit':: d.fn(help='"SampleAgeLimit drops samples older than the limit.\\nIt requires Prometheus >= v2.50.0."', args=[d.arg(name='sampleAgeLimit', type=d.T.string)]), + withSampleAgeLimit(sampleAgeLimit): { queueConfig+: { sampleAgeLimit: sampleAgeLimit } }, + }, + '#sigv4':: d.obj(help="\"Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\\n\\n\\nIt requires Prometheus \u003e= v2.26.0.\\n\\n\\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.\""), + sigv4: { + '#accessKey':: d.obj(help='"AccessKey is the AWS API key. If not specified, the environment variable\\n`AWS_ACCESS_KEY_ID` is used."'), + accessKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { sigv4+: { accessKey+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { sigv4+: { accessKey+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { sigv4+: { accessKey+: { optional: optional } } }, + }, + '#secretKey':: d.obj(help='"SecretKey is the AWS API secret. If not specified, the environment\\nvariable `AWS_SECRET_ACCESS_KEY` is used."'), + secretKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { sigv4+: { secretKey+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { sigv4+: { secretKey+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { sigv4+: { secretKey+: { optional: optional } } }, + }, + '#withProfile':: d.fn(help='"Profile is the named AWS profile used to authenticate."', args=[d.arg(name='profile', type=d.T.string)]), + withProfile(profile): { sigv4+: { profile: profile } }, + '#withRegion':: d.fn(help='"Region is the AWS region. If blank, the region from the default credentials chain used."', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { sigv4+: { region: region } }, + '#withRoleArn':: d.fn(help='"RoleArn is the named AWS profile used to authenticate."', args=[d.arg(name='roleArn', type=d.T.string)]), + withRoleArn(roleArn): { sigv4+: { roleArn: roleArn } }, + }, + '#tlsConfig':: d.obj(help='"TLS Config to use for the URL."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { tlsConfig+: { caFile: caFile } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { tlsConfig+: { certFile: certFile } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { tlsConfig+: { keyFile: keyFile } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withBearerToken':: d.fn(help="\"*Warning: this field shouldn't be used because the token value appears\\nin clear-text. Prefer using `authorization`.*\\n\\n\\nDeprecated: this will be removed in a future release.\"", args=[d.arg(name='bearerToken', type=d.T.string)]), + withBearerToken(bearerToken): { bearerToken: bearerToken }, + '#withBearerTokenFile':: d.fn(help='"File from which to read bearer token for the URL.\\n\\n\\nDeprecated: this will be removed in a future release. Prefer using `authorization`."', args=[d.arg(name='bearerTokenFile', type=d.T.string)]), + withBearerTokenFile(bearerTokenFile): { bearerTokenFile: bearerTokenFile }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects.\\n\\n\\nIt requires Prometheus >= v2.26.0."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withHeaders':: d.fn(help="\"Custom HTTP headers to be sent along with each remote write request.\\nBe aware that headers that are set by Prometheus itself can't be overwritten.\\n\\n\\nIt requires Prometheus \u003e= v2.25.0.\"", args=[d.arg(name='headers', type=d.T.object)]), + withHeaders(headers): { headers: headers }, + '#withHeadersMixin':: d.fn(help="\"Custom HTTP headers to be sent along with each remote write request.\\nBe aware that headers that are set by Prometheus itself can't be overwritten.\\n\\n\\nIt requires Prometheus \u003e= v2.25.0.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='headers', type=d.T.object)]), + withHeadersMixin(headers): { headers+: headers }, + '#withName':: d.fn(help='"The name of the remote write queue, it must be unique if specified. The\\nname is used in metrics and logging in order to differentiate queues.\\n\\n\\nIt requires Prometheus >= v2.15.0."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRemoteTimeout':: d.fn(help='"Timeout for requests to the remote write endpoint."', args=[d.arg(name='remoteTimeout', type=d.T.string)]), + withRemoteTimeout(remoteTimeout): { remoteTimeout: remoteTimeout }, + '#withSendExemplars':: d.fn(help='"Enables sending of exemplars over remote write. Note that\\nexemplar-storage itself must be enabled using the `spec.enableFeature`\\noption for exemplars to be scraped in the first place.\\n\\n\\nIt requires Prometheus >= v2.27.0."', args=[d.arg(name='sendExemplars', type=d.T.boolean)]), + withSendExemplars(sendExemplars): { sendExemplars: sendExemplars }, + '#withSendNativeHistograms':: d.fn(help='"Enables sending of native histograms, also known as sparse histograms\\nover remote write.\\n\\n\\nIt requires Prometheus >= v2.40.0."', args=[d.arg(name='sendNativeHistograms', type=d.T.boolean)]), + withSendNativeHistograms(sendNativeHistograms): { sendNativeHistograms: sendNativeHistograms }, + '#withUrl':: d.fn(help='"The URL of the endpoint to send samples to."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { url: url }, + '#withWriteRelabelConfigs':: d.fn(help='"The list of remote write relabel configurations."', args=[d.arg(name='writeRelabelConfigs', type=d.T.array)]), + withWriteRelabelConfigs(writeRelabelConfigs): { writeRelabelConfigs: if std.isArray(v=writeRelabelConfigs) then writeRelabelConfigs else [writeRelabelConfigs] }, + '#withWriteRelabelConfigsMixin':: d.fn(help='"The list of remote write relabel configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='writeRelabelConfigs', type=d.T.array)]), + withWriteRelabelConfigsMixin(writeRelabelConfigs): { writeRelabelConfigs+: if std.isArray(v=writeRelabelConfigs) then writeRelabelConfigs else [writeRelabelConfigs] }, + '#writeRelabelConfigs':: d.obj(help='"The list of remote write relabel configurations."'), + writeRelabelConfigs: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + }, + '#resources':: d.obj(help="\"Defines the resources requests and limits of the 'prometheus' container.\""), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { spec+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { spec+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { resources+: { limits: limits } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { resources+: { limits+: limits } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { resources+: { requests: requests } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { resources+: { requests+: requests } } }, + }, + '#ruleNamespaceSelector':: d.obj(help='"Namespaces to match for PrometheusRule discovery. An empty label selector\\nmatches all namespaces. A null label selector matches the current\\nnamespace only."'), + ruleNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { ruleNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { ruleNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { ruleNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { ruleNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#ruleSelector':: d.obj(help='"PrometheusRule objects to be selected for rule evaluation. An empty\\nlabel selector matches all objects. A null label selector matches no\\nobjects."'), + ruleSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { ruleSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { ruleSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { ruleSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { ruleSelector+: { matchLabels+: matchLabels } } }, + }, + '#rules':: d.obj(help="\"Defines the configuration of the Prometheus rules' engine.\""), + rules: { + '#alert':: d.obj(help="\"Defines the parameters of the Prometheus rules' engine.\\n\\n\\nAny update to these parameters trigger a restart of the pods.\""), + alert: { + '#withForGracePeriod':: d.fn(help="\"Minimum duration between alert and restored 'for' state.\\n\\n\\nThis is maintained only for alerts with a configured 'for' time greater\\nthan the grace period.\"", args=[d.arg(name='forGracePeriod', type=d.T.string)]), + withForGracePeriod(forGracePeriod): { spec+: { rules+: { alert+: { forGracePeriod: forGracePeriod } } } }, + '#withForOutageTolerance':: d.fn(help="\"Max time to tolerate prometheus outage for restoring 'for' state of\\nalert.\"", args=[d.arg(name='forOutageTolerance', type=d.T.string)]), + withForOutageTolerance(forOutageTolerance): { spec+: { rules+: { alert+: { forOutageTolerance: forOutageTolerance } } } }, + '#withResendDelay':: d.fn(help='"Minimum amount of time to wait before resending an alert to\\nAlertmanager."', args=[d.arg(name='resendDelay', type=d.T.string)]), + withResendDelay(resendDelay): { spec+: { rules+: { alert+: { resendDelay: resendDelay } } } }, + }, + }, + '#scrapeClasses':: d.obj(help='"List of scrape classes to expose to scraping objects such as\\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."'), + scrapeClasses: { + '#attachMetadata':: d.obj(help='"AttachMetadata configures additional metadata to the discovered targets.\\nWhen the scrape object defines its own configuration, it takes\\nprecedence over the scrape class configuration."'), + attachMetadata: { + '#withNode':: d.fn(help='"When set to true, Prometheus attaches node metadata to the discovered\\ntargets.\\n\\n\\nThe Prometheus service account must have the `list` and `watch`\\npermissions on the `Nodes` objects."', args=[d.arg(name='node', type=d.T.boolean)]), + withNode(node): { attachMetadata+: { node: node } }, + }, + '#metricRelabelings':: d.obj(help="\"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\\n\\n\\nThe Operator adds the scrape class metric relabelings defined here.\\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs\""), + metricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#relabelings':: d.obj(help='"Relabelings configures the relabeling rules to apply to all scrape targets.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\\nThen the Operator adds the scrape class relabelings defined here.\\nThen the Operator adds the target-specific relabelings defined in the scrape object.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"'), + relabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#tlsConfig':: d.obj(help='"TLSConfig defines the TLS settings to use for the scrape. When the\\nscrape objects define their own CA, certificate and/or key, they take\\nprecedence over the corresponding scrape class fields.\\n\\n\\nFor now only the `caFile`, `certFile` and `keyFile` fields are supported."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { tlsConfig+: { caFile: caFile } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { tlsConfig+: { certFile: certFile } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { tlsConfig+: { keyFile: keyFile } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withDefault':: d.fn(help="\"Default indicates that the scrape applies to all scrape objects that\\ndon't configure an explicit scrape class name.\\n\\n\\nOnly one scrape class can be set as the default.\"", args=[d.arg(name='default', type=d.T.boolean)]), + withDefault(default): { default: default }, + '#withMetricRelabelings':: d.fn(help="\"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\\n\\n\\nThe Operator adds the scrape class metric relabelings defined here.\\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs\"", args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelings(metricRelabelings): { metricRelabelings: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] }, + '#withMetricRelabelingsMixin':: d.fn(help="\"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\\n\\n\\nThe Operator adds the scrape class metric relabelings defined here.\\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelingsMixin(metricRelabelings): { metricRelabelings+: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] }, + '#withName':: d.fn(help='"Name of the scrape class."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withRelabelings':: d.fn(help='"Relabelings configures the relabeling rules to apply to all scrape targets.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\\nThen the Operator adds the scrape class relabelings defined here.\\nThen the Operator adds the target-specific relabelings defined in the scrape object.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"', args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelings(relabelings): { relabelings: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + '#withRelabelingsMixin':: d.fn(help='"Relabelings configures the relabeling rules to apply to all scrape targets.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\\nThen the Operator adds the scrape class relabelings defined here.\\nThen the Operator adds the target-specific relabelings defined in the scrape object.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelingsMixin(relabelings): { relabelings+: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + }, + '#scrapeConfigNamespaceSelector':: d.obj(help='"Namespaces to match for ScrapeConfig discovery. An empty label selector\\nmatches all namespaces. A null label selector matches the current\\nnamespace only.\\n\\n\\nNote that the ScrapeConfig custom resource definition is currently at Alpha level."'), + scrapeConfigNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { scrapeConfigNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { scrapeConfigNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { scrapeConfigNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { scrapeConfigNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#scrapeConfigSelector':: d.obj(help="\"ScrapeConfigs to be selected for target discovery. An empty label\\nselector matches all objects. A null label selector matches no objects.\\n\\n\\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\\nThe Prometheus operator will ensure that the Prometheus configuration's\\nSecret exists, but it is the responsibility of the user to provide the raw\\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\\nThis behavior is *deprecated* and will be removed in the next major version\\nof the custom resource definition. It is recommended to use\\n`spec.additionalScrapeConfigs` instead.\\n\\n\\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.\""), + scrapeConfigSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { scrapeConfigSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { scrapeConfigSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { scrapeConfigSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { scrapeConfigSelector+: { matchLabels+: matchLabels } } }, + }, + '#securityContext':: d.obj(help='"SecurityContext holds pod-level security attributes and common container settings.\\nThis defaults to the default PodSecurityContext."'), + securityContext: { + '#appArmorProfile':: d.obj(help='"appArmorProfile is the AppArmor options to use by the containers in this pod.\\nNote that this field cannot be set when spec.os.name is windows."'), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { appArmorProfile+: { type: type } } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to all containers.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in SecurityContext. If set in\\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\\ntakes precedence for that container.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { spec+: { securityContext+: { seLinuxOptions+: { level: level } } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { spec+: { securityContext+: { seLinuxOptions+: { role: role } } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { seLinuxOptions+: { type: type } } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { spec+: { securityContext+: { seLinuxOptions+: { user: user } } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by the containers in this pod.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { seccompProfile+: { type: type } } } }, + }, + '#sysctls':: d.obj(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."'), + sysctls: { + '#withName':: d.fn(help='"Name of a property to set"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Value of a property to set"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#windowsOptions':: d.obj(help="\"The Windows specific settings applied to all containers.\\nIf unspecified, the options within a container's SecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux.\""), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { spec+: { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { spec+: { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { spec+: { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { spec+: { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } } }, + }, + '#withFsGroup':: d.fn(help="\"A special supplemental group that applies to all containers in a pod.\\nSome volume types allow the Kubelet to change the ownership of that volume\\nto be owned by the pod:\\n\\n\\n1. The owning GID will be the FSGroup\\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\\n3. The permission bits are OR'd with rw-rw----\\n\\n\\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\\nNote that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='fsGroup', type=d.T.integer)]), + withFsGroup(fsGroup): { spec+: { securityContext+: { fsGroup: fsGroup } } }, + '#withFsGroupChangePolicy':: d.fn(help='"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\\nbefore being exposed inside Pod. This field will only apply to\\nvolume types which support fsGroup based ownership(and permissions).\\nIt will have no effect on ephemeral volume types such as: secret, configmaps\\nand emptydir.\\nValid values are \\"OnRootMismatch\\" and \\"Always\\". If not specified, \\"Always\\" is used.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='fsGroupChangePolicy', type=d.T.string)]), + withFsGroupChangePolicy(fsGroupChangePolicy): { spec+: { securityContext+: { fsGroupChangePolicy: fsGroupChangePolicy } } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence\\nfor that container.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { spec+: { securityContext+: { runAsGroup: runAsGroup } } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { spec+: { securityContext+: { runAsNonRoot: runAsNonRoot } } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence\\nfor that container.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { spec+: { securityContext+: { runAsUser: runAsUser } } }, + '#withSupplementalGroups':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition\\nto the container's primary GID, the fsGroup (if specified), and group memberships\\ndefined in the container image for the uid of the container process. If unspecified,\\nno additional groups are added to any container. Note that group memberships\\ndefined in the container image for the uid of the container process are still effective,\\neven if they are not included in this list.\\nNote that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroups(supplementalGroups): { spec+: { securityContext+: { supplementalGroups: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } }, + '#withSupplementalGroupsMixin':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition\\nto the container's primary GID, the fsGroup (if specified), and group memberships\\ndefined in the container image for the uid of the container process. If unspecified,\\nno additional groups are added to any container. Note that group memberships\\ndefined in the container image for the uid of the container process are still effective,\\neven if they are not included in this list.\\nNote that this field cannot be set when spec.os.name is windows.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroupsMixin(supplementalGroups): { spec+: { securityContext+: { supplementalGroups+: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } }, + '#withSysctls':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctls(sysctls): { spec+: { securityContext+: { sysctls: if std.isArray(v=sysctls) then sysctls else [sysctls] } } }, + '#withSysctlsMixin':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctlsMixin(sysctls): { spec+: { securityContext+: { sysctls+: if std.isArray(v=sysctls) then sysctls else [sysctls] } } }, + }, + '#serviceMonitorNamespaceSelector':: d.obj(help='"Namespaces to match for ServicedMonitors discovery. An empty label selector\\nmatches all namespaces. A null label selector (default value) matches the current\\nnamespace only."'), + serviceMonitorNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { serviceMonitorNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { serviceMonitorNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { serviceMonitorNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { serviceMonitorNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#serviceMonitorSelector':: d.obj(help="\"ServiceMonitors to be selected for target discovery. An empty label\\nselector matches all objects. A null label selector matches no objects.\\n\\n\\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\\nThe Prometheus operator will ensure that the Prometheus configuration's\\nSecret exists, but it is the responsibility of the user to provide the raw\\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\\nThis behavior is *deprecated* and will be removed in the next major version\\nof the custom resource definition. It is recommended to use\\n`spec.additionalScrapeConfigs` instead.\""), + serviceMonitorSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { serviceMonitorSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { serviceMonitorSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { serviceMonitorSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { serviceMonitorSelector+: { matchLabels+: matchLabels } } }, + }, + '#storage':: d.obj(help='"Storage defines the storage used by Prometheus."'), + storage: { + '#emptyDir':: d.obj(help='"EmptyDirVolumeSource to be used by the StatefulSet.\\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir"'), + emptyDir: { + '#withMedium':: d.fn(help="\"medium represents what type of storage medium should back this directory.\\nThe default is \\\"\\\" which means to use the node's default medium.\\nMust be an empty string (default) or Memory.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\"", args=[d.arg(name='medium', type=d.T.string)]), + withMedium(medium): { spec+: { storage+: { emptyDir+: { medium: medium } } } }, + '#withSizeLimit':: d.fn(help='"sizeLimit is the total amount of local storage required for this EmptyDir volume.\\nThe size limit is also applicable for memory medium.\\nThe maximum usage on memory medium EmptyDir would be the minimum value between\\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\\nThe default is nil which means that the limit is undefined.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"', args=[d.arg(name='sizeLimit', type=d.T.any)]), + withSizeLimit(sizeLimit): { spec+: { storage+: { emptyDir+: { sizeLimit: sizeLimit } } } }, + }, + '#ephemeral':: d.obj(help='"EphemeralVolumeSource to be used by the StatefulSet.\\nThis is a beta field in k8s 1.21 and GA in 1.15.\\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes"'), + ephemeral: { + '#volumeClaimTemplate':: d.obj(help='"Will be used to create a stand-alone PVC to provision the volume.\\nThe pod in which this EphemeralVolumeSource is embedded will be the\\nowner of the PVC, i.e. the PVC will be deleted together with the\\npod. The name of the PVC will be `-` where\\n`` is the name from the `PodSpec.Volumes` array\\nentry. Pod validation will reject the pod if the concatenated name\\nis not valid for a PVC (for example, too long).\\n\\n\\nAn existing PVC with that name that is not owned by the pod\\nwill *not* be used for the pod to avoid using an unrelated\\nvolume by mistake. Starting the pod is then blocked until\\nthe unrelated PVC is removed. If such a pre-created PVC is\\nmeant to be used by the pod, the PVC has to updated with an\\nowner reference to the pod once the pod exists. Normally\\nthis should not be necessary, but it may be useful when\\nmanually reconstructing a broken cluster.\\n\\n\\nThis field is read-only and no changes will be made by Kubernetes\\nto the PVC after it has been created.\\n\\n\\nRequired, must not be nil."'), + volumeClaimTemplate: { + '#spec':: d.obj(help='"The specification for the PersistentVolumeClaim. The entire content is\\ncopied unchanged into the PVC that gets created from this\\ntemplate. The same fields as in a PersistentVolumeClaim\\nare also valid here."'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } } } }, + }, + '#withMetadata':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadata(metadata): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { metadata: metadata } } } } }, + '#withMetadataMixin':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadataMixin(metadata): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { metadata+: metadata } } } } }, + }, + }, + '#volumeClaimTemplate':: d.obj(help='"Defines the PVC spec to be used by the Prometheus StatefulSets.\\nThe easiest way to use a volume that cannot be automatically provisioned\\nis to use a label selector alongside manually created PersistentVolumes."'), + volumeClaimTemplate: { + '#metadata':: d.obj(help='"EmbeddedMetadata contains metadata relevant to an EmbeddedResource."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { annotations: annotations } } } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { annotations+: annotations } } } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { labels: labels } } } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { labels+: labels } } } } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although\\nsome resources may allow a client to request the generation of an appropriate name\\nautomatically. Name is primarily intended for creation idempotence and configuration\\ndefinition.\\nCannot be updated.\\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { name: name } } } } }, + }, + '#spec':: d.obj(help='"Defines the desired characteristics of a volume requested by a pod author.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } } }, + }, + '#withApiVersion':: d.fn(help='"APIVersion defines the versioned schema of this representation of an object.\\nServers should convert recognized schemas to the latest internal value, and\\nmay reject unrecognized values.\\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { storage+: { volumeClaimTemplate+: { apiVersion: apiVersion } } } }, + '#withKind':: d.fn(help='"Kind is a string value representing the REST resource this object represents.\\nServers may infer this from the endpoint the client submits requests to.\\nCannot be updated.\\nIn CamelCase.\\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { kind: kind } } } }, + }, + '#withDisableMountSubPath':: d.fn(help='"Deprecated: subPath usage will be removed in a future release."', args=[d.arg(name='disableMountSubPath', type=d.T.boolean)]), + withDisableMountSubPath(disableMountSubPath): { spec+: { storage+: { disableMountSubPath: disableMountSubPath } } }, + }, + '#thanos':: d.obj(help='"Defines the configuration of the optional Thanos sidecar."'), + thanos: { + '#additionalArgs':: d.obj(help='"AdditionalArgs allows setting additional arguments for the Thanos container.\\nThe arguments are passed as-is to the Thanos container which may cause issues\\nif they are invalid or not supported the given Thanos version.\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument, the reconciliation will\\nfail and an error will be logged."'), + additionalArgs: { + '#withName':: d.fn(help='"Name of the argument, e.g. \\"scrape.discovery-reload-interval\\"."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#grpcServerTlsConfig':: d.obj(help='"Configures the TLS parameters for the gRPC server providing the StoreAPI.\\n\\n\\nNote: Currently only the `caFile`, `certFile`, and `keyFile` fields are supported."'), + grpcServerTlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { thanos+: { grpcServerTlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { thanos+: { grpcServerTlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { thanos+: { grpcServerTlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { thanos+: { grpcServerTlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { thanos+: { grpcServerTlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { thanos+: { grpcServerTlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { thanos+: { grpcServerTlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { thanos+: { grpcServerTlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { thanos+: { grpcServerTlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { thanos+: { grpcServerTlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { thanos+: { grpcServerTlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { thanos+: { grpcServerTlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { thanos+: { grpcServerTlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { thanos+: { grpcServerTlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { thanos+: { grpcServerTlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { spec+: { thanos+: { grpcServerTlsConfig+: { caFile: caFile } } } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { spec+: { thanos+: { grpcServerTlsConfig+: { certFile: certFile } } } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { thanos+: { grpcServerTlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { spec+: { thanos+: { grpcServerTlsConfig+: { keyFile: keyFile } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { thanos+: { grpcServerTlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { thanos+: { grpcServerTlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { thanos+: { grpcServerTlsConfig+: { serverName: serverName } } } }, + }, + '#objectStorageConfig':: d.obj(help="\"Defines the Thanos sidecar's configuration to upload TSDB blocks to object storage.\\n\\n\\nMore info: https://thanos.io/tip/thanos/storage.md/\\n\\n\\nobjectStorageConfigFile takes precedence over this field.\""), + objectStorageConfig: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { thanos+: { objectStorageConfig+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { thanos+: { objectStorageConfig+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { thanos+: { objectStorageConfig+: { optional: optional } } } }, + }, + '#resources':: d.obj(help='"Defines the resources requests and limits of the Thanos sidecar."'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { spec+: { thanos+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { spec+: { thanos+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { thanos+: { resources+: { limits: limits } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { thanos+: { resources+: { limits+: limits } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { thanos+: { resources+: { requests: requests } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { thanos+: { resources+: { requests+: requests } } } }, + }, + '#tracingConfig':: d.obj(help='"Defines the tracing configuration for the Thanos sidecar.\\n\\n\\n`tracingConfigFile` takes precedence over this field.\\n\\n\\nMore info: https://thanos.io/tip/thanos/tracing.md/\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."'), + tracingConfig: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { thanos+: { tracingConfig+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { thanos+: { tracingConfig+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { thanos+: { tracingConfig+: { optional: optional } } } }, + }, + '#volumeMounts':: d.obj(help="\"VolumeMounts allows configuration of additional VolumeMounts for Thanos.\\nVolumeMounts specified will be appended to other VolumeMounts in the\\n'thanos-sidecar' container.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withAdditionalArgs':: d.fn(help='"AdditionalArgs allows setting additional arguments for the Thanos container.\\nThe arguments are passed as-is to the Thanos container which may cause issues\\nif they are invalid or not supported the given Thanos version.\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument, the reconciliation will\\nfail and an error will be logged."', args=[d.arg(name='additionalArgs', type=d.T.array)]), + withAdditionalArgs(additionalArgs): { spec+: { thanos+: { additionalArgs: if std.isArray(v=additionalArgs) then additionalArgs else [additionalArgs] } } }, + '#withAdditionalArgsMixin':: d.fn(help='"AdditionalArgs allows setting additional arguments for the Thanos container.\\nThe arguments are passed as-is to the Thanos container which may cause issues\\nif they are invalid or not supported the given Thanos version.\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument, the reconciliation will\\nfail and an error will be logged."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='additionalArgs', type=d.T.array)]), + withAdditionalArgsMixin(additionalArgs): { spec+: { thanos+: { additionalArgs+: if std.isArray(v=additionalArgs) then additionalArgs else [additionalArgs] } } }, + '#withBaseImage':: d.fn(help="\"Deprecated: use 'image' instead.\"", args=[d.arg(name='baseImage', type=d.T.string)]), + withBaseImage(baseImage): { spec+: { thanos+: { baseImage: baseImage } } }, + '#withBlockSize':: d.fn(help='"BlockDuration controls the size of TSDB blocks produced by Prometheus.\\nThe default value is 2h to match the upstream Prometheus defaults.\\n\\n\\nWARNING: Changing the block duration can impact the performance and\\nefficiency of the entire Prometheus/Thanos stack due to how it interacts\\nwith memory and Thanos compactors. It is recommended to keep this value\\nset to a multiple of 120 times your longest scrape or rule interval. For\\nexample, 30s * 120 = 1h."', args=[d.arg(name='blockSize', type=d.T.string)]), + withBlockSize(blockSize): { spec+: { thanos+: { blockSize: blockSize } } }, + '#withGetConfigInterval':: d.fn(help='"How often to retrieve the Prometheus configuration."', args=[d.arg(name='getConfigInterval', type=d.T.string)]), + withGetConfigInterval(getConfigInterval): { spec+: { thanos+: { getConfigInterval: getConfigInterval } } }, + '#withGetConfigTimeout':: d.fn(help='"Maximum time to wait when retrieving the Prometheus configuration."', args=[d.arg(name='getConfigTimeout', type=d.T.string)]), + withGetConfigTimeout(getConfigTimeout): { spec+: { thanos+: { getConfigTimeout: getConfigTimeout } } }, + '#withGrpcListenLocal':: d.fn(help="\"When true, the Thanos sidecar listens on the loopback interface instead\\nof the Pod IP's address for the gRPC endpoints.\\n\\n\\nIt has no effect if `listenLocal` is true.\"", args=[d.arg(name='grpcListenLocal', type=d.T.boolean)]), + withGrpcListenLocal(grpcListenLocal): { spec+: { thanos+: { grpcListenLocal: grpcListenLocal } } }, + '#withHttpListenLocal':: d.fn(help="\"When true, the Thanos sidecar listens on the loopback interface instead\\nof the Pod IP's address for the HTTP endpoints.\\n\\n\\nIt has no effect if `listenLocal` is true.\"", args=[d.arg(name='httpListenLocal', type=d.T.boolean)]), + withHttpListenLocal(httpListenLocal): { spec+: { thanos+: { httpListenLocal: httpListenLocal } } }, + '#withImage':: d.fn(help='"Container image name for Thanos. If specified, it takes precedence over\\nthe `spec.thanos.baseImage`, `spec.thanos.tag` and `spec.thanos.sha`\\nfields.\\n\\n\\nSpecifying `spec.thanos.version` is still necessary to ensure the\\nPrometheus Operator knows which version of Thanos is being configured.\\n\\n\\nIf neither `spec.thanos.image` nor `spec.thanos.baseImage` are defined,\\nthe operator will use the latest upstream version of Thanos available at\\nthe time when the operator was released."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { spec+: { thanos+: { image: image } } }, + '#withListenLocal':: d.fn(help='"Deprecated: use `grpcListenLocal` and `httpListenLocal` instead."', args=[d.arg(name='listenLocal', type=d.T.boolean)]), + withListenLocal(listenLocal): { spec+: { thanos+: { listenLocal: listenLocal } } }, + '#withLogFormat':: d.fn(help='"Log format for the Thanos sidecar."', args=[d.arg(name='logFormat', type=d.T.string)]), + withLogFormat(logFormat): { spec+: { thanos+: { logFormat: logFormat } } }, + '#withLogLevel':: d.fn(help='"Log level for the Thanos sidecar."', args=[d.arg(name='logLevel', type=d.T.string)]), + withLogLevel(logLevel): { spec+: { thanos+: { logLevel: logLevel } } }, + '#withMinTime':: d.fn(help="\"Defines the start of time range limit served by the Thanos sidecar's StoreAPI.\\nThe field's value should be a constant time in RFC3339 format or a time\\nduration relative to current time, such as -1d or 2h45m. Valid duration\\nunits are ms, s, m, h, d, w, y.\"", args=[d.arg(name='minTime', type=d.T.string)]), + withMinTime(minTime): { spec+: { thanos+: { minTime: minTime } } }, + '#withObjectStorageConfigFile':: d.fn(help="\"Defines the Thanos sidecar's configuration file to upload TSDB blocks to object storage.\\n\\n\\nMore info: https://thanos.io/tip/thanos/storage.md/\\n\\n\\nThis field takes precedence over objectStorageConfig.\"", args=[d.arg(name='objectStorageConfigFile', type=d.T.string)]), + withObjectStorageConfigFile(objectStorageConfigFile): { spec+: { thanos+: { objectStorageConfigFile: objectStorageConfigFile } } }, + '#withReadyTimeout':: d.fn(help='"ReadyTimeout is the maximum time that the Thanos sidecar will wait for\\nPrometheus to start."', args=[d.arg(name='readyTimeout', type=d.T.string)]), + withReadyTimeout(readyTimeout): { spec+: { thanos+: { readyTimeout: readyTimeout } } }, + '#withSha':: d.fn(help="\"Deprecated: use 'image' instead. The image digest can be specified as part of the image name.\"", args=[d.arg(name='sha', type=d.T.string)]), + withSha(sha): { spec+: { thanos+: { sha: sha } } }, + '#withTag':: d.fn(help="\"Deprecated: use 'image' instead. The image's tag can be specified as as part of the image name.\"", args=[d.arg(name='tag', type=d.T.string)]), + withTag(tag): { spec+: { thanos+: { tag: tag } } }, + '#withTracingConfigFile':: d.fn(help='"Defines the tracing configuration file for the Thanos sidecar.\\n\\n\\nThis field takes precedence over `tracingConfig`.\\n\\n\\nMore info: https://thanos.io/tip/thanos/tracing.md/\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."', args=[d.arg(name='tracingConfigFile', type=d.T.string)]), + withTracingConfigFile(tracingConfigFile): { spec+: { thanos+: { tracingConfigFile: tracingConfigFile } } }, + '#withVersion':: d.fn(help='"Version of Thanos being deployed. The operator uses this information\\nto generate the Prometheus StatefulSet + configuration files.\\n\\n\\nIf not specified, the operator assumes the latest upstream release of\\nThanos available at the time when the version of the operator was\\nreleased."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { thanos+: { version: version } } }, + '#withVolumeMounts':: d.fn(help="\"VolumeMounts allows configuration of additional VolumeMounts for Thanos.\\nVolumeMounts specified will be appended to other VolumeMounts in the\\n'thanos-sidecar' container.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { spec+: { thanos+: { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } } }, + '#withVolumeMountsMixin':: d.fn(help="\"VolumeMounts allows configuration of additional VolumeMounts for Thanos.\\nVolumeMounts specified will be appended to other VolumeMounts in the\\n'thanos-sidecar' container.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { spec+: { thanos+: { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } } }, + }, + '#tolerations':: d.obj(help="\"Defines the Pods' tolerations if specified.\""), + tolerations: { + '#withEffect':: d.fn(help='"Effect indicates the taint effect to match. Empty means match all taint effects.\\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."', args=[d.arg(name='effect', type=d.T.string)]), + withEffect(effect): { effect: effect }, + '#withKey':: d.fn(help='"Key is the taint key that the toleration applies to. Empty means match all taint keys.\\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Operator represents a key's relationship to the value.\\nValid operators are Exists and Equal. Defaults to Equal.\\nExists is equivalent to wildcard for value, so that a pod can\\ntolerate all taints of a particular category.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withTolerationSeconds':: d.fn(help='"TolerationSeconds represents the period of time the toleration (which must be\\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\\nit is not set, which means tolerate the taint forever (do not evict). Zero and\\nnegative values will be treated as 0 (evict immediately) by the system."', args=[d.arg(name='tolerationSeconds', type=d.T.integer)]), + withTolerationSeconds(tolerationSeconds): { tolerationSeconds: tolerationSeconds }, + '#withValue':: d.fn(help='"Value is the taint value the toleration matches to.\\nIf the operator is Exists, the value should be empty, otherwise just a regular string."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#topologySpreadConstraints':: d.obj(help="\"Defines the pod's topology spread constraints if specified.\""), + topologySpreadConstraints: { + '#labelSelector':: d.obj(help='"LabelSelector is used to find matching pods.\\nPods that match this label selector are counted to determine the number of pods\\nin their corresponding topology domain."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#withAdditionalLabelSelectors':: d.fn(help='"Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint."', args=[d.arg(name='additionalLabelSelectors', type=d.T.string)]), + withAdditionalLabelSelectors(additionalLabelSelectors): { additionalLabelSelectors: additionalLabelSelectors }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select the pods over which\\nspreading will be calculated. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are ANDed with labelSelector\\nto select the group of existing pods over which spreading will be calculated\\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\\nMatchLabelKeys cannot be set when LabelSelector isn't set.\\nKeys that don't exist in the incoming pod labels will\\nbe ignored. A null or empty list means only match against labelSelector.\\n\\n\\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select the pods over which\\nspreading will be calculated. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are ANDed with labelSelector\\nto select the group of existing pods over which spreading will be calculated\\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\\nMatchLabelKeys cannot be set when LabelSelector isn't set.\\nKeys that don't exist in the incoming pod labels will\\nbe ignored. A null or empty list means only match against labelSelector.\\n\\n\\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMaxSkew':: d.fn(help="\"MaxSkew describes the degree to which pods may be unevenly distributed.\\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\\nbetween the number of matching pods in the target topology and the global minimum.\\nThe global minimum is the minimum number of matching pods in an eligible domain\\nor zero if the number of eligible domains is less than MinDomains.\\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\\nlabelSelector spread as 2/2/1:\\nIn this case, the global minimum is 1.\\n| zone1 | zone2 | zone3 |\\n| P P | P P | P |\\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\\nviolate MaxSkew(1).\\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\\nto topologies that satisfy it.\\nIt's a required field. Default value is 1 and 0 is not allowed.\"", args=[d.arg(name='maxSkew', type=d.T.integer)]), + withMaxSkew(maxSkew): { maxSkew: maxSkew }, + '#withMinDomains':: d.fn(help="\"MinDomains indicates a minimum number of eligible domains.\\nWhen the number of eligible domains with matching topology keys is less than minDomains,\\nPod Topology Spread treats \\\"global minimum\\\" as 0, and then the calculation of Skew is performed.\\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\\nthis value has no effect on scheduling.\\nAs a result, when the number of eligible domains is less than minDomains,\\nscheduler won't schedule more than maxSkew Pods to those domains.\\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\\nValid values are integers greater than 0.\\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\\n\\n\\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\\nlabelSelector spread as 2/2/2:\\n| zone1 | zone2 | zone3 |\\n| P P | P P | P P |\\nThe number of domains is less than 5(MinDomains), so \\\"global minimum\\\" is treated as 0.\\nIn this situation, new pod with the same labelSelector cannot be scheduled,\\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\\nit will violate MaxSkew.\"", args=[d.arg(name='minDomains', type=d.T.integer)]), + withMinDomains(minDomains): { minDomains: minDomains }, + '#withNodeAffinityPolicy':: d.fn(help="\"NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\\nwhen calculating pod topology spread skew. Options are:\\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\\n\\n\\nIf this value is nil, the behavior is equivalent to the Honor policy.\\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.\"", args=[d.arg(name='nodeAffinityPolicy', type=d.T.string)]), + withNodeAffinityPolicy(nodeAffinityPolicy): { nodeAffinityPolicy: nodeAffinityPolicy }, + '#withNodeTaintsPolicy':: d.fn(help='"NodeTaintsPolicy indicates how we will treat node taints when calculating\\npod topology spread skew. Options are:\\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\\nhas a toleration, are included.\\n- Ignore: node taints are ignored. All nodes are included.\\n\\n\\nIf this value is nil, the behavior is equivalent to the Ignore policy.\\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."', args=[d.arg(name='nodeTaintsPolicy', type=d.T.string)]), + withNodeTaintsPolicy(nodeTaintsPolicy): { nodeTaintsPolicy: nodeTaintsPolicy }, + '#withTopologyKey':: d.fn(help="\"TopologyKey is the key of node labels. Nodes that have a label with this key\\nand identical values are considered to be in the same topology.\\nWe consider each \u003ckey, value\u003e as a \\\"bucket\\\", and try to put balanced number\\nof pods into each bucket.\\nWe define a domain as a particular instance of a topology.\\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\\nnodeAffinityPolicy and nodeTaintsPolicy.\\ne.g. If TopologyKey is \\\"kubernetes.io/hostname\\\", each Node is a domain of that topology.\\nAnd, if TopologyKey is \\\"topology.kubernetes.io/zone\\\", each zone is a domain of that topology.\\nIt's a required field.\"", args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + '#withWhenUnsatisfiable':: d.fn(help="\"WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\\nthe spread constraint.\\n- DoNotSchedule (default) tells the scheduler not to schedule it.\\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\\n but giving higher precedence to topologies that would help reduce the\\n skew.\\nA constraint is considered \\\"Unsatisfiable\\\" for an incoming pod\\nif and only if every possible node assignment for that pod would violate\\n\\\"MaxSkew\\\" on some topology.\\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\\nlabelSelector spread as 3/1/1:\\n| zone1 | zone2 | zone3 |\\n| P P P | P | P |\\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\\nwon't make it *more* imbalanced.\\nIt's a required field.\"", args=[d.arg(name='whenUnsatisfiable', type=d.T.string)]), + withWhenUnsatisfiable(whenUnsatisfiable): { whenUnsatisfiable: whenUnsatisfiable }, + }, + '#tracingConfig':: d.obj(help='"TracingConfig configures tracing in Prometheus.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."'), + tracingConfig: { + '#tlsConfig':: d.obj(help='"TLS Config to use when sending traces."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { spec+: { tracingConfig+: { tlsConfig+: { caFile: caFile } } } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { spec+: { tracingConfig+: { tlsConfig+: { certFile: certFile } } } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { tracingConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { spec+: { tracingConfig+: { tlsConfig+: { keyFile: keyFile } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { tracingConfig+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { tracingConfig+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { tracingConfig+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withClientType':: d.fn(help='"Client used to export the traces. Supported values are `http` or `grpc`."', args=[d.arg(name='clientType', type=d.T.string)]), + withClientType(clientType): { spec+: { tracingConfig+: { clientType: clientType } } }, + '#withCompression':: d.fn(help='"Compression key for supported compression types. The only supported value is `gzip`."', args=[d.arg(name='compression', type=d.T.string)]), + withCompression(compression): { spec+: { tracingConfig+: { compression: compression } } }, + '#withEndpoint':: d.fn(help='"Endpoint to send the traces to. Should be provided in format :."', args=[d.arg(name='endpoint', type=d.T.string)]), + withEndpoint(endpoint): { spec+: { tracingConfig+: { endpoint: endpoint } } }, + '#withHeaders':: d.fn(help='"Key-value pairs to be used as headers associated with gRPC or HTTP requests."', args=[d.arg(name='headers', type=d.T.object)]), + withHeaders(headers): { spec+: { tracingConfig+: { headers: headers } } }, + '#withHeadersMixin':: d.fn(help='"Key-value pairs to be used as headers associated with gRPC or HTTP requests."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='headers', type=d.T.object)]), + withHeadersMixin(headers): { spec+: { tracingConfig+: { headers+: headers } } }, + '#withInsecure':: d.fn(help='"If disabled, the client will use a secure connection."', args=[d.arg(name='insecure', type=d.T.boolean)]), + withInsecure(insecure): { spec+: { tracingConfig+: { insecure: insecure } } }, + '#withSamplingFraction':: d.fn(help='"Sets the probability a given trace will be sampled. Must be a float from 0 through 1."', args=[d.arg(name='samplingFraction', type=d.T.any)]), + withSamplingFraction(samplingFraction): { spec+: { tracingConfig+: { samplingFraction: samplingFraction } } }, + '#withTimeout':: d.fn(help='"Maximum time the exporter will wait for each batch export."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { tracingConfig+: { timeout: timeout } } }, + }, + '#tsdb':: d.obj(help='"Defines the runtime reloadable configuration of the timeseries database\\n(TSDB)."'), + tsdb: { + '#withOutOfOrderTimeWindow':: d.fn(help='"Configures how old an out-of-order/out-of-bounds sample can be with\\nrespect to the TSDB max time.\\n\\n\\nAn out-of-order/out-of-bounds sample is ingested into the TSDB as long as\\nthe timestamp of the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow).\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way.\\n\\n\\nIt requires Prometheus >= v2.39.0."', args=[d.arg(name='outOfOrderTimeWindow', type=d.T.string)]), + withOutOfOrderTimeWindow(outOfOrderTimeWindow): { spec+: { tsdb+: { outOfOrderTimeWindow: outOfOrderTimeWindow } } }, + }, + '#volumeMounts':: d.obj(help="\"VolumeMounts allows the configuration of additional VolumeMounts.\\n\\n\\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\\ncontainer, that are generated as a result of StorageSpec objects.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#volumes':: d.obj(help='"Volumes allows the configuration of additional volumes on the output\\nStatefulSet definition. Volumes specified will be appended to other\\nvolumes that are generated as a result of StorageSpec objects."'), + volumes: { + '#awsElasticBlockStore':: d.obj(help="\"awsElasticBlockStore represents an AWS Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\""), + awsElasticBlockStore: { + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { awsElasticBlockStore+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount.\\nIf omitted, the default is to mount by volume name.\\nExamples: For volume /dev/sda1, you specify the partition as \\"1\\".\\nSimilarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty)."', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { awsElasticBlockStore+: { partition: partition } }, + '#withReadOnly':: d.fn(help='"readOnly value true will force the readOnly setting in VolumeMounts.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { awsElasticBlockStore+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { awsElasticBlockStore+: { volumeID: volumeID } }, + }, + '#azureDisk':: d.obj(help='"azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."'), + azureDisk: { + '#withCachingMode':: d.fn(help='"cachingMode is the Host Caching mode: None, Read Only, Read Write."', args=[d.arg(name='cachingMode', type=d.T.string)]), + withCachingMode(cachingMode): { azureDisk+: { cachingMode: cachingMode } }, + '#withDiskName':: d.fn(help='"diskName is the Name of the data disk in the blob storage"', args=[d.arg(name='diskName', type=d.T.string)]), + withDiskName(diskName): { azureDisk+: { diskName: diskName } }, + '#withDiskURI':: d.fn(help='"diskURI is the URI of data disk in the blob storage"', args=[d.arg(name='diskURI', type=d.T.string)]), + withDiskURI(diskURI): { azureDisk+: { diskURI: diskURI } }, + '#withFsType':: d.fn(help='"fsType is Filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { azureDisk+: { fsType: fsType } }, + '#withKind':: d.fn(help='"kind expected values are 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"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { azureDisk+: { kind: kind } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureDisk+: { readOnly: readOnly } }, + }, + '#azureFile':: d.obj(help='"azureFile represents an Azure File Service mount on the host and bind mount to the pod."'), + azureFile: { + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureFile+: { readOnly: readOnly } }, + '#withSecretName':: d.fn(help='"secretName is the name of secret that contains Azure Storage Account Name and Key"', args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { azureFile+: { secretName: secretName } }, + '#withShareName':: d.fn(help='"shareName is the azure share Name"', args=[d.arg(name='shareName', type=d.T.string)]), + withShareName(shareName): { azureFile+: { shareName: shareName } }, + }, + '#cephfs':: d.obj(help="\"cephFS represents a Ceph FS mount on the host that shares a pod's lifetime\""), + cephfs: { + '#secretRef':: d.obj(help='"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cephfs+: { secretRef+: { name: name } } }, + }, + '#withMonitors':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { cephfs+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { cephfs+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPath':: d.fn(help='"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { cephfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts.\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cephfs+: { readOnly: readOnly } }, + '#withSecretFile':: d.fn(help='"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='secretFile', type=d.T.string)]), + withSecretFile(secretFile): { cephfs+: { secretFile: secretFile } }, + '#withUser':: d.fn(help='"user is optional: User is the rados user name, default is admin\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { cephfs+: { user: user } }, + }, + '#cinder':: d.obj(help='"cinder represents a cinder volume attached and mounted on kubelets host machine.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"'), + cinder: { + '#secretRef':: d.obj(help='"secretRef is optional: points to a secret object containing parameters used to connect\\nto OpenStack."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cinder+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { cinder+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cinder+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID used to identify the volume in cinder.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { cinder+: { volumeID: volumeID } }, + }, + '#configMap':: d.obj(help='"configMap represents a configMap that should populate this volume"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is optional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDefaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { configMap+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#csi':: d.obj(help='"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)."'), + csi: { + '#nodePublishSecretRef':: d.obj(help='"nodePublishSecretRef is a reference to the secret object containing\\nsensitive information to pass to the CSI driver to complete the CSI\\nNodePublishVolume and NodeUnpublishVolume calls.\\nThis field is optional, and may be empty if no secret is required. If the\\nsecret object contains more than one secret, all secret references are passed."'), + nodePublishSecretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { csi+: { nodePublishSecretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the CSI driver that handles this volume.\\nConsult with your admin for the correct name as registered in the cluster."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { csi+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType to mount. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\".\\nIf not provided, the empty value is passed to the associated CSI driver\\nwhich will determine the default filesystem to apply."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { csi+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly specifies a read-only configuration for the volume.\\nDefaults to false (read/write)."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { csi+: { readOnly: readOnly } }, + '#withVolumeAttributes':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI\\ndriver. Consult your driver's documentation for supported values.\"", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributes(volumeAttributes): { csi+: { volumeAttributes: volumeAttributes } }, + '#withVolumeAttributesMixin':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI\\ndriver. Consult your driver's documentation for supported values.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributesMixin(volumeAttributes): { csi+: { volumeAttributes+: volumeAttributes } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI represents downward API about the pod that should populate this volume"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of downward API volume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value\\nbetween 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"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 '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"Optional: mode bits to use on created files by default. Must be a\\nOptional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDefaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { downwardAPI+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help='"Items is a list of downward API volume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of downward API volume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#emptyDir':: d.obj(help="\"emptyDir represents a temporary directory that shares a pod's lifetime.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\""), + emptyDir: { + '#withMedium':: d.fn(help="\"medium represents what type of storage medium should back this directory.\\nThe default is \\\"\\\" which means to use the node's default medium.\\nMust be an empty string (default) or Memory.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\"", args=[d.arg(name='medium', type=d.T.string)]), + withMedium(medium): { emptyDir+: { medium: medium } }, + '#withSizeLimit':: d.fn(help='"sizeLimit is the total amount of local storage required for this EmptyDir volume.\\nThe size limit is also applicable for memory medium.\\nThe maximum usage on memory medium EmptyDir would be the minimum value between\\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\\nThe default is nil which means that the limit is undefined.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"', args=[d.arg(name='sizeLimit', type=d.T.any)]), + withSizeLimit(sizeLimit): { emptyDir+: { sizeLimit: sizeLimit } }, + }, + '#ephemeral':: d.obj(help="\"ephemeral represents a volume that is handled by a cluster storage driver.\\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\\nand deleted when the pod is removed.\\n\\n\\nUse this if:\\na) the volume is only needed while the pod runs,\\nb) features of normal volumes like restoring from snapshot or capacity\\n tracking are needed,\\nc) the storage driver is specified through a storage class, and\\nd) the storage driver supports dynamic volume provisioning through\\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\\n information on the connection between this volume type\\n and PersistentVolumeClaim).\\n\\n\\nUse PersistentVolumeClaim or one of the vendor-specific\\nAPIs for volumes that persist for longer than the lifecycle\\nof an individual pod.\\n\\n\\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\\nbe used that way - see the documentation of the driver for\\nmore information.\\n\\n\\nA pod can use both types of ephemeral volumes and\\npersistent volumes at the same time.\""), + ephemeral: { + '#volumeClaimTemplate':: d.obj(help='"Will be used to create a stand-alone PVC to provision the volume.\\nThe pod in which this EphemeralVolumeSource is embedded will be the\\nowner of the PVC, i.e. the PVC will be deleted together with the\\npod. The name of the PVC will be `-` where\\n`` is the name from the `PodSpec.Volumes` array\\nentry. Pod validation will reject the pod if the concatenated name\\nis not valid for a PVC (for example, too long).\\n\\n\\nAn existing PVC with that name that is not owned by the pod\\nwill *not* be used for the pod to avoid using an unrelated\\nvolume by mistake. Starting the pod is then blocked until\\nthe unrelated PVC is removed. If such a pre-created PVC is\\nmeant to be used by the pod, the PVC has to updated with an\\nowner reference to the pod once the pod exists. Normally\\nthis should not be necessary, but it may be useful when\\nmanually reconstructing a broken cluster.\\n\\n\\nThis field is read-only and no changes will be made by Kubernetes\\nto the PVC after it has been created.\\n\\n\\nRequired, must not be nil."'), + volumeClaimTemplate: { + '#spec':: d.obj(help='"The specification for the PersistentVolumeClaim. The entire content is\\ncopied unchanged into the PVC that gets created from this\\ntemplate. The same fields as in a PersistentVolumeClaim\\nare also valid here."'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { ephemeral+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } }, + }, + '#withMetadata':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadata(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata: metadata } } }, + '#withMetadataMixin':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadataMixin(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata+: metadata } } }, + }, + }, + '#fc':: d.obj(help="\"fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\""), + fc: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { fc+: { fsType: fsType } }, + '#withLun':: d.fn(help='"lun is Optional: FC target lun number"', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { fc+: { lun: lun } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { fc+: { readOnly: readOnly } }, + '#withTargetWWNs':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNs(targetWWNs): { fc+: { targetWWNs: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withTargetWWNsMixin':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNsMixin(targetWWNs): { fc+: { targetWWNs+: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withWwids':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids)\\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously."', args=[d.arg(name='wwids', type=d.T.array)]), + withWwids(wwids): { fc+: { wwids: if std.isArray(v=wwids) then wwids else [wwids] } }, + '#withWwidsMixin':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids)\\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='wwids', type=d.T.array)]), + withWwidsMixin(wwids): { fc+: { wwids+: if std.isArray(v=wwids) then wwids else [wwids] } }, + }, + '#flexVolume':: d.obj(help='"flexVolume represents a generic volume resource that is\\nprovisioned/attached using an exec based plugin."'), + flexVolume: { + '#secretRef':: d.obj(help='"secretRef is Optional: secretRef is reference to the secret object containing\\nsensitive information to pass to the plugin scripts. This may be\\nempty if no secret object is specified. If the secret object\\ncontains more than one secret, all secrets are passed to the plugin\\nscripts."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { flexVolume+: { secretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the driver to use for this volume."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { flexVolume+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". The default filesystem depends on FlexVolume script."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { flexVolume+: { fsType: fsType } }, + '#withOptions':: d.fn(help='"options is Optional: this field holds extra command options if any."', args=[d.arg(name='options', type=d.T.object)]), + withOptions(options): { flexVolume+: { options: options } }, + '#withOptionsMixin':: d.fn(help='"options is Optional: this field holds extra command options if any."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='options', type=d.T.object)]), + withOptionsMixin(options): { flexVolume+: { options+: options } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { flexVolume+: { readOnly: readOnly } }, + }, + '#flocker':: d.obj(help="\"flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running\""), + flocker: { + '#withDatasetName':: d.fn(help='"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\\nshould be considered as deprecated"', args=[d.arg(name='datasetName', type=d.T.string)]), + withDatasetName(datasetName): { flocker+: { datasetName: datasetName } }, + '#withDatasetUUID':: d.fn(help='"datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset"', args=[d.arg(name='datasetUUID', type=d.T.string)]), + withDatasetUUID(datasetUUID): { flocker+: { datasetUUID: datasetUUID } }, + }, + '#gcePersistentDisk':: d.obj(help="\"gcePersistentDisk represents a GCE Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\""), + gcePersistentDisk: { + '#withFsType':: d.fn(help='"fsType is filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { gcePersistentDisk+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount.\\nIf omitted, the default is to mount by volume name.\\nExamples: For volume /dev/sda1, you specify the partition as \\"1\\".\\nSimilarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty).\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { gcePersistentDisk+: { partition: partition } }, + '#withPdName':: d.fn(help='"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='pdName', type=d.T.string)]), + withPdName(pdName): { gcePersistentDisk+: { pdName: pdName } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { gcePersistentDisk+: { readOnly: readOnly } }, + }, + '#gitRepo':: d.obj(help="\"gitRepo represents a git repository at a particular revision.\\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\\ninto the Pod's container.\""), + gitRepo: { + '#withDirectory':: d.fn(help="\"directory is the target directory name.\\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\\ngit repository. Otherwise, if specified, the volume will contain the git repository in\\nthe subdirectory with the given name.\"", args=[d.arg(name='directory', type=d.T.string)]), + withDirectory(directory): { gitRepo+: { directory: directory } }, + '#withRepository':: d.fn(help='"repository is the URL"', args=[d.arg(name='repository', type=d.T.string)]), + withRepository(repository): { gitRepo+: { repository: repository } }, + '#withRevision':: d.fn(help='"revision is the commit hash for the specified revision."', args=[d.arg(name='revision', type=d.T.string)]), + withRevision(revision): { gitRepo+: { revision: revision } }, + }, + '#glusterfs':: d.obj(help="\"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md\""), + glusterfs: { + '#withEndpoints':: d.fn(help='"endpoints is the endpoint name that details Glusterfs topology.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='endpoints', type=d.T.string)]), + withEndpoints(endpoints): { glusterfs+: { endpoints: endpoints } }, + '#withPath':: d.fn(help='"path is the Glusterfs volume path.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { glusterfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\\nDefaults to false.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { glusterfs+: { readOnly: readOnly } }, + }, + '#hostPath':: d.obj(help='"hostPath represents a pre-existing file or directory on the host\\nmachine that is directly exposed to the container. This is generally\\nused for system agents or other privileged things that are allowed\\nto see the host machine. Most containers will NOT need this.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\\n---\\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\\nmount host directories as read/write."'), + hostPath: { + '#withPath':: d.fn(help='"path of the directory on the host.\\nIf the path is a symlink, it will follow the link to the real path.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { hostPath+: { path: path } }, + '#withType':: d.fn(help='"type for HostPath Volume\\nDefaults to \\"\\"\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { hostPath+: { type: type } }, + }, + '#iscsi':: d.obj(help="\"iscsi represents an ISCSI Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://examples.k8s.io/volumes/iscsi/README.md\""), + iscsi: { + '#secretRef':: d.obj(help='"secretRef is the CHAP Secret for iSCSI target and initiator authentication"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { iscsi+: { secretRef+: { name: name } } }, + }, + '#withChapAuthDiscovery':: d.fn(help='"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication"', args=[d.arg(name='chapAuthDiscovery', type=d.T.boolean)]), + withChapAuthDiscovery(chapAuthDiscovery): { iscsi+: { chapAuthDiscovery: chapAuthDiscovery } }, + '#withChapAuthSession':: d.fn(help='"chapAuthSession defines whether support iSCSI Session CHAP authentication"', args=[d.arg(name='chapAuthSession', type=d.T.boolean)]), + withChapAuthSession(chapAuthSession): { iscsi+: { chapAuthSession: chapAuthSession } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { iscsi+: { fsType: fsType } }, + '#withInitiatorName':: d.fn(help='"initiatorName is the custom iSCSI Initiator Name.\\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\\n: will be created for the connection."', args=[d.arg(name='initiatorName', type=d.T.string)]), + withInitiatorName(initiatorName): { iscsi+: { initiatorName: initiatorName } }, + '#withIqn':: d.fn(help='"iqn is the target iSCSI Qualified Name."', args=[d.arg(name='iqn', type=d.T.string)]), + withIqn(iqn): { iscsi+: { iqn: iqn } }, + '#withIscsiInterface':: d.fn(help="\"iscsiInterface is the interface Name that uses an iSCSI transport.\\nDefaults to 'default' (tcp).\"", args=[d.arg(name='iscsiInterface', type=d.T.string)]), + withIscsiInterface(iscsiInterface): { iscsi+: { iscsiInterface: iscsiInterface } }, + '#withLun':: d.fn(help='"lun represents iSCSI Target Lun number."', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { iscsi+: { lun: lun } }, + '#withPortals':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='portals', type=d.T.array)]), + withPortals(portals): { iscsi+: { portals: if std.isArray(v=portals) then portals else [portals] } }, + '#withPortalsMixin':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='portals', type=d.T.array)]), + withPortalsMixin(portals): { iscsi+: { portals+: if std.isArray(v=portals) then portals else [portals] } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { iscsi+: { readOnly: readOnly } }, + '#withTargetPortal':: d.fn(help='"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='targetPortal', type=d.T.string)]), + withTargetPortal(targetPortal): { iscsi+: { targetPortal: targetPortal } }, + }, + '#nfs':: d.obj(help="\"nfs represents an NFS mount on the host that shares a pod's lifetime\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\""), + nfs: { + '#withPath':: d.fn(help='"path that is exported by the NFS server.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { nfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the NFS export to be mounted with read-only permissions.\\nDefaults to false.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { nfs+: { readOnly: readOnly } }, + '#withServer':: d.fn(help='"server is the hostname or IP address of the NFS server.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='server', type=d.T.string)]), + withServer(server): { nfs+: { server: server } }, + }, + '#persistentVolumeClaim':: d.obj(help='"persistentVolumeClaimVolumeSource represents a reference to a\\nPersistentVolumeClaim in the same namespace.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"'), + persistentVolumeClaim: { + '#withClaimName':: d.fn(help='"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"', args=[d.arg(name='claimName', type=d.T.string)]), + withClaimName(claimName): { persistentVolumeClaim+: { claimName: claimName } }, + '#withReadOnly':: d.fn(help='"readOnly Will force the ReadOnly setting in VolumeMounts.\\nDefault false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { persistentVolumeClaim+: { readOnly: readOnly } }, + }, + '#photonPersistentDisk':: d.obj(help='"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"'), + photonPersistentDisk: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { photonPersistentDisk+: { fsType: fsType } }, + '#withPdID':: d.fn(help='"pdID is the ID that identifies Photon Controller persistent disk"', args=[d.arg(name='pdID', type=d.T.string)]), + withPdID(pdID): { photonPersistentDisk+: { pdID: pdID } }, + }, + '#portworxVolume':: d.obj(help='"portworxVolume represents a portworx volume attached and mounted on kubelets host machine"'), + portworxVolume: { + '#withFsType':: d.fn(help='"fSType represents the filesystem type to mount\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { portworxVolume+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { portworxVolume+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID uniquely identifies a Portworx volume"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { portworxVolume+: { volumeID: volumeID } }, + }, + '#projected':: d.obj(help='"projected items for all in one resources secrets, configmaps, and downward API"'), + projected: { + '#sources':: d.obj(help='"sources is the list of volume projections"'), + sources: { + '#clusterTrustBundle':: d.obj(help='"ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\\nof ClusterTrustBundle objects in an auto-updating file.\\n\\n\\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\\n\\n\\nClusterTrustBundle objects can either be selected by name, or by the\\ncombination of signer name and a label selector.\\n\\n\\nKubelet performs aggressive normalization of the PEM contents written\\ninto the pod filesystem. Esoteric PEM features such as inter-block\\ncomments and block headers are stripped. Certificates are deduplicated.\\nThe ordering of certificates within the file is arbitrary, and Kubelet\\nmay change the order over time."'), + clusterTrustBundle: { + '#labelSelector':: d.obj(help='"Select all ClusterTrustBundles that match this label selector. Only has\\neffect if signerName is set. Mutually-exclusive with name. If unset,\\ninterpreted as \\"match nothing\\". If set but empty, interpreted as \\"match\\neverything\\"."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { clusterTrustBundle+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { clusterTrustBundle+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { clusterTrustBundle+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { clusterTrustBundle+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#withName':: d.fn(help='"Select a single ClusterTrustBundle by object name. Mutually-exclusive\\nwith signerName and labelSelector."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { clusterTrustBundle+: { name: name } }, + '#withOptional':: d.fn(help="\"If true, don't block pod startup if the referenced ClusterTrustBundle(s)\\naren't available. If using name, then the named ClusterTrustBundle is\\nallowed not to exist. If using signerName, then the combination of\\nsignerName and labelSelector is allowed to match zero\\nClusterTrustBundles.\"", args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { clusterTrustBundle+: { optional: optional } }, + '#withPath':: d.fn(help='"Relative path from the volume root to write the bundle."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { clusterTrustBundle+: { path: path } }, + '#withSignerName':: d.fn(help='"Select all ClusterTrustBundles that match this signer name.\\nMutually-exclusive with name. The contents of all selected\\nClusterTrustBundles will be unified and deduplicated."', args=[d.arg(name='signerName', type=d.T.string)]), + withSignerName(signerName): { clusterTrustBundle+: { signerName: signerName } }, + }, + '#configMap':: d.obj(help='"configMap information about the configMap data to project"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI information about the downwardAPI data to project"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of DownwardAPIVolume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value\\nbetween 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"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 '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help='"Items is a list of DownwardAPIVolume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of DownwardAPIVolume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#secret':: d.obj(help='"secret information about the secret data to project"'), + secret: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secret+: { name: name } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + }, + '#serviceAccountToken':: d.obj(help='"serviceAccountToken is information about the serviceAccountToken data to project"'), + serviceAccountToken: { + '#withAudience':: d.fn(help='"audience is the intended audience of the token. A recipient of a token\\nmust identify itself with an identifier specified in the audience of the\\ntoken, and otherwise should reject the token. The audience defaults to the\\nidentifier of the apiserver."', args=[d.arg(name='audience', type=d.T.string)]), + withAudience(audience): { serviceAccountToken+: { audience: audience } }, + '#withExpirationSeconds':: d.fn(help='"expirationSeconds is the requested duration of validity of the service\\naccount token. As the token approaches expiration, the kubelet volume\\nplugin will proactively rotate the service account token. The kubelet will\\nstart trying to rotate the token if the token is older than 80 percent of\\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\\nand must be at least 10 minutes."', args=[d.arg(name='expirationSeconds', type=d.T.integer)]), + withExpirationSeconds(expirationSeconds): { serviceAccountToken+: { expirationSeconds: expirationSeconds } }, + '#withPath':: d.fn(help='"path is the path relative to the mount point of the file to project the\\ntoken into."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { serviceAccountToken+: { path: path } }, + }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode are the mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { projected+: { defaultMode: defaultMode } }, + '#withSources':: d.fn(help='"sources is the list of volume projections"', args=[d.arg(name='sources', type=d.T.array)]), + withSources(sources): { projected+: { sources: if std.isArray(v=sources) then sources else [sources] } }, + '#withSourcesMixin':: d.fn(help='"sources is the list of volume projections"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sources', type=d.T.array)]), + withSourcesMixin(sources): { projected+: { sources+: if std.isArray(v=sources) then sources else [sources] } }, + }, + '#quobyte':: d.obj(help="\"quobyte represents a Quobyte mount on the host that shares a pod's lifetime\""), + quobyte: { + '#withGroup':: d.fn(help='"group to map volume access to\\nDefault is no group"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { quobyte+: { group: group } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Quobyte volume to be mounted with read-only permissions.\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { quobyte+: { readOnly: readOnly } }, + '#withRegistry':: d.fn(help='"registry represents a single or multiple Quobyte Registry services\\nspecified as a string as host:port pair (multiple entries are separated with commas)\\nwhich acts as the central registry for volumes"', args=[d.arg(name='registry', type=d.T.string)]), + withRegistry(registry): { quobyte+: { registry: registry } }, + '#withTenant':: d.fn(help='"tenant owning the given Quobyte volume in the Backend\\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin"', args=[d.arg(name='tenant', type=d.T.string)]), + withTenant(tenant): { quobyte+: { tenant: tenant } }, + '#withUser':: d.fn(help='"user to map volume access to\\nDefaults to serivceaccount user"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { quobyte+: { user: user } }, + '#withVolume':: d.fn(help='"volume is a string that references an already created Quobyte volume by name."', args=[d.arg(name='volume', type=d.T.string)]), + withVolume(volume): { quobyte+: { volume: volume } }, + }, + '#rbd':: d.obj(help="\"rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md\""), + rbd: { + '#secretRef':: d.obj(help='"secretRef is name of the authentication secret for RBDUser. If provided\\noverrides keyring.\\nDefault is nil.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { rbd+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { rbd+: { fsType: fsType } }, + '#withImage':: d.fn(help='"image is the rados image name.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { rbd+: { image: image } }, + '#withKeyring':: d.fn(help='"keyring is the path to key ring for RBDUser.\\nDefault is /etc/ceph/keyring.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='keyring', type=d.T.string)]), + withKeyring(keyring): { rbd+: { keyring: keyring } }, + '#withMonitors':: d.fn(help='"monitors is a collection of Ceph monitors.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { rbd+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is a collection of Ceph monitors.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { rbd+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPool':: d.fn(help='"pool is the rados pool name.\\nDefault is rbd.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='pool', type=d.T.string)]), + withPool(pool): { rbd+: { pool: pool } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { rbd+: { readOnly: readOnly } }, + '#withUser':: d.fn(help='"user is the rados user name.\\nDefault is admin.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { rbd+: { user: user } }, + }, + '#scaleIO':: d.obj(help='"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."'), + scaleIO: { + '#secretRef':: d.obj(help='"secretRef references to the secret for ScaleIO user and other\\nsensitive information. If this is not provided, Login operation will fail."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { scaleIO+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\".\\nDefault is \\"xfs\\"."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { scaleIO+: { fsType: fsType } }, + '#withGateway':: d.fn(help='"gateway is the host address of the ScaleIO API Gateway."', args=[d.arg(name='gateway', type=d.T.string)]), + withGateway(gateway): { scaleIO+: { gateway: gateway } }, + '#withProtectionDomain':: d.fn(help='"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage."', args=[d.arg(name='protectionDomain', type=d.T.string)]), + withProtectionDomain(protectionDomain): { scaleIO+: { protectionDomain: protectionDomain } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { scaleIO+: { readOnly: readOnly } }, + '#withSslEnabled':: d.fn(help='"sslEnabled Flag enable/disable SSL communication with Gateway, default false"', args=[d.arg(name='sslEnabled', type=d.T.boolean)]), + withSslEnabled(sslEnabled): { scaleIO+: { sslEnabled: sslEnabled } }, + '#withStorageMode':: d.fn(help='"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\\nDefault is ThinProvisioned."', args=[d.arg(name='storageMode', type=d.T.string)]), + withStorageMode(storageMode): { scaleIO+: { storageMode: storageMode } }, + '#withStoragePool':: d.fn(help='"storagePool is the ScaleIO Storage Pool associated with the protection domain."', args=[d.arg(name='storagePool', type=d.T.string)]), + withStoragePool(storagePool): { scaleIO+: { storagePool: storagePool } }, + '#withSystem':: d.fn(help='"system is the name of the storage system as configured in ScaleIO."', args=[d.arg(name='system', type=d.T.string)]), + withSystem(system): { scaleIO+: { system: system } }, + '#withVolumeName':: d.fn(help='"volumeName is the name of a volume already created in the ScaleIO system\\nthat is associated with this volume source."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { scaleIO+: { volumeName: volumeName } }, + }, + '#secret':: d.obj(help='"secret represents a secret that should populate this volume.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret"'), + secret: { + '#items':: d.obj(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is Optional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values\\nfor mode bits. Defaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { secret+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + '#withSecretName':: d.fn(help="\"secretName is the name of the secret in the pod's namespace to use.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\"", args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { secret+: { secretName: secretName } }, + }, + '#storageos':: d.obj(help='"storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."'), + storageos: { + '#secretRef':: d.obj(help='"secretRef specifies the secret to use for obtaining the StorageOS API\\ncredentials. If not specified, default values will be attempted."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storageos+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { storageos+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { storageos+: { readOnly: readOnly } }, + '#withVolumeName':: d.fn(help='"volumeName is the human-readable name of the StorageOS volume. Volume\\nnames are only unique within a namespace."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { storageos+: { volumeName: volumeName } }, + '#withVolumeNamespace':: d.fn(help="\"volumeNamespace specifies the scope of the volume within StorageOS. If no\\nnamespace is specified then the Pod's namespace will be used. This allows the\\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\\nSet VolumeName to any name to override the default behaviour.\\nSet to \\\"default\\\" if you are not using namespaces within StorageOS.\\nNamespaces that do not pre-exist within StorageOS will be created.\"", args=[d.arg(name='volumeNamespace', type=d.T.string)]), + withVolumeNamespace(volumeNamespace): { storageos+: { volumeNamespace: volumeNamespace } }, + }, + '#vsphereVolume':: d.obj(help='"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"'), + vsphereVolume: { + '#withFsType':: d.fn(help='"fsType is filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { vsphereVolume+: { fsType: fsType } }, + '#withStoragePolicyID':: d.fn(help='"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."', args=[d.arg(name='storagePolicyID', type=d.T.string)]), + withStoragePolicyID(storagePolicyID): { vsphereVolume+: { storagePolicyID: storagePolicyID } }, + '#withStoragePolicyName':: d.fn(help='"storagePolicyName is the storage Policy Based Management (SPBM) profile name."', args=[d.arg(name='storagePolicyName', type=d.T.string)]), + withStoragePolicyName(storagePolicyName): { vsphereVolume+: { storagePolicyName: storagePolicyName } }, + '#withVolumePath':: d.fn(help='"volumePath is the path that identifies vSphere volume vmdk"', args=[d.arg(name='volumePath', type=d.T.string)]), + withVolumePath(volumePath): { vsphereVolume+: { volumePath: volumePath } }, + }, + '#withName':: d.fn(help='"name of the volume.\\nMust be a DNS_LABEL and unique within the pod.\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#web':: d.obj(help='"Defines the configuration of the Prometheus web server."'), + web: { + '#httpConfig':: d.obj(help='"Defines HTTP parameters for web server."'), + httpConfig: { + '#headers':: d.obj(help='"List of headers that can be added to HTTP responses."'), + headers: { + '#withContentSecurityPolicy':: d.fn(help='"Set the Content-Security-Policy header to HTTP responses.\\nUnset if blank."', args=[d.arg(name='contentSecurityPolicy', type=d.T.string)]), + withContentSecurityPolicy(contentSecurityPolicy): { spec+: { web+: { httpConfig+: { headers+: { contentSecurityPolicy: contentSecurityPolicy } } } } }, + '#withStrictTransportSecurity':: d.fn(help='"Set the Strict-Transport-Security header to HTTP responses.\\nUnset if blank.\\nPlease make sure that you use this with care as this header might force\\nbrowsers to load Prometheus and the other applications hosted on the same\\ndomain and subdomains over HTTPS.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security"', args=[d.arg(name='strictTransportSecurity', type=d.T.string)]), + withStrictTransportSecurity(strictTransportSecurity): { spec+: { web+: { httpConfig+: { headers+: { strictTransportSecurity: strictTransportSecurity } } } } }, + '#withXContentTypeOptions':: d.fn(help='"Set the X-Content-Type-Options header to HTTP responses.\\nUnset if blank. Accepted value is nosniff.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options"', args=[d.arg(name='xContentTypeOptions', type=d.T.string)]), + withXContentTypeOptions(xContentTypeOptions): { spec+: { web+: { httpConfig+: { headers+: { xContentTypeOptions: xContentTypeOptions } } } } }, + '#withXFrameOptions':: d.fn(help='"Set the X-Frame-Options header to HTTP responses.\\nUnset if blank. Accepted values are deny and sameorigin.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options"', args=[d.arg(name='xFrameOptions', type=d.T.string)]), + withXFrameOptions(xFrameOptions): { spec+: { web+: { httpConfig+: { headers+: { xFrameOptions: xFrameOptions } } } } }, + '#withXXSSProtection':: d.fn(help='"Set the X-XSS-Protection header to all responses.\\nUnset if blank.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection"', args=[d.arg(name='xXSSProtection', type=d.T.string)]), + withXXSSProtection(xXSSProtection): { spec+: { web+: { httpConfig+: { headers+: { xXSSProtection: xXSSProtection } } } } }, + }, + '#withHttp2':: d.fn(help='"Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\\nWhenever the value of the field changes, a rolling update will be triggered."', args=[d.arg(name='http2', type=d.T.boolean)]), + withHttp2(http2): { spec+: { web+: { httpConfig+: { http2: http2 } } } }, + }, + '#tlsConfig':: d.obj(help='"Defines the TLS parameters for HTTPS."'), + tlsConfig: { + '#cert':: d.obj(help='"Contains the TLS certificate for the server."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#client_ca':: d.obj(help='"Contains the CA certificate for client certificate authentication to the server."'), + client_ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the TLS key for the server."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withCipherSuites':: d.fn(help='"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\\nGo default cipher suites are used. Available cipher suites are documented\\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"', args=[d.arg(name='cipherSuites', type=d.T.array)]), + withCipherSuites(cipherSuites): { spec+: { web+: { tlsConfig+: { cipherSuites: if std.isArray(v=cipherSuites) then cipherSuites else [cipherSuites] } } } }, + '#withCipherSuitesMixin':: d.fn(help='"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\\nGo default cipher suites are used. Available cipher suites are documented\\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='cipherSuites', type=d.T.array)]), + withCipherSuitesMixin(cipherSuites): { spec+: { web+: { tlsConfig+: { cipherSuites+: if std.isArray(v=cipherSuites) then cipherSuites else [cipherSuites] } } } }, + '#withClientAuthType':: d.fn(help='"Server policy for client authentication. Maps to ClientAuth Policies.\\nFor more detail on clientAuth options:\\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType"', args=[d.arg(name='clientAuthType', type=d.T.string)]), + withClientAuthType(clientAuthType): { spec+: { web+: { tlsConfig+: { clientAuthType: clientAuthType } } } }, + '#withCurvePreferences':: d.fn(help='"Elliptic curves that will be used in an ECDHE handshake, in preference\\norder. Available curves are documented in the go documentation:\\nhttps://golang.org/pkg/crypto/tls/#CurveID"', args=[d.arg(name='curvePreferences', type=d.T.array)]), + withCurvePreferences(curvePreferences): { spec+: { web+: { tlsConfig+: { curvePreferences: if std.isArray(v=curvePreferences) then curvePreferences else [curvePreferences] } } } }, + '#withCurvePreferencesMixin':: d.fn(help='"Elliptic curves that will be used in an ECDHE handshake, in preference\\norder. Available curves are documented in the go documentation:\\nhttps://golang.org/pkg/crypto/tls/#CurveID"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='curvePreferences', type=d.T.array)]), + withCurvePreferencesMixin(curvePreferences): { spec+: { web+: { tlsConfig+: { curvePreferences+: if std.isArray(v=curvePreferences) then curvePreferences else [curvePreferences] } } } }, + '#withMaxVersion':: d.fn(help='"Maximum TLS version that is acceptable. Defaults to TLS13."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { web+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum TLS version that is acceptable. Defaults to TLS12."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { web+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withPreferServerCipherSuites':: d.fn(help="\"Controls whether the server selects the\\nclient's most preferred cipher suite, or the server's most preferred\\ncipher suite. If true then the server's preference, as expressed in\\nthe order of elements in cipherSuites, is used.\"", args=[d.arg(name='preferServerCipherSuites', type=d.T.boolean)]), + withPreferServerCipherSuites(preferServerCipherSuites): { spec+: { web+: { tlsConfig+: { preferServerCipherSuites: preferServerCipherSuites } } } }, + }, + '#withMaxConnections':: d.fn(help="\"Defines the maximum number of simultaneous connections\\nA zero value means that Prometheus doesn't accept any incoming connection.\"", args=[d.arg(name='maxConnections', type=d.T.integer)]), + withMaxConnections(maxConnections): { spec+: { web+: { maxConnections: maxConnections } } }, + '#withPageTitle':: d.fn(help='"The prometheus web page title."', args=[d.arg(name='pageTitle', type=d.T.string)]), + withPageTitle(pageTitle): { spec+: { web+: { pageTitle: pageTitle } } }, + }, + '#withAdditionalArgs':: d.fn(help="\"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\\n\\n\\nIt is intended for e.g. activating hidden flags which are not supported by\\nthe dedicated configuration options yet. The arguments are passed as-is to the\\nPrometheus container which may cause issues if they are invalid or not supported\\nby the given Prometheus version.\\n\\n\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument, the reconciliation will\\nfail and an error will be logged.\"", args=[d.arg(name='additionalArgs', type=d.T.array)]), + withAdditionalArgs(additionalArgs): { spec+: { additionalArgs: if std.isArray(v=additionalArgs) then additionalArgs else [additionalArgs] } }, + '#withAdditionalArgsMixin':: d.fn(help="\"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\\n\\n\\nIt is intended for e.g. activating hidden flags which are not supported by\\nthe dedicated configuration options yet. The arguments are passed as-is to the\\nPrometheus container which may cause issues if they are invalid or not supported\\nby the given Prometheus version.\\n\\n\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument, the reconciliation will\\nfail and an error will be logged.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='additionalArgs', type=d.T.array)]), + withAdditionalArgsMixin(additionalArgs): { spec+: { additionalArgs+: if std.isArray(v=additionalArgs) then additionalArgs else [additionalArgs] } }, + '#withAllowOverlappingBlocks':: d.fn(help='"AllowOverlappingBlocks enables vertical compaction and vertical query\\nmerge in Prometheus.\\n\\n\\nDeprecated: this flag has no effect for Prometheus >= 2.39.0 where overlapping blocks are enabled by default."', args=[d.arg(name='allowOverlappingBlocks', type=d.T.boolean)]), + withAllowOverlappingBlocks(allowOverlappingBlocks): { spec+: { allowOverlappingBlocks: allowOverlappingBlocks } }, + '#withAutomountServiceAccountToken':: d.fn(help="\"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\\nIf the field isn't set, the operator mounts the service account token by default.\\n\\n\\n**Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery.\\nIt is possible to use strategic merge patch to project the service account token into the 'prometheus' container.\"", args=[d.arg(name='automountServiceAccountToken', type=d.T.boolean)]), + withAutomountServiceAccountToken(automountServiceAccountToken): { spec+: { automountServiceAccountToken: automountServiceAccountToken } }, + '#withBaseImage':: d.fn(help="\"Deprecated: use 'spec.image' instead.\"", args=[d.arg(name='baseImage', type=d.T.string)]), + withBaseImage(baseImage): { spec+: { baseImage: baseImage } }, + '#withBodySizeLimit':: d.fn(help="\"BodySizeLimit defines per-scrape on response body size.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.\"", args=[d.arg(name='bodySizeLimit', type=d.T.string)]), + withBodySizeLimit(bodySizeLimit): { spec+: { bodySizeLimit: bodySizeLimit } }, + '#withConfigMaps':: d.fn(help="\"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\\nobject, which shall be mounted into the Prometheus Pods.\\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-\u003cconfigmap-name\u003e`.\\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/\u003cconfigmap-name\u003e in the 'prometheus' container.\"", args=[d.arg(name='configMaps', type=d.T.array)]), + withConfigMaps(configMaps): { spec+: { configMaps: if std.isArray(v=configMaps) then configMaps else [configMaps] } }, + '#withConfigMapsMixin':: d.fn(help="\"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\\nobject, which shall be mounted into the Prometheus Pods.\\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-\u003cconfigmap-name\u003e`.\\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/\u003cconfigmap-name\u003e in the 'prometheus' container.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='configMaps', type=d.T.array)]), + withConfigMapsMixin(configMaps): { spec+: { configMaps+: if std.isArray(v=configMaps) then configMaps else [configMaps] } }, + '#withContainers':: d.fn(help='"Containers allows injecting additional containers or modifying operator\\ngenerated containers. This can be used to allow adding an authentication\\nproxy to the Pods or to change the behavior of an operator generated\\ncontainer. Containers described here modify an operator generated\\ncontainer if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of containers managed by the operator are:\\n* `prometheus`\\n* `config-reloader`\\n* `thanos-sidecar`\\n\\n\\nOverriding containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."', args=[d.arg(name='containers', type=d.T.array)]), + withContainers(containers): { spec+: { containers: if std.isArray(v=containers) then containers else [containers] } }, + '#withContainersMixin':: d.fn(help='"Containers allows injecting additional containers or modifying operator\\ngenerated containers. This can be used to allow adding an authentication\\nproxy to the Pods or to change the behavior of an operator generated\\ncontainer. Containers described here modify an operator generated\\ncontainer if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of containers managed by the operator are:\\n* `prometheus`\\n* `config-reloader`\\n* `thanos-sidecar`\\n\\n\\nOverriding containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='containers', type=d.T.array)]), + withContainersMixin(containers): { spec+: { containers+: if std.isArray(v=containers) then containers else [containers] } }, + '#withDisableCompaction':: d.fn(help='"When true, the Prometheus compaction is disabled."', args=[d.arg(name='disableCompaction', type=d.T.boolean)]), + withDisableCompaction(disableCompaction): { spec+: { disableCompaction: disableCompaction } }, + '#withEnableAdminAPI':: d.fn(help='"Enables access to the Prometheus web admin API.\\n\\n\\nWARNING: Enabling the admin APIs enables mutating endpoints, to delete data,\\nshutdown Prometheus, and more. Enabling this should be done with care and the\\nuser is advised to add additional authentication authorization via a proxy to\\nensure only clients authorized to perform these actions can do so.\\n\\n\\nFor more information:\\nhttps://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis"', args=[d.arg(name='enableAdminAPI', type=d.T.boolean)]), + withEnableAdminAPI(enableAdminAPI): { spec+: { enableAdminAPI: enableAdminAPI } }, + '#withEnableFeatures':: d.fn(help='"Enable access to Prometheus feature flags. By default, no features are enabled.\\n\\n\\nEnabling features which are disabled by default is entirely outside the\\nscope of what the maintainers will support and by doing so, you accept\\nthat this behaviour may break at any time without notice.\\n\\n\\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/"', args=[d.arg(name='enableFeatures', type=d.T.array)]), + withEnableFeatures(enableFeatures): { spec+: { enableFeatures: if std.isArray(v=enableFeatures) then enableFeatures else [enableFeatures] } }, + '#withEnableFeaturesMixin':: d.fn(help='"Enable access to Prometheus feature flags. By default, no features are enabled.\\n\\n\\nEnabling features which are disabled by default is entirely outside the\\nscope of what the maintainers will support and by doing so, you accept\\nthat this behaviour may break at any time without notice.\\n\\n\\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='enableFeatures', type=d.T.array)]), + withEnableFeaturesMixin(enableFeatures): { spec+: { enableFeatures+: if std.isArray(v=enableFeatures) then enableFeatures else [enableFeatures] } }, + '#withEnableRemoteWriteReceiver':: d.fn(help='"Enable Prometheus to be used as a receiver for the Prometheus remote\\nwrite protocol.\\n\\n\\nWARNING: This is not considered an efficient way of ingesting samples.\\nUse it with caution for specific low-volume use cases.\\nIt is not suitable for replacing the ingestion via scraping and turning\\nPrometheus into a push-based metrics collection system.\\nFor more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver\\n\\n\\nIt requires Prometheus >= v2.33.0."', args=[d.arg(name='enableRemoteWriteReceiver', type=d.T.boolean)]), + withEnableRemoteWriteReceiver(enableRemoteWriteReceiver): { spec+: { enableRemoteWriteReceiver: enableRemoteWriteReceiver } }, + '#withEnforcedBodySizeLimit':: d.fn(help='"When defined, enforcedBodySizeLimit specifies a global limit on the size\\nof uncompressed response body that will be accepted by Prometheus.\\nTargets responding with a body larger than this many bytes will cause\\nthe scrape to fail.\\n\\n\\nIt requires Prometheus >= v2.28.0.\\n\\n\\nWhen both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.\\n* Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value.\\n* Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit."', args=[d.arg(name='enforcedBodySizeLimit', type=d.T.string)]), + withEnforcedBodySizeLimit(enforcedBodySizeLimit): { spec+: { enforcedBodySizeLimit: enforcedBodySizeLimit } }, + '#withEnforcedKeepDroppedTargets':: d.fn(help='"When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets\\ndropped by relabeling that will be kept in memory. The value overrides\\nany `spec.keepDroppedTargets` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is\\ngreater than zero and less than `spec.enforcedKeepDroppedTargets`.\\n\\n\\nIt requires Prometheus >= v2.47.0.\\n\\n\\nWhen both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.\\n* Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value.\\n* Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets."', args=[d.arg(name='enforcedKeepDroppedTargets', type=d.T.integer)]), + withEnforcedKeepDroppedTargets(enforcedKeepDroppedTargets): { spec+: { enforcedKeepDroppedTargets: enforcedKeepDroppedTargets } }, + '#withEnforcedLabelLimit':: d.fn(help='"When defined, enforcedLabelLimit specifies a global limit on the number\\nof labels per sample. The value overrides any `spec.labelLimit` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is\\ngreater than zero and less than `spec.enforcedLabelLimit`.\\n\\n\\nIt requires Prometheus >= v2.27.0.\\n\\n\\nWhen both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.\\n* Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value.\\n* Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit."', args=[d.arg(name='enforcedLabelLimit', type=d.T.integer)]), + withEnforcedLabelLimit(enforcedLabelLimit): { spec+: { enforcedLabelLimit: enforcedLabelLimit } }, + '#withEnforcedLabelNameLengthLimit':: d.fn(help='"When defined, enforcedLabelNameLengthLimit specifies a global limit on the length\\nof labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is\\ngreater than zero and less than `spec.enforcedLabelNameLengthLimit`.\\n\\n\\nIt requires Prometheus >= v2.27.0.\\n\\n\\nWhen both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.\\n* Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value.\\n* Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit."', args=[d.arg(name='enforcedLabelNameLengthLimit', type=d.T.integer)]), + withEnforcedLabelNameLengthLimit(enforcedLabelNameLengthLimit): { spec+: { enforcedLabelNameLengthLimit: enforcedLabelNameLengthLimit } }, + '#withEnforcedLabelValueLengthLimit':: d.fn(help='"When not null, enforcedLabelValueLengthLimit defines a global limit on the length\\nof labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is\\ngreater than zero and less than `spec.enforcedLabelValueLengthLimit`.\\n\\n\\nIt requires Prometheus >= v2.27.0.\\n\\n\\nWhen both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.\\n* Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value.\\n* Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit."', args=[d.arg(name='enforcedLabelValueLengthLimit', type=d.T.integer)]), + withEnforcedLabelValueLengthLimit(enforcedLabelValueLengthLimit): { spec+: { enforcedLabelValueLengthLimit: enforcedLabelValueLengthLimit } }, + '#withEnforcedNamespaceLabel':: d.fn(help="\"When not empty, a label will be added to:\\n\\n\\n1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects.\\n2. All metrics generated from recording rules defined in `PrometheusRule` objects.\\n3. All alerts generated from alerting rules defined in `PrometheusRule` objects.\\n4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.\\n\\n\\nThe label will not added for objects referenced in `spec.excludedFromEnforcement`.\\n\\n\\nThe label's name is this field's value.\\nThe label's value is the namespace of the `ServiceMonitor`,\\n`PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object.\"", args=[d.arg(name='enforcedNamespaceLabel', type=d.T.string)]), + withEnforcedNamespaceLabel(enforcedNamespaceLabel): { spec+: { enforcedNamespaceLabel: enforcedNamespaceLabel } }, + '#withEnforcedSampleLimit':: d.fn(help='"When defined, enforcedSampleLimit specifies a global limit on the number\\nof scraped samples that will be accepted. This overrides any\\n`spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects\\nunless `spec.sampleLimit` is greater than zero and less than\\n`spec.enforcedSampleLimit`.\\n\\n\\nIt is meant to be used by admins to keep the overall number of\\nsamples/series under a desired limit.\\n\\n\\nWhen both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.\\n* Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value.\\n* Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit."', args=[d.arg(name='enforcedSampleLimit', type=d.T.integer)]), + withEnforcedSampleLimit(enforcedSampleLimit): { spec+: { enforcedSampleLimit: enforcedSampleLimit } }, + '#withEnforcedTargetLimit':: d.fn(help='"When defined, enforcedTargetLimit specifies a global limit on the number\\nof scraped targets. The value overrides any `spec.targetLimit` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is\\ngreater than zero and less than `spec.enforcedTargetLimit`.\\n\\n\\nIt is meant to be used by admins to to keep the overall number of\\ntargets under a desired limit.\\n\\n\\nWhen both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.\\n* Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value.\\n* Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit."', args=[d.arg(name='enforcedTargetLimit', type=d.T.integer)]), + withEnforcedTargetLimit(enforcedTargetLimit): { spec+: { enforcedTargetLimit: enforcedTargetLimit } }, + '#withEvaluationInterval':: d.fn(help='"Interval between rule evaluations.\\nDefault: \\"30s\\', args=[d.arg(name='evaluationInterval', type=d.T.string)]), + withEvaluationInterval(evaluationInterval): { spec+: { evaluationInterval: evaluationInterval } }, + '#withExcludedFromEnforcement':: d.fn(help='"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\\nto be excluded from enforcing a namespace label of origin.\\n\\n\\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true."', args=[d.arg(name='excludedFromEnforcement', type=d.T.array)]), + withExcludedFromEnforcement(excludedFromEnforcement): { spec+: { excludedFromEnforcement: if std.isArray(v=excludedFromEnforcement) then excludedFromEnforcement else [excludedFromEnforcement] } }, + '#withExcludedFromEnforcementMixin':: d.fn(help='"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\\nto be excluded from enforcing a namespace label of origin.\\n\\n\\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='excludedFromEnforcement', type=d.T.array)]), + withExcludedFromEnforcementMixin(excludedFromEnforcement): { spec+: { excludedFromEnforcement+: if std.isArray(v=excludedFromEnforcement) then excludedFromEnforcement else [excludedFromEnforcement] } }, + '#withExternalLabels':: d.fn(help='"The labels to add to any time series or alerts when communicating with\\nexternal systems (federation, remote storage, Alertmanager).\\nLabels defined by `spec.replicaExternalLabelName` and\\n`spec.prometheusExternalLabelName` take precedence over this list."', args=[d.arg(name='externalLabels', type=d.T.object)]), + withExternalLabels(externalLabels): { spec+: { externalLabels: externalLabels } }, + '#withExternalLabelsMixin':: d.fn(help='"The labels to add to any time series or alerts when communicating with\\nexternal systems (federation, remote storage, Alertmanager).\\nLabels defined by `spec.replicaExternalLabelName` and\\n`spec.prometheusExternalLabelName` take precedence over this list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='externalLabels', type=d.T.object)]), + withExternalLabelsMixin(externalLabels): { spec+: { externalLabels+: externalLabels } }, + '#withExternalUrl':: d.fn(help='"The external URL under which the Prometheus service is externally\\navailable. This is necessary to generate correct URLs (for instance if\\nPrometheus is accessible behind an Ingress resource)."', args=[d.arg(name='externalUrl', type=d.T.string)]), + withExternalUrl(externalUrl): { spec+: { externalUrl: externalUrl } }, + '#withHostAliases':: d.fn(help="\"Optional list of hosts and IPs that will be injected into the Pod's\\nhosts file if specified.\"", args=[d.arg(name='hostAliases', type=d.T.array)]), + withHostAliases(hostAliases): { spec+: { hostAliases: if std.isArray(v=hostAliases) then hostAliases else [hostAliases] } }, + '#withHostAliasesMixin':: d.fn(help="\"Optional list of hosts and IPs that will be injected into the Pod's\\nhosts file if specified.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='hostAliases', type=d.T.array)]), + withHostAliasesMixin(hostAliases): { spec+: { hostAliases+: if std.isArray(v=hostAliases) then hostAliases else [hostAliases] } }, + '#withHostNetwork':: d.fn(help="\"Use the host's network namespace if true.\\n\\n\\nMake sure to understand the security implications if you want to enable\\nit (https://kubernetes.io/docs/concepts/configuration/overview/).\\n\\n\\nWhen hostNetwork is enabled, this will set the DNS policy to\\n`ClusterFirstWithHostNet` automatically.\"", args=[d.arg(name='hostNetwork', type=d.T.boolean)]), + withHostNetwork(hostNetwork): { spec+: { hostNetwork: hostNetwork } }, + '#withIgnoreNamespaceSelectors':: d.fn(help='"When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor\\nand Probe objects will be ignored. They will only discover targets\\nwithin the namespace of the PodMonitor, ServiceMonitor and Probe\\nobject."', args=[d.arg(name='ignoreNamespaceSelectors', type=d.T.boolean)]), + withIgnoreNamespaceSelectors(ignoreNamespaceSelectors): { spec+: { ignoreNamespaceSelectors: ignoreNamespaceSelectors } }, + '#withImage':: d.fn(help='"Container image name for Prometheus. If specified, it takes precedence\\nover the `spec.baseImage`, `spec.tag` and `spec.sha` fields.\\n\\n\\nSpecifying `spec.version` is still necessary to ensure the Prometheus\\nOperator knows which version of Prometheus is being configured.\\n\\n\\nIf neither `spec.image` nor `spec.baseImage` are defined, the operator\\nwill use the latest upstream version of Prometheus available at the time\\nwhen the operator was released."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { spec+: { image: image } }, + '#withImagePullPolicy':: d.fn(help="\"Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers.\\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.\"", args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { spec+: { imagePullPolicy: imagePullPolicy } }, + '#withImagePullSecrets':: d.fn(help='"An optional list of references to Secrets in the same namespace\\nto use for pulling images from registries.\\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"', args=[d.arg(name='imagePullSecrets', type=d.T.array)]), + withImagePullSecrets(imagePullSecrets): { spec+: { imagePullSecrets: if std.isArray(v=imagePullSecrets) then imagePullSecrets else [imagePullSecrets] } }, + '#withImagePullSecretsMixin':: d.fn(help='"An optional list of references to Secrets in the same namespace\\nto use for pulling images from registries.\\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='imagePullSecrets', type=d.T.array)]), + withImagePullSecretsMixin(imagePullSecrets): { spec+: { imagePullSecrets+: if std.isArray(v=imagePullSecrets) then imagePullSecrets else [imagePullSecrets] } }, + '#withInitContainers':: d.fn(help='"InitContainers allows injecting initContainers to the Pod definition. Those\\ncan be used to e.g. fetch secrets for injection into the Prometheus\\nconfiguration from external sources. Any errors during the execution of\\nan initContainer will lead to a restart of the Pod. More info:\\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nInitContainers described here modify an operator generated init\\ncontainers if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of init container name managed by the operator are:\\n* `init-config-reloader`.\\n\\n\\nOverriding init containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainers(initContainers): { spec+: { initContainers: if std.isArray(v=initContainers) then initContainers else [initContainers] } }, + '#withInitContainersMixin':: d.fn(help='"InitContainers allows injecting initContainers to the Pod definition. Those\\ncan be used to e.g. fetch secrets for injection into the Prometheus\\nconfiguration from external sources. Any errors during the execution of\\nan initContainer will lead to a restart of the Pod. More info:\\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nInitContainers described here modify an operator generated init\\ncontainers if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of init container name managed by the operator are:\\n* `init-config-reloader`.\\n\\n\\nOverriding init containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainersMixin(initContainers): { spec+: { initContainers+: if std.isArray(v=initContainers) then initContainers else [initContainers] } }, + '#withKeepDroppedTargets':: d.fn(help="\"Per-scrape limit on the number of targets dropped by relabeling\\nthat will be kept in memory. 0 means no limit.\\n\\n\\nIt requires Prometheus \u003e= v2.47.0.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.\"", args=[d.arg(name='keepDroppedTargets', type=d.T.integer)]), + withKeepDroppedTargets(keepDroppedTargets): { spec+: { keepDroppedTargets: keepDroppedTargets } }, + '#withLabelLimit':: d.fn(help="\"Per-scrape limit on number of labels that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.\"", args=[d.arg(name='labelLimit', type=d.T.integer)]), + withLabelLimit(labelLimit): { spec+: { labelLimit: labelLimit } }, + '#withLabelNameLengthLimit':: d.fn(help="\"Per-scrape limit on length of labels name that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.\"", args=[d.arg(name='labelNameLengthLimit', type=d.T.integer)]), + withLabelNameLengthLimit(labelNameLengthLimit): { spec+: { labelNameLengthLimit: labelNameLengthLimit } }, + '#withLabelValueLengthLimit':: d.fn(help="\"Per-scrape limit on length of labels value that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.\"", args=[d.arg(name='labelValueLengthLimit', type=d.T.integer)]), + withLabelValueLengthLimit(labelValueLengthLimit): { spec+: { labelValueLengthLimit: labelValueLengthLimit } }, + '#withListenLocal':: d.fn(help="\"When true, the Prometheus server listens on the loopback address\\ninstead of the Pod IP's address.\"", args=[d.arg(name='listenLocal', type=d.T.boolean)]), + withListenLocal(listenLocal): { spec+: { listenLocal: listenLocal } }, + '#withLogFormat':: d.fn(help='"Log format for Log level for Prometheus and the config-reloader sidecar."', args=[d.arg(name='logFormat', type=d.T.string)]), + withLogFormat(logFormat): { spec+: { logFormat: logFormat } }, + '#withLogLevel':: d.fn(help='"Log level for Prometheus and the config-reloader sidecar."', args=[d.arg(name='logLevel', type=d.T.string)]), + withLogLevel(logLevel): { spec+: { logLevel: logLevel } }, + '#withMaximumStartupDurationSeconds':: d.fn(help="\"Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete.\\nIf set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes).\"", args=[d.arg(name='maximumStartupDurationSeconds', type=d.T.integer)]), + withMaximumStartupDurationSeconds(maximumStartupDurationSeconds): { spec+: { maximumStartupDurationSeconds: maximumStartupDurationSeconds } }, + '#withMinReadySeconds':: d.fn(help='"Minimum number of seconds for which a newly created Pod should be ready\\nwithout any of its container crashing for it to be considered available.\\nDefaults to 0 (pod will be considered available as soon as it is ready)\\n\\n\\nThis is an alpha field from kubernetes 1.22 until 1.24 which requires\\nenabling the StatefulSetMinReadySeconds feature gate."', args=[d.arg(name='minReadySeconds', type=d.T.integer)]), + withMinReadySeconds(minReadySeconds): { spec+: { minReadySeconds: minReadySeconds } }, + '#withNodeSelector':: d.fn(help='"Defines on which Nodes the Pods are scheduled."', args=[d.arg(name='nodeSelector', type=d.T.object)]), + withNodeSelector(nodeSelector): { spec+: { nodeSelector: nodeSelector } }, + '#withNodeSelectorMixin':: d.fn(help='"Defines on which Nodes the Pods are scheduled."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeSelector', type=d.T.object)]), + withNodeSelectorMixin(nodeSelector): { spec+: { nodeSelector+: nodeSelector } }, + '#withOverrideHonorLabels':: d.fn(help='"When true, Prometheus resolves label conflicts by renaming the labels in the scraped data\\n to “exported_” for all targets created from ServiceMonitor, PodMonitor and\\nScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies.\\nIn practice,`overrideHonorLaels:true` enforces `honorLabels:false`\\nfor all ServiceMonitor, PodMonitor and ScrapeConfig objects."', args=[d.arg(name='overrideHonorLabels', type=d.T.boolean)]), + withOverrideHonorLabels(overrideHonorLabels): { spec+: { overrideHonorLabels: overrideHonorLabels } }, + '#withOverrideHonorTimestamps':: d.fn(help='"When true, Prometheus ignores the timestamps for all the targets created\\nfrom service and pod monitors.\\nOtherwise the HonorTimestamps field of the service or pod monitor applies."', args=[d.arg(name='overrideHonorTimestamps', type=d.T.boolean)]), + withOverrideHonorTimestamps(overrideHonorTimestamps): { spec+: { overrideHonorTimestamps: overrideHonorTimestamps } }, + '#withPaused':: d.fn(help='"When a Prometheus deployment is paused, no actions except for deletion\\nwill be performed on the underlying objects."', args=[d.arg(name='paused', type=d.T.boolean)]), + withPaused(paused): { spec+: { paused: paused } }, + '#withPodTargetLabels':: d.fn(help='"PodTargetLabels are appended to the `spec.podTargetLabels` field of all\\nPodMonitor and ServiceMonitor objects."', args=[d.arg(name='podTargetLabels', type=d.T.array)]), + withPodTargetLabels(podTargetLabels): { spec+: { podTargetLabels: if std.isArray(v=podTargetLabels) then podTargetLabels else [podTargetLabels] } }, + '#withPodTargetLabelsMixin':: d.fn(help='"PodTargetLabels are appended to the `spec.podTargetLabels` field of all\\nPodMonitor and ServiceMonitor objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podTargetLabels', type=d.T.array)]), + withPodTargetLabelsMixin(podTargetLabels): { spec+: { podTargetLabels+: if std.isArray(v=podTargetLabels) then podTargetLabels else [podTargetLabels] } }, + '#withPortName':: d.fn(help='"Port name used for the pods and governing service.\\nDefault: \\"web\\', args=[d.arg(name='portName', type=d.T.string)]), + withPortName(portName): { spec+: { portName: portName } }, + '#withPriorityClassName':: d.fn(help='"Priority class assigned to the Pods."', args=[d.arg(name='priorityClassName', type=d.T.string)]), + withPriorityClassName(priorityClassName): { spec+: { priorityClassName: priorityClassName } }, + '#withPrometheusExternalLabelName':: d.fn(help='"Name of Prometheus external label used to denote the Prometheus instance\\nname. The external label will _not_ be added when the field is set to\\nthe empty string (`\\"\\"`).\\n\\n\\nDefault: \\"prometheus\\', args=[d.arg(name='prometheusExternalLabelName', type=d.T.string)]), + withPrometheusExternalLabelName(prometheusExternalLabelName): { spec+: { prometheusExternalLabelName: prometheusExternalLabelName } }, + '#withPrometheusRulesExcludedFromEnforce':: d.fn(help="\"Defines the list of PrometheusRule objects to which the namespace label\\nenforcement doesn't apply.\\nThis is only relevant when `spec.enforcedNamespaceLabel` is set to true.\\nDeprecated: use `spec.excludedFromEnforcement` instead.\"", args=[d.arg(name='prometheusRulesExcludedFromEnforce', type=d.T.array)]), + withPrometheusRulesExcludedFromEnforce(prometheusRulesExcludedFromEnforce): { spec+: { prometheusRulesExcludedFromEnforce: if std.isArray(v=prometheusRulesExcludedFromEnforce) then prometheusRulesExcludedFromEnforce else [prometheusRulesExcludedFromEnforce] } }, + '#withPrometheusRulesExcludedFromEnforceMixin':: d.fn(help="\"Defines the list of PrometheusRule objects to which the namespace label\\nenforcement doesn't apply.\\nThis is only relevant when `spec.enforcedNamespaceLabel` is set to true.\\nDeprecated: use `spec.excludedFromEnforcement` instead.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='prometheusRulesExcludedFromEnforce', type=d.T.array)]), + withPrometheusRulesExcludedFromEnforceMixin(prometheusRulesExcludedFromEnforce): { spec+: { prometheusRulesExcludedFromEnforce+: if std.isArray(v=prometheusRulesExcludedFromEnforce) then prometheusRulesExcludedFromEnforce else [prometheusRulesExcludedFromEnforce] } }, + '#withQueryLogFile':: d.fn(help="\"queryLogFile specifies where the file to which PromQL queries are logged.\\n\\n\\nIf the filename has an empty path, e.g. 'query.log', The Prometheus Pods\\nwill mount the file into an emptyDir volume at `/var/log/prometheus`.\\nIf a full path is provided, e.g. '/var/log/prometheus/query.log', you\\nmust mount a volume in the specified directory and it must be writable.\\nThis is because the prometheus container runs with a read-only root\\nfilesystem for security reasons.\\nAlternatively, the location can be set to a standard I/O stream, e.g.\\n`/dev/stdout`, to log query information to the default Prometheus log\\nstream.\"", args=[d.arg(name='queryLogFile', type=d.T.string)]), + withQueryLogFile(queryLogFile): { spec+: { queryLogFile: queryLogFile } }, + '#withReloadStrategy':: d.fn(help='"Defines the strategy used to reload the Prometheus configuration.\\nIf not specified, the configuration is reloaded using the /-/reload HTTP endpoint."', args=[d.arg(name='reloadStrategy', type=d.T.string)]), + withReloadStrategy(reloadStrategy): { spec+: { reloadStrategy: reloadStrategy } }, + '#withRemoteRead':: d.fn(help='"Defines the list of remote read configurations."', args=[d.arg(name='remoteRead', type=d.T.array)]), + withRemoteRead(remoteRead): { spec+: { remoteRead: if std.isArray(v=remoteRead) then remoteRead else [remoteRead] } }, + '#withRemoteReadMixin':: d.fn(help='"Defines the list of remote read configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='remoteRead', type=d.T.array)]), + withRemoteReadMixin(remoteRead): { spec+: { remoteRead+: if std.isArray(v=remoteRead) then remoteRead else [remoteRead] } }, + '#withRemoteWrite':: d.fn(help='"Defines the list of remote write configurations."', args=[d.arg(name='remoteWrite', type=d.T.array)]), + withRemoteWrite(remoteWrite): { spec+: { remoteWrite: if std.isArray(v=remoteWrite) then remoteWrite else [remoteWrite] } }, + '#withRemoteWriteMixin':: d.fn(help='"Defines the list of remote write configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='remoteWrite', type=d.T.array)]), + withRemoteWriteMixin(remoteWrite): { spec+: { remoteWrite+: if std.isArray(v=remoteWrite) then remoteWrite else [remoteWrite] } }, + '#withReplicaExternalLabelName':: d.fn(help='"Name of Prometheus external label used to denote the replica name.\\nThe external label will _not_ be added when the field is set to the\\nempty string (`\\"\\"`).\\n\\n\\nDefault: \\"prometheus_replica\\', args=[d.arg(name='replicaExternalLabelName', type=d.T.string)]), + withReplicaExternalLabelName(replicaExternalLabelName): { spec+: { replicaExternalLabelName: replicaExternalLabelName } }, + '#withReplicas':: d.fn(help='"Number of replicas of each shard to deploy for a Prometheus deployment.\\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\\ncreated.\\n\\n\\nDefault: 1"', args=[d.arg(name='replicas', type=d.T.integer)]), + withReplicas(replicas): { spec+: { replicas: replicas } }, + '#withRetention':: d.fn(help='"How long to retain the Prometheus data.\\n\\n\\nDefault: \\"24h\\" if `spec.retention` and `spec.retentionSize` are empty."', args=[d.arg(name='retention', type=d.T.string)]), + withRetention(retention): { spec+: { retention: retention } }, + '#withRetentionSize':: d.fn(help='"Maximum number of bytes used by the Prometheus data."', args=[d.arg(name='retentionSize', type=d.T.string)]), + withRetentionSize(retentionSize): { spec+: { retentionSize: retentionSize } }, + '#withRoutePrefix':: d.fn(help='"The route prefix Prometheus registers HTTP handlers for.\\n\\n\\nThis is useful when using `spec.externalURL`, and a proxy is rewriting\\nHTTP routes of a request, and the actual ExternalURL is still true, but\\nthe server serves requests under a different route prefix. For example\\nfor use with `kubectl proxy`."', args=[d.arg(name='routePrefix', type=d.T.string)]), + withRoutePrefix(routePrefix): { spec+: { routePrefix: routePrefix } }, + '#withSampleLimit':: d.fn(help="\"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.\"", args=[d.arg(name='sampleLimit', type=d.T.integer)]), + withSampleLimit(sampleLimit): { spec+: { sampleLimit: sampleLimit } }, + '#withScrapeClasses':: d.fn(help='"List of scrape classes to expose to scraping objects such as\\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."', args=[d.arg(name='scrapeClasses', type=d.T.array)]), + withScrapeClasses(scrapeClasses): { spec+: { scrapeClasses: if std.isArray(v=scrapeClasses) then scrapeClasses else [scrapeClasses] } }, + '#withScrapeClassesMixin':: d.fn(help='"List of scrape classes to expose to scraping objects such as\\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scrapeClasses', type=d.T.array)]), + withScrapeClassesMixin(scrapeClasses): { spec+: { scrapeClasses+: if std.isArray(v=scrapeClasses) then scrapeClasses else [scrapeClasses] } }, + '#withScrapeInterval':: d.fn(help='"Interval between consecutive scrapes.\\n\\n\\nDefault: \\"30s\\', args=[d.arg(name='scrapeInterval', type=d.T.string)]), + withScrapeInterval(scrapeInterval): { spec+: { scrapeInterval: scrapeInterval } }, + '#withScrapeProtocols':: d.fn(help='"The protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocols(scrapeProtocols): { spec+: { scrapeProtocols: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeProtocolsMixin':: d.fn(help='"The protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocolsMixin(scrapeProtocols): { spec+: { scrapeProtocols+: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeTimeout':: d.fn(help='"Number of seconds to wait until a scrape request times out."', args=[d.arg(name='scrapeTimeout', type=d.T.string)]), + withScrapeTimeout(scrapeTimeout): { spec+: { scrapeTimeout: scrapeTimeout } }, + '#withSecrets':: d.fn(help="\"Secrets is a list of Secrets in the same namespace as the Prometheus\\nobject, which shall be mounted into the Prometheus Pods.\\nEach Secret is added to the StatefulSet definition as a volume named `secret-\u003csecret-name\u003e`.\\nThe Secrets are mounted into /etc/prometheus/secrets/\u003csecret-name\u003e in the 'prometheus' container.\"", args=[d.arg(name='secrets', type=d.T.array)]), + withSecrets(secrets): { spec+: { secrets: if std.isArray(v=secrets) then secrets else [secrets] } }, + '#withSecretsMixin':: d.fn(help="\"Secrets is a list of Secrets in the same namespace as the Prometheus\\nobject, which shall be mounted into the Prometheus Pods.\\nEach Secret is added to the StatefulSet definition as a volume named `secret-\u003csecret-name\u003e`.\\nThe Secrets are mounted into /etc/prometheus/secrets/\u003csecret-name\u003e in the 'prometheus' container.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='secrets', type=d.T.array)]), + withSecretsMixin(secrets): { spec+: { secrets+: if std.isArray(v=secrets) then secrets else [secrets] } }, + '#withServiceAccountName':: d.fn(help='"ServiceAccountName is the name of the ServiceAccount to use to run the\\nPrometheus Pods."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withServiceDiscoveryRole':: d.fn(help='"Defines the service discovery role used to discover targets from\\n`ServiceMonitor` objects and Alertmanager endpoints.\\n\\n\\nIf set, the value should be either \\"Endpoints\\" or \\"EndpointSlice\\".\\nIf unset, the operator assumes the \\"Endpoints\\" role."', args=[d.arg(name='serviceDiscoveryRole', type=d.T.string)]), + withServiceDiscoveryRole(serviceDiscoveryRole): { spec+: { serviceDiscoveryRole: serviceDiscoveryRole } }, + '#withSha':: d.fn(help="\"Deprecated: use 'spec.image' instead. The image's digest can be specified as part of the image name.\"", args=[d.arg(name='sha', type=d.T.string)]), + withSha(sha): { spec+: { sha: sha } }, + '#withShards':: d.fn(help='"Number of shards to distribute targets onto. `spec.replicas`\\nmultiplied by `spec.shards` is the total number of Pods created.\\n\\n\\nNote that scaling down shards will not reshard data onto remaining\\ninstances, it must be manually moved. Increasing shards will not reshard\\ndata either but it will continue to be available from the same\\ninstances. To query globally, use Thanos sidecar and Thanos querier or\\nremote write data to a central location.\\n\\n\\nSharding is performed on the content of the `__address__` target meta-label\\nfor PodMonitors and ServiceMonitors and `__param_target__` for Probes.\\n\\n\\nDefault: 1"', args=[d.arg(name='shards', type=d.T.integer)]), + withShards(shards): { spec+: { shards: shards } }, + '#withTag':: d.fn(help="\"Deprecated: use 'spec.image' instead. The image's tag can be specified as part of the image name.\"", args=[d.arg(name='tag', type=d.T.string)]), + withTag(tag): { spec+: { tag: tag } }, + '#withTargetLimit':: d.fn(help="\"TargetLimit defines a limit on the number of scraped targets that will be accepted.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.\"", args=[d.arg(name='targetLimit', type=d.T.integer)]), + withTargetLimit(targetLimit): { spec+: { targetLimit: targetLimit } }, + '#withTolerations':: d.fn(help="\"Defines the Pods' tolerations if specified.\"", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerations(tolerations): { spec+: { tolerations: if std.isArray(v=tolerations) then tolerations else [tolerations] } }, + '#withTolerationsMixin':: d.fn(help="\"Defines the Pods' tolerations if specified.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerationsMixin(tolerations): { spec+: { tolerations+: if std.isArray(v=tolerations) then tolerations else [tolerations] } }, + '#withTopologySpreadConstraints':: d.fn(help="\"Defines the pod's topology spread constraints if specified.\"", args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), + withTopologySpreadConstraints(topologySpreadConstraints): { spec+: { topologySpreadConstraints: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, + '#withTopologySpreadConstraintsMixin':: d.fn(help="\"Defines the pod's topology spread constraints if specified.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), + withTopologySpreadConstraintsMixin(topologySpreadConstraints): { spec+: { topologySpreadConstraints+: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, + '#withVersion':: d.fn(help='"Version of Prometheus being deployed. The operator uses this information\\nto generate the Prometheus StatefulSet + configuration files.\\n\\n\\nIf not specified, the operator assumes the latest upstream version of\\nPrometheus available at the time when the version of the operator was\\nreleased."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { version: version } }, + '#withVolumeMounts':: d.fn(help="\"VolumeMounts allows the configuration of additional VolumeMounts.\\n\\n\\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\\ncontainer, that are generated as a result of StorageSpec objects.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { spec+: { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } }, + '#withVolumeMountsMixin':: d.fn(help="\"VolumeMounts allows the configuration of additional VolumeMounts.\\n\\n\\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\\ncontainer, that are generated as a result of StorageSpec objects.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { spec+: { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } }, + '#withVolumes':: d.fn(help='"Volumes allows the configuration of additional volumes on the output\\nStatefulSet definition. Volumes specified will be appended to other\\nvolumes that are generated as a result of StorageSpec objects."', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumes(volumes): { spec+: { volumes: if std.isArray(v=volumes) then volumes else [volumes] } }, + '#withVolumesMixin':: d.fn(help='"Volumes allows the configuration of additional volumes on the output\\nStatefulSet definition. Volumes specified will be appended to other\\nvolumes that are generated as a result of StorageSpec objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumesMixin(volumes): { spec+: { volumes+: if std.isArray(v=volumes) then volumes else [volumes] } }, + '#withWalCompression':: d.fn(help='"Configures compression of the write-ahead log (WAL) using Snappy.\\n\\n\\nWAL compression is enabled by default for Prometheus >= 2.20.0\\n\\n\\nRequires Prometheus v2.11.0 and above."', args=[d.arg(name='walCompression', type=d.T.boolean)]), + withWalCompression(walCompression): { spec+: { walCompression: walCompression } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/_gen/monitoring/v1/prometheusRule.libsonnet b/0.14/_gen/monitoring/v1/prometheusRule.libsonnet new file mode 100644 index 0000000..ab3bfce --- /dev/null +++ b/0.14/_gen/monitoring/v1/prometheusRule.libsonnet @@ -0,0 +1,95 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='prometheusRule', url='', help='"The `PrometheusRule` custom resource definition (CRD) defines [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) and [recording](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/) rules to be evaluated by `Prometheus` or `ThanosRuler` objects.\\n\\n\\n`Prometheus` and `ThanosRuler` objects select `PrometheusRule` objects using label and namespace selectors."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of PrometheusRule', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1', + kind: 'PrometheusRule', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Specification of desired alerting rule definitions for Prometheus."'), + spec: { + '#groups':: d.obj(help='"Content of Prometheus rule file"'), + groups: { + '#rules':: d.obj(help='"List of alerting and recording rules."'), + rules: { + '#withAlert':: d.fn(help='"Name of the alert. Must be a valid label value.\\nOnly one of `record` and `alert` must be set."', args=[d.arg(name='alert', type=d.T.string)]), + withAlert(alert): { alert: alert }, + '#withAnnotations':: d.fn(help='"Annotations to add to each alert.\\nOnly valid for alerting rules."', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { annotations: annotations }, + '#withAnnotationsMixin':: d.fn(help='"Annotations to add to each alert.\\nOnly valid for alerting rules."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { annotations+: annotations }, + '#withExpr':: d.fn(help='"PromQL expression to evaluate."', args=[d.arg(name='expr', type=d.T.any)]), + withExpr(expr): { expr: expr }, + '#withFor':: d.fn(help='"Alerts are considered firing once they have been returned for this long."', args=[d.arg(name='For', type=d.T.string)]), + withFor(For): { 'for': For }, + '#withKeep_firing_for':: d.fn(help='"KeepFiringFor defines how long an alert will continue firing after the condition that triggered it has cleared."', args=[d.arg(name='keep_firing_for', type=d.T.string)]), + withKeep_firing_for(keep_firing_for): { keep_firing_for: keep_firing_for }, + '#withLabels':: d.fn(help='"Labels to add or overwrite."', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { labels: labels }, + '#withLabelsMixin':: d.fn(help='"Labels to add or overwrite."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { labels+: labels }, + '#withRecord':: d.fn(help='"Name of the time series to output to. Must be a valid metric name.\\nOnly one of `record` and `alert` must be set."', args=[d.arg(name='record', type=d.T.string)]), + withRecord(record): { record: record }, + }, + '#withInterval':: d.fn(help='"Interval determines how often rules in the group are evaluated."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { interval: interval }, + '#withLimit':: d.fn(help='"Limit the number of alerts an alerting rule and series a recording\\nrule can produce.\\nLimit is supported starting with Prometheus >= 2.31 and Thanos Ruler >= 0.24."', args=[d.arg(name='limit', type=d.T.integer)]), + withLimit(limit): { limit: limit }, + '#withName':: d.fn(help='"Name of the rule group."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPartial_response_strategy':: d.fn(help='"PartialResponseStrategy is only used by ThanosRuler and will\\nbe ignored by Prometheus instances.\\nMore info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response"', args=[d.arg(name='partial_response_strategy', type=d.T.string)]), + withPartial_response_strategy(partial_response_strategy): { partial_response_strategy: partial_response_strategy }, + '#withRules':: d.fn(help='"List of alerting and recording rules."', args=[d.arg(name='rules', type=d.T.array)]), + withRules(rules): { rules: if std.isArray(v=rules) then rules else [rules] }, + '#withRulesMixin':: d.fn(help='"List of alerting and recording rules."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='rules', type=d.T.array)]), + withRulesMixin(rules): { rules+: if std.isArray(v=rules) then rules else [rules] }, + }, + '#withGroups':: d.fn(help='"Content of Prometheus rule file"', args=[d.arg(name='groups', type=d.T.array)]), + withGroups(groups): { spec+: { groups: if std.isArray(v=groups) then groups else [groups] } }, + '#withGroupsMixin':: d.fn(help='"Content of Prometheus rule file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='groups', type=d.T.array)]), + withGroupsMixin(groups): { spec+: { groups+: if std.isArray(v=groups) then groups else [groups] } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/_gen/monitoring/v1/serviceMonitor.libsonnet b/0.14/_gen/monitoring/v1/serviceMonitor.libsonnet new file mode 100644 index 0000000..330ff5f --- /dev/null +++ b/0.14/_gen/monitoring/v1/serviceMonitor.libsonnet @@ -0,0 +1,433 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='serviceMonitor', url='', help='"The `ServiceMonitor` custom resource definition (CRD) defines how `Prometheus` and `PrometheusAgent` can scrape metrics from a group of services.\\nAmong other things, it allows to specify:\\n* The services to scrape via label selectors.\\n* The container ports to scrape.\\n* Authentication credentials to use.\\n* Target and metric relabeling.\\n\\n\\n`Prometheus` and `PrometheusAgent` objects select `ServiceMonitor` objects using label and namespace selectors."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ServiceMonitor', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1', + kind: 'ServiceMonitor', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Specification of desired Service selection for target discovery by\\nPrometheus."'), + spec: { + '#attachMetadata':: d.obj(help='"`attachMetadata` defines additional metadata which is added to the\\ndiscovered targets.\\n\\n\\nIt requires Prometheus >= v2.37.0."'), + attachMetadata: { + '#withNode':: d.fn(help='"When set to true, Prometheus attaches node metadata to the discovered\\ntargets.\\n\\n\\nThe Prometheus service account must have the `list` and `watch`\\npermissions on the `Nodes` objects."', args=[d.arg(name='node', type=d.T.boolean)]), + withNode(node): { spec+: { attachMetadata+: { node: node } } }, + }, + '#endpoints':: d.obj(help='"List of endpoints part of this ServiceMonitor.\\nDefines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects.\\nIn most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels."'), + endpoints: { + '#authorization':: d.obj(help='"`authorization` configures the Authorization header credentials to use when\\nscraping the target.\\n\\n\\nCannot be set at the same time as `basicAuth`, or `oauth2`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"`basicAuth` configures the Basic Authentication credentials to use when\\nscraping the target.\\n\\n\\nCannot be set at the same time as `authorization`, or `oauth2`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help='"`bearerTokenSecret` specifies a key of a Secret containing the bearer\\ntoken for scraping targets. The secret needs to be in the same namespace\\nas the ServiceMonitor object and readable by the Prometheus Operator.\\n\\n\\nDeprecated: use `authorization` instead."'), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { bearerTokenSecret+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { bearerTokenSecret+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { bearerTokenSecret+: { optional: optional } }, + }, + '#metricRelabelings':: d.obj(help='"`metricRelabelings` configures the relabeling rules to apply to the\\nsamples before ingestion."'), + metricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#oauth2':: d.obj(help='"`oauth2` configures the OAuth2 settings to use when scraping the target.\\n\\n\\nIt requires Prometheus >= 2.27.0.\\n\\n\\nCannot be set at the same time as `authorization`, or `basicAuth`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#relabelings':: d.obj(help="\"`relabelings` configures the relabeling rules to apply the target's\\nmetadata labels.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\\n\\n\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\""), + relabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when scraping the target."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { tlsConfig+: { caFile: caFile } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { tlsConfig+: { certFile: certFile } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { tlsConfig+: { keyFile: keyFile } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withBearerTokenFile':: d.fn(help='"File to read bearer token for scraping the target.\\n\\n\\nDeprecated: use `authorization` instead."', args=[d.arg(name='bearerTokenFile', type=d.T.string)]), + withBearerTokenFile(bearerTokenFile): { bearerTokenFile: bearerTokenFile }, + '#withEnableHttp2':: d.fn(help='"`enableHttp2` can be used to disable HTTP2 when scraping the target."', args=[d.arg(name='enableHttp2', type=d.T.boolean)]), + withEnableHttp2(enableHttp2): { enableHttp2: enableHttp2 }, + '#withFilterRunning':: d.fn(help='"When true, the pods which are not running (e.g. either in Failed or\\nSucceeded state) are dropped during the target discovery.\\n\\n\\nIf unset, the filtering is enabled.\\n\\n\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase"', args=[d.arg(name='filterRunning', type=d.T.boolean)]), + withFilterRunning(filterRunning): { filterRunning: filterRunning }, + '#withFollowRedirects':: d.fn(help='"`followRedirects` defines whether the scrape requests should follow HTTP\\n3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withHonorLabels':: d.fn(help="\"When true, `honorLabels` preserves the metric's labels when they collide\\nwith the target's labels.\"", args=[d.arg(name='honorLabels', type=d.T.boolean)]), + withHonorLabels(honorLabels): { honorLabels: honorLabels }, + '#withHonorTimestamps':: d.fn(help='"`honorTimestamps` controls whether Prometheus preserves the timestamps\\nwhen exposed by the target."', args=[d.arg(name='honorTimestamps', type=d.T.boolean)]), + withHonorTimestamps(honorTimestamps): { honorTimestamps: honorTimestamps }, + '#withInterval':: d.fn(help='"Interval at which Prometheus scrapes the metrics from the target.\\n\\n\\nIf empty, Prometheus uses the global scrape interval."', args=[d.arg(name='interval', type=d.T.string)]), + withInterval(interval): { interval: interval }, + '#withMetricRelabelings':: d.fn(help='"`metricRelabelings` configures the relabeling rules to apply to the\\nsamples before ingestion."', args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelings(metricRelabelings): { metricRelabelings: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] }, + '#withMetricRelabelingsMixin':: d.fn(help='"`metricRelabelings` configures the relabeling rules to apply to the\\nsamples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelingsMixin(metricRelabelings): { metricRelabelings+: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] }, + '#withParams':: d.fn(help='"params define optional HTTP URL parameters."', args=[d.arg(name='params', type=d.T.object)]), + withParams(params): { params: params }, + '#withParamsMixin':: d.fn(help='"params define optional HTTP URL parameters."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='params', type=d.T.object)]), + withParamsMixin(params): { params+: params }, + '#withPath':: d.fn(help='"HTTP path from which to scrape for metrics.\\n\\n\\nIf empty, Prometheus uses the default value (e.g. `/metrics`)."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + '#withPort':: d.fn(help='"Name of the Service port which this endpoint refers to.\\n\\n\\nIt takes precedence over `targetPort`."', args=[d.arg(name='port', type=d.T.string)]), + withPort(port): { port: port }, + '#withProxyUrl':: d.fn(help='"`proxyURL` configures the HTTP Proxy URL (e.g.\\n\\"http://proxyserver:2195\\") to go through when scraping the target."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRelabelings':: d.fn(help="\"`relabelings` configures the relabeling rules to apply the target's\\nmetadata labels.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\\n\\n\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\"", args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelings(relabelings): { relabelings: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + '#withRelabelingsMixin':: d.fn(help="\"`relabelings` configures the relabeling rules to apply the target's\\nmetadata labels.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\\n\\n\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelingsMixin(relabelings): { relabelings+: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + '#withScheme':: d.fn(help='"HTTP scheme to use for scraping.\\n\\n\\n`http` and `https` are the expected values unless you rewrite the\\n`__scheme__` label via relabeling.\\n\\n\\nIf empty, Prometheus uses the default value `http`."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { scheme: scheme }, + '#withScrapeTimeout':: d.fn(help="\"Timeout after which Prometheus considers the scrape to be failed.\\n\\n\\nIf empty, Prometheus uses the global scrape timeout unless it is less\\nthan the target's scrape interval value in which the latter is used.\"", args=[d.arg(name='scrapeTimeout', type=d.T.string)]), + withScrapeTimeout(scrapeTimeout): { scrapeTimeout: scrapeTimeout }, + '#withTargetPort':: d.fn(help="\"Name or number of the target port of the `Pod` object behind the\\nService. The port must be specified with the container's port property.\"", args=[d.arg(name='targetPort', type=d.T.any)]), + withTargetPort(targetPort): { targetPort: targetPort }, + '#withTrackTimestampsStaleness':: d.fn(help='"`trackTimestampsStaleness` defines whether Prometheus tracks staleness of\\nthe metrics that have an explicit timestamp present in scraped data.\\nHas no effect if `honorTimestamps` is false.\\n\\n\\nIt requires Prometheus >= v2.48.0."', args=[d.arg(name='trackTimestampsStaleness', type=d.T.boolean)]), + withTrackTimestampsStaleness(trackTimestampsStaleness): { trackTimestampsStaleness: trackTimestampsStaleness }, + }, + '#namespaceSelector':: d.obj(help='"`namespaceSelector` defines in which namespace(s) Prometheus should discover the services.\\nBy default, the services are discovered in the same namespace as the `ServiceMonitor` object but it is possible to select pods across different/all namespaces."'), + namespaceSelector: { + '#withAny':: d.fn(help='"Boolean describing whether all namespaces are selected in contrast to a\\nlist restricting them."', args=[d.arg(name='any', type=d.T.boolean)]), + withAny(any): { spec+: { namespaceSelector+: { any: any } } }, + '#withMatchNames':: d.fn(help='"List of namespace names to select from."', args=[d.arg(name='matchNames', type=d.T.array)]), + withMatchNames(matchNames): { spec+: { namespaceSelector+: { matchNames: if std.isArray(v=matchNames) then matchNames else [matchNames] } } }, + '#withMatchNamesMixin':: d.fn(help='"List of namespace names to select from."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchNames', type=d.T.array)]), + withMatchNamesMixin(matchNames): { spec+: { namespaceSelector+: { matchNames+: if std.isArray(v=matchNames) then matchNames else [matchNames] } } }, + }, + '#selector':: d.obj(help='"Label selector to select the Kubernetes `Endpoints` objects to scrape metrics from."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { selector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { selector+: { matchLabels+: matchLabels } } }, + }, + '#withBodySizeLimit':: d.fn(help='"When defined, bodySizeLimit specifies a job level limit on the size\\nof uncompressed response body that will be accepted by Prometheus.\\n\\n\\nIt requires Prometheus >= v2.28.0."', args=[d.arg(name='bodySizeLimit', type=d.T.string)]), + withBodySizeLimit(bodySizeLimit): { spec+: { bodySizeLimit: bodySizeLimit } }, + '#withEndpoints':: d.fn(help='"List of endpoints part of this ServiceMonitor.\\nDefines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects.\\nIn most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels."', args=[d.arg(name='endpoints', type=d.T.array)]), + withEndpoints(endpoints): { spec+: { endpoints: if std.isArray(v=endpoints) then endpoints else [endpoints] } }, + '#withEndpointsMixin':: d.fn(help='"List of endpoints part of this ServiceMonitor.\\nDefines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects.\\nIn most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpoints', type=d.T.array)]), + withEndpointsMixin(endpoints): { spec+: { endpoints+: if std.isArray(v=endpoints) then endpoints else [endpoints] } }, + '#withJobLabel':: d.fn(help="\"`jobLabel` selects the label from the associated Kubernetes `Service`\\nobject which will be used as the `job` label for all metrics.\\n\\n\\nFor example if `jobLabel` is set to `foo` and the Kubernetes `Service`\\nobject is labeled with `foo: bar`, then Prometheus adds the `job=\\\"bar\\\"`\\nlabel to all ingested metrics.\\n\\n\\nIf the value of this field is empty or if the label doesn't exist for\\nthe given Service, the `job` label of the metrics defaults to the name\\nof the associated Kubernetes `Service`.\"", args=[d.arg(name='jobLabel', type=d.T.string)]), + withJobLabel(jobLabel): { spec+: { jobLabel: jobLabel } }, + '#withKeepDroppedTargets':: d.fn(help='"Per-scrape limit on the number of targets dropped by relabeling\\nthat will be kept in memory. 0 means no limit.\\n\\n\\nIt requires Prometheus >= v2.47.0."', args=[d.arg(name='keepDroppedTargets', type=d.T.integer)]), + withKeepDroppedTargets(keepDroppedTargets): { spec+: { keepDroppedTargets: keepDroppedTargets } }, + '#withLabelLimit':: d.fn(help='"Per-scrape limit on number of labels that will be accepted for a sample.\\n\\n\\nIt requires Prometheus >= v2.27.0."', args=[d.arg(name='labelLimit', type=d.T.integer)]), + withLabelLimit(labelLimit): { spec+: { labelLimit: labelLimit } }, + '#withLabelNameLengthLimit':: d.fn(help='"Per-scrape limit on length of labels name that will be accepted for a sample.\\n\\n\\nIt requires Prometheus >= v2.27.0."', args=[d.arg(name='labelNameLengthLimit', type=d.T.integer)]), + withLabelNameLengthLimit(labelNameLengthLimit): { spec+: { labelNameLengthLimit: labelNameLengthLimit } }, + '#withLabelValueLengthLimit':: d.fn(help='"Per-scrape limit on length of labels value that will be accepted for a sample.\\n\\n\\nIt requires Prometheus >= v2.27.0."', args=[d.arg(name='labelValueLengthLimit', type=d.T.integer)]), + withLabelValueLengthLimit(labelValueLengthLimit): { spec+: { labelValueLengthLimit: labelValueLengthLimit } }, + '#withPodTargetLabels':: d.fn(help='"`podTargetLabels` defines the labels which are transferred from the\\nassociated Kubernetes `Pod` object onto the ingested metrics."', args=[d.arg(name='podTargetLabels', type=d.T.array)]), + withPodTargetLabels(podTargetLabels): { spec+: { podTargetLabels: if std.isArray(v=podTargetLabels) then podTargetLabels else [podTargetLabels] } }, + '#withPodTargetLabelsMixin':: d.fn(help='"`podTargetLabels` defines the labels which are transferred from the\\nassociated Kubernetes `Pod` object onto the ingested metrics."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podTargetLabels', type=d.T.array)]), + withPodTargetLabelsMixin(podTargetLabels): { spec+: { podTargetLabels+: if std.isArray(v=podTargetLabels) then podTargetLabels else [podTargetLabels] } }, + '#withSampleLimit':: d.fn(help='"`sampleLimit` defines a per-scrape limit on the number of scraped samples\\nthat will be accepted."', args=[d.arg(name='sampleLimit', type=d.T.integer)]), + withSampleLimit(sampleLimit): { spec+: { sampleLimit: sampleLimit } }, + '#withScrapeClass':: d.fn(help='"The scrape class to apply."', args=[d.arg(name='scrapeClass', type=d.T.string)]), + withScrapeClass(scrapeClass): { spec+: { scrapeClass: scrapeClass } }, + '#withScrapeProtocols':: d.fn(help='"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocols(scrapeProtocols): { spec+: { scrapeProtocols: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeProtocolsMixin':: d.fn(help='"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocolsMixin(scrapeProtocols): { spec+: { scrapeProtocols+: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withTargetLabels':: d.fn(help='"`targetLabels` defines the labels which are transferred from the\\nassociated Kubernetes `Service` object onto the ingested metrics."', args=[d.arg(name='targetLabels', type=d.T.array)]), + withTargetLabels(targetLabels): { spec+: { targetLabels: if std.isArray(v=targetLabels) then targetLabels else [targetLabels] } }, + '#withTargetLabelsMixin':: d.fn(help='"`targetLabels` defines the labels which are transferred from the\\nassociated Kubernetes `Service` object onto the ingested metrics."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='targetLabels', type=d.T.array)]), + withTargetLabelsMixin(targetLabels): { spec+: { targetLabels+: if std.isArray(v=targetLabels) then targetLabels else [targetLabels] } }, + '#withTargetLimit':: d.fn(help='"`targetLimit` defines a limit on the number of scraped targets that will\\nbe accepted."', args=[d.arg(name='targetLimit', type=d.T.integer)]), + withTargetLimit(targetLimit): { spec+: { targetLimit: targetLimit } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/_gen/monitoring/v1/thanosRuler.libsonnet b/0.14/_gen/monitoring/v1/thanosRuler.libsonnet new file mode 100644 index 0000000..4c1f461 --- /dev/null +++ b/0.14/_gen/monitoring/v1/thanosRuler.libsonnet @@ -0,0 +1,2789 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='thanosRuler', url='', help='"The `ThanosRuler` custom resource definition (CRD) defines a desired [Thanos Ruler](https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md) setup to run in a Kubernetes cluster.\\n\\n\\nA `ThanosRuler` instance requires at least one compatible Prometheus API endpoint (either Thanos Querier or Prometheus services).\\n\\n\\nThe resource defines via label and namespace selectors which `PrometheusRule` objects should be associated to the deployed Thanos Ruler instances."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ThanosRuler', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1', + kind: 'ThanosRuler', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Specification of the desired behavior of the ThanosRuler cluster. More info:\\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"'), + spec: { + '#additionalArgs':: d.obj(help='"AdditionalArgs allows setting additional arguments for the ThanosRuler container.\\nIt is intended for e.g. activating hidden flags which are not supported by\\nthe dedicated configuration options yet. The arguments are passed as-is to the\\nThanosRuler container which may cause issues if they are invalid or not supported\\nby the given ThanosRuler version.\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument the reconciliation will\\nfail and an error will be logged."'), + additionalArgs: { + '#withName':: d.fn(help='"Name of the argument, e.g. \\"scrape.discovery-reload-interval\\"."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#affinity':: d.obj(help="\"If specified, the pod's scheduling constraints.\""), + affinity: { + '#nodeAffinity':: d.obj(help='"Describes node affinity scheduling rules for the pod."'), + nodeAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#preference':: d.obj(help='"A node selector term, associated with the corresponding weight."'), + preference: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { preference+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { preference+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { preference+: { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { preference+: { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + }, + '#withWeight':: d.fn(help='"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to an update), the system\\nmay or may not try to eventually evict the pod from its node."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#nodeSelectorTerms':: d.obj(help='"Required. A list of node selector terms. The terms are ORed."'), + nodeSelectorTerms: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + }, + '#withNodeSelectorTerms':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTerms(nodeSelectorTerms): { spec+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } }, + '#withNodeSelectorTermsMixin':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTermsMixin(nodeSelectorTerms): { spec+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms+: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + '#podAffinity':: d.obj(help='"Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."'), + podAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm,\\nin the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + '#podAntiAffinity':: d.obj(help='"Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))."'), + podAntiAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm,\\nin the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + }, + '#alertRelabelConfigs':: d.obj(help='"AlertRelabelConfigs configures alert relabeling in ThanosRuler.\\nAlert relabel configurations must have the form as specified in the official Prometheus documentation:\\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\\nAlternative to AlertRelabelConfigFile, and lower order priority."'), + alertRelabelConfigs: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertRelabelConfigs+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertRelabelConfigs+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertRelabelConfigs+: { optional: optional } } }, + }, + '#alertmanagersConfig':: d.obj(help='"Define configuration for connecting to alertmanager. Only available with thanos v0.10.0\\nand higher. Maps to the `alertmanagers.config` arg."'), + alertmanagersConfig: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { alertmanagersConfig+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { alertmanagersConfig+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { alertmanagersConfig+: { optional: optional } } }, + }, + '#containers':: d.obj(help='"Containers allows injecting additional containers or modifying operator generated\\ncontainers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or\\nto change the behavior of an operator generated container. Containers described here modify\\nan operator generated container if they share the same name and modifications are done via a\\nstrategic merge patch. The current container names are: `thanos-ruler` and `config-reloader`.\\nOverriding containers is entirely outside the scope of what the maintainers will support and by doing\\nso, you accept that this behaviour may break at any time without notice."'), + containers: { + '#env':: d.obj(help='"List of environment variables to set in the container.\\nCannot be updated."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded\\nusing the previously defined environment variables in the container and\\nany service environment variables. If a variable cannot be resolved,\\nthe reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\\n\\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\".\\nEscaped references will never be expanded, regardless of whether the variable\\nexists or not.\\nDefaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#envFrom':: d.obj(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."'), + envFrom: { + '#configMapRef':: d.obj(help='"The ConfigMap to select from"'), + configMapRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMapRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMapRef+: { optional: optional } }, + }, + '#secretRef':: d.obj(help='"The Secret to select from"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretRef+: { optional: optional } }, + }, + '#withPrefix':: d.fn(help='"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { prefix: prefix }, + }, + '#lifecycle':: d.obj(help='"Actions that the management system should take in response to container lifecycle events.\\nCannot be updated."'), + lifecycle: { + '#postStart':: d.obj(help='"PostStart is called immediately after a container is created. If the handler fails,\\nthe container is terminated and restarted according to its restart policy.\\nOther management of the container blocks until the hook completes.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"'), + postStart: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { postStart+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { postStart+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { postStart+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { postStart+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { postStart+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { tcpSocket+: { port: port } } } }, + }, + }, + '#preStop':: d.obj(help="\"PreStop is called immediately before a container is terminated due to an\\nAPI request or management event such as liveness/startup probe failure,\\npreemption, resource contention, etc. The handler is not called if the\\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\\nPreStop hook is executed. Regardless of the outcome of the handler, the\\ncontainer will eventually terminate within the Pod's termination grace\\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\\nor until the termination grace period is reached.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\""), + preStop: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { preStop+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { preStop+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { preStop+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { preStop+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { preStop+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { tcpSocket+: { port: port } } } }, + }, + }, + }, + '#livenessProbe':: d.obj(help='"Periodic probe of container liveness.\\nContainer will be restarted if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + livenessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { livenessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { livenessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { livenessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { livenessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { livenessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { livenessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { livenessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { livenessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { livenessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { livenessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { livenessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { livenessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#ports':: d.obj(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."'), + ports: { + '#withContainerPort':: d.fn(help="\"Number of port to expose on the pod's IP address.\\nThis must be a valid port number, 0 \u003c x \u003c 65536.\"", args=[d.arg(name='containerPort', type=d.T.integer)]), + withContainerPort(containerPort): { containerPort: containerPort }, + '#withHostIP':: d.fn(help='"What host IP to bind the external port to."', args=[d.arg(name='hostIP', type=d.T.string)]), + withHostIP(hostIP): { hostIP: hostIP }, + '#withHostPort':: d.fn(help='"Number of port to expose on the host.\\nIf specified, this must be a valid port number, 0 < x < 65536.\\nIf HostNetwork is specified, this must match ContainerPort.\\nMost containers do not need this."', args=[d.arg(name='hostPort', type=d.T.integer)]), + withHostPort(hostPort): { hostPort: hostPort }, + '#withName':: d.fn(help='"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\\nnamed port in a pod must have a unique name. Name for the port that can be\\nreferred to by services."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withProtocol':: d.fn(help='"Protocol for port. Must be UDP, TCP, or SCTP.\\nDefaults to \\"TCP\\"."', args=[d.arg(name='protocol', type=d.T.string)]), + withProtocol(protocol): { protocol: protocol }, + }, + '#readinessProbe':: d.obj(help='"Periodic probe of container service readiness.\\nContainer will be removed from service endpoints if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + readinessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { readinessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { readinessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { readinessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { readinessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { readinessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { readinessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { readinessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { readinessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { readinessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { readinessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { readinessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { readinessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#resizePolicy':: d.obj(help='"Resources resize policy for the container."'), + resizePolicy: { + '#withResourceName':: d.fn(help='"Name of the resource to which this resource resize policy applies.\\nSupported values: cpu, memory."', args=[d.arg(name='resourceName', type=d.T.string)]), + withResourceName(resourceName): { resourceName: resourceName }, + '#withRestartPolicy':: d.fn(help='"Restart policy to apply when specified resource is resized.\\nIf not specified, it defaults to NotRequired."', args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + }, + '#resources':: d.obj(help='"Compute Resources required by this container.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { resources+: { limits: limits } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { resources+: { limits+: limits } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { resources+: { requests: requests } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { resources+: { requests+: requests } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with.\\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#appArmorProfile':: d.obj(help="\"appArmorProfile is the AppArmor options to use by this container. If set, this profile\\noverrides the pod's appArmorProfile.\\nNote that this field cannot be set when spec.os.name is windows.\""), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { appArmorProfile+: { type: type } } }, + }, + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers.\\nDefaults to the default set of capabilities granted by the container runtime.\\nNote that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { securityContext+: { seLinuxOptions+: { level: level } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { securityContext+: { seLinuxOptions+: { role: role } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seLinuxOptions+: { type: type } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { securityContext+: { seLinuxOptions+: { user: user } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are\\nprovided at both the pod & container level, the container options\\noverride the pod options.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seccompProfile+: { type: type } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers.\\nIf unspecified, the options from the PodSecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more\\nprivileges than its parent process. This bool directly controls if\\nthe no_new_privs flag will be set on the container process.\\nAllowPrivilegeEscalation is true always when the container is:\\n1) run as Privileged\\n2) has CAP_SYS_ADMIN\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode.\\nProcesses in privileged containers are essentially equivalent to root on the host.\\nDefaults to false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { securityContext+: { privileged: privileged } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers.\\nThe default is DefaultProcMount which uses the container runtime defaults for\\nreadonly paths and masked paths.\\nThis requires the ProcMountType feature flag to be enabled.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { securityContext+: { procMount: procMount } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem.\\nDefault is false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { securityContext+: { runAsGroup: runAsGroup } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { securityContext+: { runAsNonRoot: runAsNonRoot } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { securityContext+: { runAsUser: runAsUser } }, + }, + '#startupProbe':: d.obj(help="\"StartupProbe indicates that the Pod has successfully initialized.\\nIf specified, no other probes are executed until this completes successfully.\\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\\nThis cannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\""), + startupProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { startupProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { startupProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { startupProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { startupProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { startupProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { startupProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { startupProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { startupProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { startupProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { startupProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { startupProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { startupProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#volumeDevices':: d.obj(help='"volumeDevices is the list of block devices to be used by the container."'), + volumeDevices: { + '#withDevicePath':: d.fn(help='"devicePath is the path inside of the container that the device will be mapped to."', args=[d.arg(name='devicePath', type=d.T.string)]), + withDevicePath(devicePath): { devicePath: devicePath }, + '#withName':: d.fn(help='"name must match the name of a persistentVolumeClaim in the pod"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#volumeMounts':: d.obj(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withArgs':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='args', type=d.T.array)]), + withArgs(args): { args: if std.isArray(v=args) then args else [args] }, + '#withArgsMixin':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='args', type=d.T.array)]), + withArgsMixin(args): { args+: if std.isArray(v=args) then args else [args] }, + '#withCommand':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { command: if std.isArray(v=command) then command else [command] }, + '#withCommandMixin':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { command+: if std.isArray(v=command) then command else [command] }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { env: if std.isArray(v=env) then env else [env] }, + '#withEnvFrom':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFrom(envFrom): { envFrom: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvFromMixin':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFromMixin(envFrom): { envFrom+: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { env+: if std.isArray(v=env) then env else [env] }, + '#withImage':: d.fn(help='"Container image name.\\nMore info: https://kubernetes.io/docs/concepts/containers/images\\nThis field is optional to allow higher level config management to default or override\\ncontainer images in workload controllers like Deployments and StatefulSets."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { image: image }, + '#withImagePullPolicy':: d.fn(help='"Image pull policy.\\nOne of Always, Never, IfNotPresent.\\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images"', args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { imagePullPolicy: imagePullPolicy }, + '#withName':: d.fn(help='"Name of the container specified as a DNS_LABEL.\\nEach container in a pod must have a unique name (DNS_LABEL).\\nCannot be updated."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPorts':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."', args=[d.arg(name='ports', type=d.T.array)]), + withPorts(ports): { ports: if std.isArray(v=ports) then ports else [ports] }, + '#withPortsMixin':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ports', type=d.T.array)]), + withPortsMixin(ports): { ports+: if std.isArray(v=ports) then ports else [ports] }, + '#withResizePolicy':: d.fn(help='"Resources resize policy for the container."', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicy(resizePolicy): { resizePolicy: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withResizePolicyMixin':: d.fn(help='"Resources resize policy for the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicyMixin(resizePolicy): { resizePolicy+: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withRestartPolicy':: d.fn(help="\"RestartPolicy defines the restart behavior of individual containers in a pod.\\nThis field may only be set for init containers, and the only allowed value is \\\"Always\\\".\\nFor non-init containers or when this field is not specified,\\nthe restart behavior is defined by the Pod's restart policy and the container type.\\nSetting the RestartPolicy as \\\"Always\\\" for the init container will have the following effect:\\nthis init container will be continually restarted on\\nexit until all regular containers have terminated. Once all regular\\ncontainers have completed, all init containers with restartPolicy \\\"Always\\\"\\nwill be shut down. This lifecycle differs from normal init containers and\\nis often referred to as a \\\"sidecar\\\" container. Although this init\\ncontainer still starts in the init container sequence, it does not wait\\nfor the container to complete before proceeding to the next init\\ncontainer. Instead, the next init container starts immediately after this\\ninit container is started, or after any startupProbe has successfully\\ncompleted.\"", args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + '#withStdin':: d.fn(help='"Whether this container should allocate a buffer for stdin in the container runtime. If this\\nis not set, reads from stdin in the container will always result in EOF.\\nDefault is false."', args=[d.arg(name='stdin', type=d.T.boolean)]), + withStdin(stdin): { stdin: stdin }, + '#withStdinOnce':: d.fn(help='"Whether the container runtime should close the stdin channel after it has been opened by\\na single attach. When stdin is true the stdin stream will remain open across multiple attach\\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\\nat which time stdin is closed and remains closed until the container is restarted. If this\\nflag is false, a container processes that reads from stdin will never receive an EOF.\\nDefault is false"', args=[d.arg(name='stdinOnce', type=d.T.boolean)]), + withStdinOnce(stdinOnce): { stdinOnce: stdinOnce }, + '#withTerminationMessagePath':: d.fn(help="\"Optional: Path at which the file to which the container's termination message\\nwill be written is mounted into the container's filesystem.\\nMessage written is intended to be brief final status, such as an assertion failure message.\\nWill be truncated by the node if greater than 4096 bytes. The total message length across\\nall containers will be limited to 12kb.\\nDefaults to /dev/termination-log.\\nCannot be updated.\"", args=[d.arg(name='terminationMessagePath', type=d.T.string)]), + withTerminationMessagePath(terminationMessagePath): { terminationMessagePath: terminationMessagePath }, + '#withTerminationMessagePolicy':: d.fn(help='"Indicate how the termination message should be populated. File will use the contents of\\nterminationMessagePath to populate the container status message on both success and failure.\\nFallbackToLogsOnError will use the last chunk of container log output if the termination\\nmessage file is empty and the container exited with an error.\\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\\nDefaults to File.\\nCannot be updated."', args=[d.arg(name='terminationMessagePolicy', type=d.T.string)]), + withTerminationMessagePolicy(terminationMessagePolicy): { terminationMessagePolicy: terminationMessagePolicy }, + '#withTty':: d.fn(help="\"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\\nDefault is false.\"", args=[d.arg(name='tty', type=d.T.boolean)]), + withTty(tty): { tty: tty }, + '#withVolumeDevices':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevices(volumeDevices): { volumeDevices: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeDevicesMixin':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevicesMixin(volumeDevices): { volumeDevices+: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeMounts':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withVolumeMountsMixin':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withWorkingDir':: d.fn(help="\"Container's working directory.\\nIf not specified, the container runtime's default will be used, which\\nmight be configured in the container image.\\nCannot be updated.\"", args=[d.arg(name='workingDir', type=d.T.string)]), + withWorkingDir(workingDir): { workingDir: workingDir }, + }, + '#excludedFromEnforcement':: d.obj(help='"List of references to PrometheusRule objects\\nto be excluded from enforcing a namespace label of origin.\\nApplies only if enforcedNamespaceLabel set to true."'), + excludedFromEnforcement: { + '#withGroup':: d.fn(help='"Group of the referent. When not specified, it defaults to `monitoring.coreos.com`"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { group: group }, + '#withName':: d.fn(help='"Name of the referent. When not set, all resources in the namespace are matched."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent.\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + '#withResource':: d.fn(help='"Resource of the referent."', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resource: resource }, + }, + '#grpcServerTlsConfig':: d.obj(help="\"GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads\\nrecorded rule data.\\nNote: Currently only the CAFile, CertFile, and KeyFile fields are supported.\\nMaps to the '--grpc-server-tls-*' CLI args.\""), + grpcServerTlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { grpcServerTlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { grpcServerTlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { grpcServerTlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { grpcServerTlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { grpcServerTlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { grpcServerTlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { grpcServerTlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { grpcServerTlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { grpcServerTlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { grpcServerTlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { grpcServerTlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { grpcServerTlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { grpcServerTlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { grpcServerTlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { grpcServerTlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { spec+: { grpcServerTlsConfig+: { caFile: caFile } } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { spec+: { grpcServerTlsConfig+: { certFile: certFile } } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { grpcServerTlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { spec+: { grpcServerTlsConfig+: { keyFile: keyFile } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { grpcServerTlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { grpcServerTlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { grpcServerTlsConfig+: { serverName: serverName } } }, + }, + '#hostAliases':: d.obj(help="\"Pods' hostAliases configuration\""), + hostAliases: { + '#withHostnames':: d.fn(help='"Hostnames for the above IP address."', args=[d.arg(name='hostnames', type=d.T.array)]), + withHostnames(hostnames): { hostnames: if std.isArray(v=hostnames) then hostnames else [hostnames] }, + '#withHostnamesMixin':: d.fn(help='"Hostnames for the above IP address."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='hostnames', type=d.T.array)]), + withHostnamesMixin(hostnames): { hostnames+: if std.isArray(v=hostnames) then hostnames else [hostnames] }, + '#withIp':: d.fn(help='"IP address of the host file entry."', args=[d.arg(name='ip', type=d.T.string)]), + withIp(ip): { ip: ip }, + }, + '#imagePullSecrets':: d.obj(help='"An optional list of references to secrets in the same namespace\\nto use for pulling thanos images from registries\\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"'), + imagePullSecrets: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#initContainers':: d.obj(help='"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\\nfetch secrets for injection into the ThanosRuler configuration from external sources. Any\\nerrors during the execution of an initContainer will lead to a restart of the Pod.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\\nof what the maintainers will support and by doing so, you accept that this behaviour may break\\nat any time without notice."'), + initContainers: { + '#env':: d.obj(help='"List of environment variables to set in the container.\\nCannot be updated."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded\\nusing the previously defined environment variables in the container and\\nany service environment variables. If a variable cannot be resolved,\\nthe reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\\n\\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\".\\nEscaped references will never be expanded, regardless of whether the variable\\nexists or not.\\nDefaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#envFrom':: d.obj(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."'), + envFrom: { + '#configMapRef':: d.obj(help='"The ConfigMap to select from"'), + configMapRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMapRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMapRef+: { optional: optional } }, + }, + '#secretRef':: d.obj(help='"The Secret to select from"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretRef+: { optional: optional } }, + }, + '#withPrefix':: d.fn(help='"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { prefix: prefix }, + }, + '#lifecycle':: d.obj(help='"Actions that the management system should take in response to container lifecycle events.\\nCannot be updated."'), + lifecycle: { + '#postStart':: d.obj(help='"PostStart is called immediately after a container is created. If the handler fails,\\nthe container is terminated and restarted according to its restart policy.\\nOther management of the container blocks until the hook completes.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"'), + postStart: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { postStart+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { postStart+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { postStart+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { postStart+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { postStart+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { tcpSocket+: { port: port } } } }, + }, + }, + '#preStop':: d.obj(help="\"PreStop is called immediately before a container is terminated due to an\\nAPI request or management event such as liveness/startup probe failure,\\npreemption, resource contention, etc. The handler is not called if the\\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\\nPreStop hook is executed. Regardless of the outcome of the handler, the\\ncontainer will eventually terminate within the Pod's termination grace\\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\\nor until the termination grace period is reached.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\""), + preStop: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { preStop+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { preStop+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { preStop+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { preStop+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { preStop+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { tcpSocket+: { port: port } } } }, + }, + }, + }, + '#livenessProbe':: d.obj(help='"Periodic probe of container liveness.\\nContainer will be restarted if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + livenessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { livenessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { livenessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { livenessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { livenessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { livenessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { livenessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { livenessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { livenessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { livenessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { livenessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { livenessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { livenessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#ports':: d.obj(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."'), + ports: { + '#withContainerPort':: d.fn(help="\"Number of port to expose on the pod's IP address.\\nThis must be a valid port number, 0 \u003c x \u003c 65536.\"", args=[d.arg(name='containerPort', type=d.T.integer)]), + withContainerPort(containerPort): { containerPort: containerPort }, + '#withHostIP':: d.fn(help='"What host IP to bind the external port to."', args=[d.arg(name='hostIP', type=d.T.string)]), + withHostIP(hostIP): { hostIP: hostIP }, + '#withHostPort':: d.fn(help='"Number of port to expose on the host.\\nIf specified, this must be a valid port number, 0 < x < 65536.\\nIf HostNetwork is specified, this must match ContainerPort.\\nMost containers do not need this."', args=[d.arg(name='hostPort', type=d.T.integer)]), + withHostPort(hostPort): { hostPort: hostPort }, + '#withName':: d.fn(help='"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\\nnamed port in a pod must have a unique name. Name for the port that can be\\nreferred to by services."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withProtocol':: d.fn(help='"Protocol for port. Must be UDP, TCP, or SCTP.\\nDefaults to \\"TCP\\"."', args=[d.arg(name='protocol', type=d.T.string)]), + withProtocol(protocol): { protocol: protocol }, + }, + '#readinessProbe':: d.obj(help='"Periodic probe of container service readiness.\\nContainer will be removed from service endpoints if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + readinessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { readinessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { readinessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { readinessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { readinessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { readinessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { readinessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { readinessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { readinessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { readinessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { readinessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { readinessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { readinessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#resizePolicy':: d.obj(help='"Resources resize policy for the container."'), + resizePolicy: { + '#withResourceName':: d.fn(help='"Name of the resource to which this resource resize policy applies.\\nSupported values: cpu, memory."', args=[d.arg(name='resourceName', type=d.T.string)]), + withResourceName(resourceName): { resourceName: resourceName }, + '#withRestartPolicy':: d.fn(help='"Restart policy to apply when specified resource is resized.\\nIf not specified, it defaults to NotRequired."', args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + }, + '#resources':: d.obj(help='"Compute Resources required by this container.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { resources+: { limits: limits } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { resources+: { limits+: limits } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { resources+: { requests: requests } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { resources+: { requests+: requests } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with.\\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#appArmorProfile':: d.obj(help="\"appArmorProfile is the AppArmor options to use by this container. If set, this profile\\noverrides the pod's appArmorProfile.\\nNote that this field cannot be set when spec.os.name is windows.\""), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { appArmorProfile+: { type: type } } }, + }, + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers.\\nDefaults to the default set of capabilities granted by the container runtime.\\nNote that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { securityContext+: { seLinuxOptions+: { level: level } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { securityContext+: { seLinuxOptions+: { role: role } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seLinuxOptions+: { type: type } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { securityContext+: { seLinuxOptions+: { user: user } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are\\nprovided at both the pod & container level, the container options\\noverride the pod options.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seccompProfile+: { type: type } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers.\\nIf unspecified, the options from the PodSecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more\\nprivileges than its parent process. This bool directly controls if\\nthe no_new_privs flag will be set on the container process.\\nAllowPrivilegeEscalation is true always when the container is:\\n1) run as Privileged\\n2) has CAP_SYS_ADMIN\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode.\\nProcesses in privileged containers are essentially equivalent to root on the host.\\nDefaults to false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { securityContext+: { privileged: privileged } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers.\\nThe default is DefaultProcMount which uses the container runtime defaults for\\nreadonly paths and masked paths.\\nThis requires the ProcMountType feature flag to be enabled.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { securityContext+: { procMount: procMount } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem.\\nDefault is false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { securityContext+: { runAsGroup: runAsGroup } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { securityContext+: { runAsNonRoot: runAsNonRoot } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { securityContext+: { runAsUser: runAsUser } }, + }, + '#startupProbe':: d.obj(help="\"StartupProbe indicates that the Pod has successfully initialized.\\nIf specified, no other probes are executed until this completes successfully.\\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\\nThis cannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\""), + startupProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { startupProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { startupProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { startupProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { startupProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { startupProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { startupProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { startupProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { startupProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { startupProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { startupProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { startupProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { startupProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#volumeDevices':: d.obj(help='"volumeDevices is the list of block devices to be used by the container."'), + volumeDevices: { + '#withDevicePath':: d.fn(help='"devicePath is the path inside of the container that the device will be mapped to."', args=[d.arg(name='devicePath', type=d.T.string)]), + withDevicePath(devicePath): { devicePath: devicePath }, + '#withName':: d.fn(help='"name must match the name of a persistentVolumeClaim in the pod"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#volumeMounts':: d.obj(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withArgs':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='args', type=d.T.array)]), + withArgs(args): { args: if std.isArray(v=args) then args else [args] }, + '#withArgsMixin':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='args', type=d.T.array)]), + withArgsMixin(args): { args+: if std.isArray(v=args) then args else [args] }, + '#withCommand':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { command: if std.isArray(v=command) then command else [command] }, + '#withCommandMixin':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { command+: if std.isArray(v=command) then command else [command] }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { env: if std.isArray(v=env) then env else [env] }, + '#withEnvFrom':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFrom(envFrom): { envFrom: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvFromMixin':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFromMixin(envFrom): { envFrom+: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { env+: if std.isArray(v=env) then env else [env] }, + '#withImage':: d.fn(help='"Container image name.\\nMore info: https://kubernetes.io/docs/concepts/containers/images\\nThis field is optional to allow higher level config management to default or override\\ncontainer images in workload controllers like Deployments and StatefulSets."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { image: image }, + '#withImagePullPolicy':: d.fn(help='"Image pull policy.\\nOne of Always, Never, IfNotPresent.\\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images"', args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { imagePullPolicy: imagePullPolicy }, + '#withName':: d.fn(help='"Name of the container specified as a DNS_LABEL.\\nEach container in a pod must have a unique name (DNS_LABEL).\\nCannot be updated."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPorts':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."', args=[d.arg(name='ports', type=d.T.array)]), + withPorts(ports): { ports: if std.isArray(v=ports) then ports else [ports] }, + '#withPortsMixin':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ports', type=d.T.array)]), + withPortsMixin(ports): { ports+: if std.isArray(v=ports) then ports else [ports] }, + '#withResizePolicy':: d.fn(help='"Resources resize policy for the container."', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicy(resizePolicy): { resizePolicy: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withResizePolicyMixin':: d.fn(help='"Resources resize policy for the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicyMixin(resizePolicy): { resizePolicy+: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withRestartPolicy':: d.fn(help="\"RestartPolicy defines the restart behavior of individual containers in a pod.\\nThis field may only be set for init containers, and the only allowed value is \\\"Always\\\".\\nFor non-init containers or when this field is not specified,\\nthe restart behavior is defined by the Pod's restart policy and the container type.\\nSetting the RestartPolicy as \\\"Always\\\" for the init container will have the following effect:\\nthis init container will be continually restarted on\\nexit until all regular containers have terminated. Once all regular\\ncontainers have completed, all init containers with restartPolicy \\\"Always\\\"\\nwill be shut down. This lifecycle differs from normal init containers and\\nis often referred to as a \\\"sidecar\\\" container. Although this init\\ncontainer still starts in the init container sequence, it does not wait\\nfor the container to complete before proceeding to the next init\\ncontainer. Instead, the next init container starts immediately after this\\ninit container is started, or after any startupProbe has successfully\\ncompleted.\"", args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + '#withStdin':: d.fn(help='"Whether this container should allocate a buffer for stdin in the container runtime. If this\\nis not set, reads from stdin in the container will always result in EOF.\\nDefault is false."', args=[d.arg(name='stdin', type=d.T.boolean)]), + withStdin(stdin): { stdin: stdin }, + '#withStdinOnce':: d.fn(help='"Whether the container runtime should close the stdin channel after it has been opened by\\na single attach. When stdin is true the stdin stream will remain open across multiple attach\\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\\nat which time stdin is closed and remains closed until the container is restarted. If this\\nflag is false, a container processes that reads from stdin will never receive an EOF.\\nDefault is false"', args=[d.arg(name='stdinOnce', type=d.T.boolean)]), + withStdinOnce(stdinOnce): { stdinOnce: stdinOnce }, + '#withTerminationMessagePath':: d.fn(help="\"Optional: Path at which the file to which the container's termination message\\nwill be written is mounted into the container's filesystem.\\nMessage written is intended to be brief final status, such as an assertion failure message.\\nWill be truncated by the node if greater than 4096 bytes. The total message length across\\nall containers will be limited to 12kb.\\nDefaults to /dev/termination-log.\\nCannot be updated.\"", args=[d.arg(name='terminationMessagePath', type=d.T.string)]), + withTerminationMessagePath(terminationMessagePath): { terminationMessagePath: terminationMessagePath }, + '#withTerminationMessagePolicy':: d.fn(help='"Indicate how the termination message should be populated. File will use the contents of\\nterminationMessagePath to populate the container status message on both success and failure.\\nFallbackToLogsOnError will use the last chunk of container log output if the termination\\nmessage file is empty and the container exited with an error.\\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\\nDefaults to File.\\nCannot be updated."', args=[d.arg(name='terminationMessagePolicy', type=d.T.string)]), + withTerminationMessagePolicy(terminationMessagePolicy): { terminationMessagePolicy: terminationMessagePolicy }, + '#withTty':: d.fn(help="\"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\\nDefault is false.\"", args=[d.arg(name='tty', type=d.T.boolean)]), + withTty(tty): { tty: tty }, + '#withVolumeDevices':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevices(volumeDevices): { volumeDevices: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeDevicesMixin':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevicesMixin(volumeDevices): { volumeDevices+: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeMounts':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withVolumeMountsMixin':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withWorkingDir':: d.fn(help="\"Container's working directory.\\nIf not specified, the container runtime's default will be used, which\\nmight be configured in the container image.\\nCannot be updated.\"", args=[d.arg(name='workingDir', type=d.T.string)]), + withWorkingDir(workingDir): { workingDir: workingDir }, + }, + '#objectStorageConfig':: d.obj(help='"ObjectStorageConfig configures object storage in Thanos.\\nAlternative to ObjectStorageConfigFile, and lower order priority."'), + objectStorageConfig: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { objectStorageConfig+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { objectStorageConfig+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { objectStorageConfig+: { optional: optional } } }, + }, + '#podMetadata':: d.obj(help='"PodMetadata configures labels and annotations which are propagated to the ThanosRuler pods.\\n\\n\\nThe following items are reserved and cannot be overridden:\\n* \\"app.kubernetes.io/name\\" label, set to \\"thanos-ruler\\".\\n* \\"app.kubernetes.io/managed-by\\" label, set to \\"prometheus-operator\\".\\n* \\"app.kubernetes.io/instance\\" label, set to the name of the ThanosRuler instance.\\n* \\"thanos-ruler\\" label, set to the name of the ThanosRuler instance.\\n* \\"kubectl.kubernetes.io/default-container\\" annotation, set to \\"thanos-ruler\\"."'), + podMetadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { podMetadata+: { annotations: annotations } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { podMetadata+: { annotations+: annotations } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { podMetadata+: { labels: labels } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { podMetadata+: { labels+: labels } } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although\\nsome resources may allow a client to request the generation of an appropriate name\\nautomatically. Name is primarily intended for creation idempotence and configuration\\ndefinition.\\nCannot be updated.\\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { podMetadata+: { name: name } } }, + }, + '#prometheusRulesExcludedFromEnforce':: d.obj(help='"PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing\\nof adding namespace labels. Works only if enforcedNamespaceLabel set to true.\\nMake sure both ruleNamespace and ruleName are set for each pair\\nDeprecated: use excludedFromEnforcement instead."'), + prometheusRulesExcludedFromEnforce: { + '#withRuleName':: d.fn(help='"Name of the excluded PrometheusRule object."', args=[d.arg(name='ruleName', type=d.T.string)]), + withRuleName(ruleName): { ruleName: ruleName }, + '#withRuleNamespace':: d.fn(help='"Namespace of the excluded PrometheusRule object."', args=[d.arg(name='ruleNamespace', type=d.T.string)]), + withRuleNamespace(ruleNamespace): { ruleNamespace: ruleNamespace }, + }, + '#queryConfig':: d.obj(help='"Define configuration for connecting to thanos query instances.\\nIf this is defined, the QueryEndpoints field will be ignored.\\nMaps to the `query.config` CLI argument.\\nOnly available with thanos v0.11.0 and higher."'), + queryConfig: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { queryConfig+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { queryConfig+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { queryConfig+: { optional: optional } } }, + }, + '#resources':: d.obj(help='"Resources defines the resource requirements for single Pods.\\nIf not provided, no requests/limits will be set"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { spec+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { spec+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { resources+: { limits: limits } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { resources+: { limits+: limits } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { resources+: { requests: requests } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { resources+: { requests+: requests } } }, + }, + '#ruleNamespaceSelector':: d.obj(help='"Namespaces to be selected for Rules discovery. If unspecified, only\\nthe same namespace as the ThanosRuler object is in is used."'), + ruleNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { ruleNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { ruleNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { ruleNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { ruleNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#ruleSelector':: d.obj(help='"A label selector to select which PrometheusRules to mount for alerting and\\nrecording."'), + ruleSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { ruleSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { ruleSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { ruleSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { ruleSelector+: { matchLabels+: matchLabels } } }, + }, + '#securityContext':: d.obj(help='"SecurityContext holds pod-level security attributes and common container settings.\\nThis defaults to the default PodSecurityContext."'), + securityContext: { + '#appArmorProfile':: d.obj(help='"appArmorProfile is the AppArmor options to use by the containers in this pod.\\nNote that this field cannot be set when spec.os.name is windows."'), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { appArmorProfile+: { type: type } } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to all containers.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in SecurityContext. If set in\\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\\ntakes precedence for that container.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { spec+: { securityContext+: { seLinuxOptions+: { level: level } } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { spec+: { securityContext+: { seLinuxOptions+: { role: role } } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { seLinuxOptions+: { type: type } } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { spec+: { securityContext+: { seLinuxOptions+: { user: user } } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by the containers in this pod.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { seccompProfile+: { type: type } } } }, + }, + '#sysctls':: d.obj(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."'), + sysctls: { + '#withName':: d.fn(help='"Name of a property to set"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Value of a property to set"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#windowsOptions':: d.obj(help="\"The Windows specific settings applied to all containers.\\nIf unspecified, the options within a container's SecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux.\""), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { spec+: { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { spec+: { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { spec+: { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { spec+: { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } } }, + }, + '#withFsGroup':: d.fn(help="\"A special supplemental group that applies to all containers in a pod.\\nSome volume types allow the Kubelet to change the ownership of that volume\\nto be owned by the pod:\\n\\n\\n1. The owning GID will be the FSGroup\\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\\n3. The permission bits are OR'd with rw-rw----\\n\\n\\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\\nNote that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='fsGroup', type=d.T.integer)]), + withFsGroup(fsGroup): { spec+: { securityContext+: { fsGroup: fsGroup } } }, + '#withFsGroupChangePolicy':: d.fn(help='"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\\nbefore being exposed inside Pod. This field will only apply to\\nvolume types which support fsGroup based ownership(and permissions).\\nIt will have no effect on ephemeral volume types such as: secret, configmaps\\nand emptydir.\\nValid values are \\"OnRootMismatch\\" and \\"Always\\". If not specified, \\"Always\\" is used.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='fsGroupChangePolicy', type=d.T.string)]), + withFsGroupChangePolicy(fsGroupChangePolicy): { spec+: { securityContext+: { fsGroupChangePolicy: fsGroupChangePolicy } } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence\\nfor that container.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { spec+: { securityContext+: { runAsGroup: runAsGroup } } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { spec+: { securityContext+: { runAsNonRoot: runAsNonRoot } } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence\\nfor that container.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { spec+: { securityContext+: { runAsUser: runAsUser } } }, + '#withSupplementalGroups':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition\\nto the container's primary GID, the fsGroup (if specified), and group memberships\\ndefined in the container image for the uid of the container process. If unspecified,\\nno additional groups are added to any container. Note that group memberships\\ndefined in the container image for the uid of the container process are still effective,\\neven if they are not included in this list.\\nNote that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroups(supplementalGroups): { spec+: { securityContext+: { supplementalGroups: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } }, + '#withSupplementalGroupsMixin':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition\\nto the container's primary GID, the fsGroup (if specified), and group memberships\\ndefined in the container image for the uid of the container process. If unspecified,\\nno additional groups are added to any container. Note that group memberships\\ndefined in the container image for the uid of the container process are still effective,\\neven if they are not included in this list.\\nNote that this field cannot be set when spec.os.name is windows.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroupsMixin(supplementalGroups): { spec+: { securityContext+: { supplementalGroups+: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } }, + '#withSysctls':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctls(sysctls): { spec+: { securityContext+: { sysctls: if std.isArray(v=sysctls) then sysctls else [sysctls] } } }, + '#withSysctlsMixin':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctlsMixin(sysctls): { spec+: { securityContext+: { sysctls+: if std.isArray(v=sysctls) then sysctls else [sysctls] } } }, + }, + '#storage':: d.obj(help='"Storage spec to specify how storage shall be used."'), + storage: { + '#emptyDir':: d.obj(help='"EmptyDirVolumeSource to be used by the StatefulSet.\\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir"'), + emptyDir: { + '#withMedium':: d.fn(help="\"medium represents what type of storage medium should back this directory.\\nThe default is \\\"\\\" which means to use the node's default medium.\\nMust be an empty string (default) or Memory.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\"", args=[d.arg(name='medium', type=d.T.string)]), + withMedium(medium): { spec+: { storage+: { emptyDir+: { medium: medium } } } }, + '#withSizeLimit':: d.fn(help='"sizeLimit is the total amount of local storage required for this EmptyDir volume.\\nThe size limit is also applicable for memory medium.\\nThe maximum usage on memory medium EmptyDir would be the minimum value between\\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\\nThe default is nil which means that the limit is undefined.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"', args=[d.arg(name='sizeLimit', type=d.T.any)]), + withSizeLimit(sizeLimit): { spec+: { storage+: { emptyDir+: { sizeLimit: sizeLimit } } } }, + }, + '#ephemeral':: d.obj(help='"EphemeralVolumeSource to be used by the StatefulSet.\\nThis is a beta field in k8s 1.21 and GA in 1.15.\\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes"'), + ephemeral: { + '#volumeClaimTemplate':: d.obj(help='"Will be used to create a stand-alone PVC to provision the volume.\\nThe pod in which this EphemeralVolumeSource is embedded will be the\\nowner of the PVC, i.e. the PVC will be deleted together with the\\npod. The name of the PVC will be `-` where\\n`` is the name from the `PodSpec.Volumes` array\\nentry. Pod validation will reject the pod if the concatenated name\\nis not valid for a PVC (for example, too long).\\n\\n\\nAn existing PVC with that name that is not owned by the pod\\nwill *not* be used for the pod to avoid using an unrelated\\nvolume by mistake. Starting the pod is then blocked until\\nthe unrelated PVC is removed. If such a pre-created PVC is\\nmeant to be used by the pod, the PVC has to updated with an\\nowner reference to the pod once the pod exists. Normally\\nthis should not be necessary, but it may be useful when\\nmanually reconstructing a broken cluster.\\n\\n\\nThis field is read-only and no changes will be made by Kubernetes\\nto the PVC after it has been created.\\n\\n\\nRequired, must not be nil."'), + volumeClaimTemplate: { + '#spec':: d.obj(help='"The specification for the PersistentVolumeClaim. The entire content is\\ncopied unchanged into the PVC that gets created from this\\ntemplate. The same fields as in a PersistentVolumeClaim\\nare also valid here."'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } } } }, + }, + '#withMetadata':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadata(metadata): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { metadata: metadata } } } } }, + '#withMetadataMixin':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadataMixin(metadata): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { metadata+: metadata } } } } }, + }, + }, + '#volumeClaimTemplate':: d.obj(help='"Defines the PVC spec to be used by the Prometheus StatefulSets.\\nThe easiest way to use a volume that cannot be automatically provisioned\\nis to use a label selector alongside manually created PersistentVolumes."'), + volumeClaimTemplate: { + '#metadata':: d.obj(help='"EmbeddedMetadata contains metadata relevant to an EmbeddedResource."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { annotations: annotations } } } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { annotations+: annotations } } } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { labels: labels } } } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { labels+: labels } } } } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although\\nsome resources may allow a client to request the generation of an appropriate name\\nautomatically. Name is primarily intended for creation idempotence and configuration\\ndefinition.\\nCannot be updated.\\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { name: name } } } } }, + }, + '#spec':: d.obj(help='"Defines the desired characteristics of a volume requested by a pod author.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } } }, + }, + '#withApiVersion':: d.fn(help='"APIVersion defines the versioned schema of this representation of an object.\\nServers should convert recognized schemas to the latest internal value, and\\nmay reject unrecognized values.\\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { storage+: { volumeClaimTemplate+: { apiVersion: apiVersion } } } }, + '#withKind':: d.fn(help='"Kind is a string value representing the REST resource this object represents.\\nServers may infer this from the endpoint the client submits requests to.\\nCannot be updated.\\nIn CamelCase.\\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { kind: kind } } } }, + }, + '#withDisableMountSubPath':: d.fn(help='"Deprecated: subPath usage will be removed in a future release."', args=[d.arg(name='disableMountSubPath', type=d.T.boolean)]), + withDisableMountSubPath(disableMountSubPath): { spec+: { storage+: { disableMountSubPath: disableMountSubPath } } }, + }, + '#tolerations':: d.obj(help="\"If specified, the pod's tolerations.\""), + tolerations: { + '#withEffect':: d.fn(help='"Effect indicates the taint effect to match. Empty means match all taint effects.\\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."', args=[d.arg(name='effect', type=d.T.string)]), + withEffect(effect): { effect: effect }, + '#withKey':: d.fn(help='"Key is the taint key that the toleration applies to. Empty means match all taint keys.\\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Operator represents a key's relationship to the value.\\nValid operators are Exists and Equal. Defaults to Equal.\\nExists is equivalent to wildcard for value, so that a pod can\\ntolerate all taints of a particular category.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withTolerationSeconds':: d.fn(help='"TolerationSeconds represents the period of time the toleration (which must be\\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\\nit is not set, which means tolerate the taint forever (do not evict). Zero and\\nnegative values will be treated as 0 (evict immediately) by the system."', args=[d.arg(name='tolerationSeconds', type=d.T.integer)]), + withTolerationSeconds(tolerationSeconds): { tolerationSeconds: tolerationSeconds }, + '#withValue':: d.fn(help='"Value is the taint value the toleration matches to.\\nIf the operator is Exists, the value should be empty, otherwise just a regular string."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#topologySpreadConstraints':: d.obj(help="\"If specified, the pod's topology spread constraints.\""), + topologySpreadConstraints: { + '#labelSelector':: d.obj(help='"LabelSelector is used to find matching pods.\\nPods that match this label selector are counted to determine the number of pods\\nin their corresponding topology domain."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select the pods over which\\nspreading will be calculated. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are ANDed with labelSelector\\nto select the group of existing pods over which spreading will be calculated\\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\\nMatchLabelKeys cannot be set when LabelSelector isn't set.\\nKeys that don't exist in the incoming pod labels will\\nbe ignored. A null or empty list means only match against labelSelector.\\n\\n\\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select the pods over which\\nspreading will be calculated. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are ANDed with labelSelector\\nto select the group of existing pods over which spreading will be calculated\\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\\nMatchLabelKeys cannot be set when LabelSelector isn't set.\\nKeys that don't exist in the incoming pod labels will\\nbe ignored. A null or empty list means only match against labelSelector.\\n\\n\\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMaxSkew':: d.fn(help="\"MaxSkew describes the degree to which pods may be unevenly distributed.\\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\\nbetween the number of matching pods in the target topology and the global minimum.\\nThe global minimum is the minimum number of matching pods in an eligible domain\\nor zero if the number of eligible domains is less than MinDomains.\\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\\nlabelSelector spread as 2/2/1:\\nIn this case, the global minimum is 1.\\n| zone1 | zone2 | zone3 |\\n| P P | P P | P |\\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\\nviolate MaxSkew(1).\\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\\nto topologies that satisfy it.\\nIt's a required field. Default value is 1 and 0 is not allowed.\"", args=[d.arg(name='maxSkew', type=d.T.integer)]), + withMaxSkew(maxSkew): { maxSkew: maxSkew }, + '#withMinDomains':: d.fn(help="\"MinDomains indicates a minimum number of eligible domains.\\nWhen the number of eligible domains with matching topology keys is less than minDomains,\\nPod Topology Spread treats \\\"global minimum\\\" as 0, and then the calculation of Skew is performed.\\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\\nthis value has no effect on scheduling.\\nAs a result, when the number of eligible domains is less than minDomains,\\nscheduler won't schedule more than maxSkew Pods to those domains.\\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\\nValid values are integers greater than 0.\\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\\n\\n\\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\\nlabelSelector spread as 2/2/2:\\n| zone1 | zone2 | zone3 |\\n| P P | P P | P P |\\nThe number of domains is less than 5(MinDomains), so \\\"global minimum\\\" is treated as 0.\\nIn this situation, new pod with the same labelSelector cannot be scheduled,\\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\\nit will violate MaxSkew.\"", args=[d.arg(name='minDomains', type=d.T.integer)]), + withMinDomains(minDomains): { minDomains: minDomains }, + '#withNodeAffinityPolicy':: d.fn(help="\"NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\\nwhen calculating pod topology spread skew. Options are:\\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\\n\\n\\nIf this value is nil, the behavior is equivalent to the Honor policy.\\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.\"", args=[d.arg(name='nodeAffinityPolicy', type=d.T.string)]), + withNodeAffinityPolicy(nodeAffinityPolicy): { nodeAffinityPolicy: nodeAffinityPolicy }, + '#withNodeTaintsPolicy':: d.fn(help='"NodeTaintsPolicy indicates how we will treat node taints when calculating\\npod topology spread skew. Options are:\\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\\nhas a toleration, are included.\\n- Ignore: node taints are ignored. All nodes are included.\\n\\n\\nIf this value is nil, the behavior is equivalent to the Ignore policy.\\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."', args=[d.arg(name='nodeTaintsPolicy', type=d.T.string)]), + withNodeTaintsPolicy(nodeTaintsPolicy): { nodeTaintsPolicy: nodeTaintsPolicy }, + '#withTopologyKey':: d.fn(help="\"TopologyKey is the key of node labels. Nodes that have a label with this key\\nand identical values are considered to be in the same topology.\\nWe consider each \u003ckey, value\u003e as a \\\"bucket\\\", and try to put balanced number\\nof pods into each bucket.\\nWe define a domain as a particular instance of a topology.\\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\\nnodeAffinityPolicy and nodeTaintsPolicy.\\ne.g. If TopologyKey is \\\"kubernetes.io/hostname\\\", each Node is a domain of that topology.\\nAnd, if TopologyKey is \\\"topology.kubernetes.io/zone\\\", each zone is a domain of that topology.\\nIt's a required field.\"", args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + '#withWhenUnsatisfiable':: d.fn(help="\"WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\\nthe spread constraint.\\n- DoNotSchedule (default) tells the scheduler not to schedule it.\\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\\n but giving higher precedence to topologies that would help reduce the\\n skew.\\nA constraint is considered \\\"Unsatisfiable\\\" for an incoming pod\\nif and only if every possible node assignment for that pod would violate\\n\\\"MaxSkew\\\" on some topology.\\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\\nlabelSelector spread as 3/1/1:\\n| zone1 | zone2 | zone3 |\\n| P P P | P | P |\\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\\nwon't make it *more* imbalanced.\\nIt's a required field.\"", args=[d.arg(name='whenUnsatisfiable', type=d.T.string)]), + withWhenUnsatisfiable(whenUnsatisfiable): { whenUnsatisfiable: whenUnsatisfiable }, + }, + '#tracingConfig':: d.obj(help='"TracingConfig configures tracing in Thanos.\\n\\n\\n`tracingConfigFile` takes precedence over this field.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."'), + tracingConfig: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { optional: optional } } }, + }, + '#volumeMounts':: d.obj(help='"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\\nVolumeMounts specified will be appended to other VolumeMounts in the ruler container,\\nthat are generated as a result of StorageSpec objects."'), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#volumes':: d.obj(help='"Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will\\nbe appended to other volumes that are generated as a result of StorageSpec objects."'), + volumes: { + '#awsElasticBlockStore':: d.obj(help="\"awsElasticBlockStore represents an AWS Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\""), + awsElasticBlockStore: { + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { awsElasticBlockStore+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount.\\nIf omitted, the default is to mount by volume name.\\nExamples: For volume /dev/sda1, you specify the partition as \\"1\\".\\nSimilarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty)."', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { awsElasticBlockStore+: { partition: partition } }, + '#withReadOnly':: d.fn(help='"readOnly value true will force the readOnly setting in VolumeMounts.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { awsElasticBlockStore+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { awsElasticBlockStore+: { volumeID: volumeID } }, + }, + '#azureDisk':: d.obj(help='"azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."'), + azureDisk: { + '#withCachingMode':: d.fn(help='"cachingMode is the Host Caching mode: None, Read Only, Read Write."', args=[d.arg(name='cachingMode', type=d.T.string)]), + withCachingMode(cachingMode): { azureDisk+: { cachingMode: cachingMode } }, + '#withDiskName':: d.fn(help='"diskName is the Name of the data disk in the blob storage"', args=[d.arg(name='diskName', type=d.T.string)]), + withDiskName(diskName): { azureDisk+: { diskName: diskName } }, + '#withDiskURI':: d.fn(help='"diskURI is the URI of data disk in the blob storage"', args=[d.arg(name='diskURI', type=d.T.string)]), + withDiskURI(diskURI): { azureDisk+: { diskURI: diskURI } }, + '#withFsType':: d.fn(help='"fsType is Filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { azureDisk+: { fsType: fsType } }, + '#withKind':: d.fn(help='"kind expected values are 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"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { azureDisk+: { kind: kind } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureDisk+: { readOnly: readOnly } }, + }, + '#azureFile':: d.obj(help='"azureFile represents an Azure File Service mount on the host and bind mount to the pod."'), + azureFile: { + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureFile+: { readOnly: readOnly } }, + '#withSecretName':: d.fn(help='"secretName is the name of secret that contains Azure Storage Account Name and Key"', args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { azureFile+: { secretName: secretName } }, + '#withShareName':: d.fn(help='"shareName is the azure share Name"', args=[d.arg(name='shareName', type=d.T.string)]), + withShareName(shareName): { azureFile+: { shareName: shareName } }, + }, + '#cephfs':: d.obj(help="\"cephFS represents a Ceph FS mount on the host that shares a pod's lifetime\""), + cephfs: { + '#secretRef':: d.obj(help='"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cephfs+: { secretRef+: { name: name } } }, + }, + '#withMonitors':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { cephfs+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { cephfs+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPath':: d.fn(help='"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { cephfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts.\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cephfs+: { readOnly: readOnly } }, + '#withSecretFile':: d.fn(help='"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='secretFile', type=d.T.string)]), + withSecretFile(secretFile): { cephfs+: { secretFile: secretFile } }, + '#withUser':: d.fn(help='"user is optional: User is the rados user name, default is admin\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { cephfs+: { user: user } }, + }, + '#cinder':: d.obj(help='"cinder represents a cinder volume attached and mounted on kubelets host machine.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"'), + cinder: { + '#secretRef':: d.obj(help='"secretRef is optional: points to a secret object containing parameters used to connect\\nto OpenStack."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cinder+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { cinder+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cinder+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID used to identify the volume in cinder.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { cinder+: { volumeID: volumeID } }, + }, + '#configMap':: d.obj(help='"configMap represents a configMap that should populate this volume"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is optional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDefaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { configMap+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#csi':: d.obj(help='"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)."'), + csi: { + '#nodePublishSecretRef':: d.obj(help='"nodePublishSecretRef is a reference to the secret object containing\\nsensitive information to pass to the CSI driver to complete the CSI\\nNodePublishVolume and NodeUnpublishVolume calls.\\nThis field is optional, and may be empty if no secret is required. If the\\nsecret object contains more than one secret, all secret references are passed."'), + nodePublishSecretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { csi+: { nodePublishSecretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the CSI driver that handles this volume.\\nConsult with your admin for the correct name as registered in the cluster."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { csi+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType to mount. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\".\\nIf not provided, the empty value is passed to the associated CSI driver\\nwhich will determine the default filesystem to apply."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { csi+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly specifies a read-only configuration for the volume.\\nDefaults to false (read/write)."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { csi+: { readOnly: readOnly } }, + '#withVolumeAttributes':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI\\ndriver. Consult your driver's documentation for supported values.\"", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributes(volumeAttributes): { csi+: { volumeAttributes: volumeAttributes } }, + '#withVolumeAttributesMixin':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI\\ndriver. Consult your driver's documentation for supported values.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributesMixin(volumeAttributes): { csi+: { volumeAttributes+: volumeAttributes } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI represents downward API about the pod that should populate this volume"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of downward API volume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value\\nbetween 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"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 '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"Optional: mode bits to use on created files by default. Must be a\\nOptional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDefaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { downwardAPI+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help='"Items is a list of downward API volume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of downward API volume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#emptyDir':: d.obj(help="\"emptyDir represents a temporary directory that shares a pod's lifetime.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\""), + emptyDir: { + '#withMedium':: d.fn(help="\"medium represents what type of storage medium should back this directory.\\nThe default is \\\"\\\" which means to use the node's default medium.\\nMust be an empty string (default) or Memory.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\"", args=[d.arg(name='medium', type=d.T.string)]), + withMedium(medium): { emptyDir+: { medium: medium } }, + '#withSizeLimit':: d.fn(help='"sizeLimit is the total amount of local storage required for this EmptyDir volume.\\nThe size limit is also applicable for memory medium.\\nThe maximum usage on memory medium EmptyDir would be the minimum value between\\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\\nThe default is nil which means that the limit is undefined.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"', args=[d.arg(name='sizeLimit', type=d.T.any)]), + withSizeLimit(sizeLimit): { emptyDir+: { sizeLimit: sizeLimit } }, + }, + '#ephemeral':: d.obj(help="\"ephemeral represents a volume that is handled by a cluster storage driver.\\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\\nand deleted when the pod is removed.\\n\\n\\nUse this if:\\na) the volume is only needed while the pod runs,\\nb) features of normal volumes like restoring from snapshot or capacity\\n tracking are needed,\\nc) the storage driver is specified through a storage class, and\\nd) the storage driver supports dynamic volume provisioning through\\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\\n information on the connection between this volume type\\n and PersistentVolumeClaim).\\n\\n\\nUse PersistentVolumeClaim or one of the vendor-specific\\nAPIs for volumes that persist for longer than the lifecycle\\nof an individual pod.\\n\\n\\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\\nbe used that way - see the documentation of the driver for\\nmore information.\\n\\n\\nA pod can use both types of ephemeral volumes and\\npersistent volumes at the same time.\""), + ephemeral: { + '#volumeClaimTemplate':: d.obj(help='"Will be used to create a stand-alone PVC to provision the volume.\\nThe pod in which this EphemeralVolumeSource is embedded will be the\\nowner of the PVC, i.e. the PVC will be deleted together with the\\npod. The name of the PVC will be `-` where\\n`` is the name from the `PodSpec.Volumes` array\\nentry. Pod validation will reject the pod if the concatenated name\\nis not valid for a PVC (for example, too long).\\n\\n\\nAn existing PVC with that name that is not owned by the pod\\nwill *not* be used for the pod to avoid using an unrelated\\nvolume by mistake. Starting the pod is then blocked until\\nthe unrelated PVC is removed. If such a pre-created PVC is\\nmeant to be used by the pod, the PVC has to updated with an\\nowner reference to the pod once the pod exists. Normally\\nthis should not be necessary, but it may be useful when\\nmanually reconstructing a broken cluster.\\n\\n\\nThis field is read-only and no changes will be made by Kubernetes\\nto the PVC after it has been created.\\n\\n\\nRequired, must not be nil."'), + volumeClaimTemplate: { + '#spec':: d.obj(help='"The specification for the PersistentVolumeClaim. The entire content is\\ncopied unchanged into the PVC that gets created from this\\ntemplate. The same fields as in a PersistentVolumeClaim\\nare also valid here."'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { ephemeral+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } }, + }, + '#withMetadata':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadata(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata: metadata } } }, + '#withMetadataMixin':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadataMixin(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata+: metadata } } }, + }, + }, + '#fc':: d.obj(help="\"fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\""), + fc: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { fc+: { fsType: fsType } }, + '#withLun':: d.fn(help='"lun is Optional: FC target lun number"', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { fc+: { lun: lun } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { fc+: { readOnly: readOnly } }, + '#withTargetWWNs':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNs(targetWWNs): { fc+: { targetWWNs: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withTargetWWNsMixin':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNsMixin(targetWWNs): { fc+: { targetWWNs+: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withWwids':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids)\\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously."', args=[d.arg(name='wwids', type=d.T.array)]), + withWwids(wwids): { fc+: { wwids: if std.isArray(v=wwids) then wwids else [wwids] } }, + '#withWwidsMixin':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids)\\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='wwids', type=d.T.array)]), + withWwidsMixin(wwids): { fc+: { wwids+: if std.isArray(v=wwids) then wwids else [wwids] } }, + }, + '#flexVolume':: d.obj(help='"flexVolume represents a generic volume resource that is\\nprovisioned/attached using an exec based plugin."'), + flexVolume: { + '#secretRef':: d.obj(help='"secretRef is Optional: secretRef is reference to the secret object containing\\nsensitive information to pass to the plugin scripts. This may be\\nempty if no secret object is specified. If the secret object\\ncontains more than one secret, all secrets are passed to the plugin\\nscripts."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { flexVolume+: { secretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the driver to use for this volume."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { flexVolume+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". The default filesystem depends on FlexVolume script."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { flexVolume+: { fsType: fsType } }, + '#withOptions':: d.fn(help='"options is Optional: this field holds extra command options if any."', args=[d.arg(name='options', type=d.T.object)]), + withOptions(options): { flexVolume+: { options: options } }, + '#withOptionsMixin':: d.fn(help='"options is Optional: this field holds extra command options if any."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='options', type=d.T.object)]), + withOptionsMixin(options): { flexVolume+: { options+: options } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { flexVolume+: { readOnly: readOnly } }, + }, + '#flocker':: d.obj(help="\"flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running\""), + flocker: { + '#withDatasetName':: d.fn(help='"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\\nshould be considered as deprecated"', args=[d.arg(name='datasetName', type=d.T.string)]), + withDatasetName(datasetName): { flocker+: { datasetName: datasetName } }, + '#withDatasetUUID':: d.fn(help='"datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset"', args=[d.arg(name='datasetUUID', type=d.T.string)]), + withDatasetUUID(datasetUUID): { flocker+: { datasetUUID: datasetUUID } }, + }, + '#gcePersistentDisk':: d.obj(help="\"gcePersistentDisk represents a GCE Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\""), + gcePersistentDisk: { + '#withFsType':: d.fn(help='"fsType is filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { gcePersistentDisk+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount.\\nIf omitted, the default is to mount by volume name.\\nExamples: For volume /dev/sda1, you specify the partition as \\"1\\".\\nSimilarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty).\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { gcePersistentDisk+: { partition: partition } }, + '#withPdName':: d.fn(help='"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='pdName', type=d.T.string)]), + withPdName(pdName): { gcePersistentDisk+: { pdName: pdName } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { gcePersistentDisk+: { readOnly: readOnly } }, + }, + '#gitRepo':: d.obj(help="\"gitRepo represents a git repository at a particular revision.\\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\\ninto the Pod's container.\""), + gitRepo: { + '#withDirectory':: d.fn(help="\"directory is the target directory name.\\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\\ngit repository. Otherwise, if specified, the volume will contain the git repository in\\nthe subdirectory with the given name.\"", args=[d.arg(name='directory', type=d.T.string)]), + withDirectory(directory): { gitRepo+: { directory: directory } }, + '#withRepository':: d.fn(help='"repository is the URL"', args=[d.arg(name='repository', type=d.T.string)]), + withRepository(repository): { gitRepo+: { repository: repository } }, + '#withRevision':: d.fn(help='"revision is the commit hash for the specified revision."', args=[d.arg(name='revision', type=d.T.string)]), + withRevision(revision): { gitRepo+: { revision: revision } }, + }, + '#glusterfs':: d.obj(help="\"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md\""), + glusterfs: { + '#withEndpoints':: d.fn(help='"endpoints is the endpoint name that details Glusterfs topology.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='endpoints', type=d.T.string)]), + withEndpoints(endpoints): { glusterfs+: { endpoints: endpoints } }, + '#withPath':: d.fn(help='"path is the Glusterfs volume path.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { glusterfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\\nDefaults to false.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { glusterfs+: { readOnly: readOnly } }, + }, + '#hostPath':: d.obj(help='"hostPath represents a pre-existing file or directory on the host\\nmachine that is directly exposed to the container. This is generally\\nused for system agents or other privileged things that are allowed\\nto see the host machine. Most containers will NOT need this.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\\n---\\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\\nmount host directories as read/write."'), + hostPath: { + '#withPath':: d.fn(help='"path of the directory on the host.\\nIf the path is a symlink, it will follow the link to the real path.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { hostPath+: { path: path } }, + '#withType':: d.fn(help='"type for HostPath Volume\\nDefaults to \\"\\"\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { hostPath+: { type: type } }, + }, + '#iscsi':: d.obj(help="\"iscsi represents an ISCSI Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://examples.k8s.io/volumes/iscsi/README.md\""), + iscsi: { + '#secretRef':: d.obj(help='"secretRef is the CHAP Secret for iSCSI target and initiator authentication"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { iscsi+: { secretRef+: { name: name } } }, + }, + '#withChapAuthDiscovery':: d.fn(help='"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication"', args=[d.arg(name='chapAuthDiscovery', type=d.T.boolean)]), + withChapAuthDiscovery(chapAuthDiscovery): { iscsi+: { chapAuthDiscovery: chapAuthDiscovery } }, + '#withChapAuthSession':: d.fn(help='"chapAuthSession defines whether support iSCSI Session CHAP authentication"', args=[d.arg(name='chapAuthSession', type=d.T.boolean)]), + withChapAuthSession(chapAuthSession): { iscsi+: { chapAuthSession: chapAuthSession } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { iscsi+: { fsType: fsType } }, + '#withInitiatorName':: d.fn(help='"initiatorName is the custom iSCSI Initiator Name.\\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\\n: will be created for the connection."', args=[d.arg(name='initiatorName', type=d.T.string)]), + withInitiatorName(initiatorName): { iscsi+: { initiatorName: initiatorName } }, + '#withIqn':: d.fn(help='"iqn is the target iSCSI Qualified Name."', args=[d.arg(name='iqn', type=d.T.string)]), + withIqn(iqn): { iscsi+: { iqn: iqn } }, + '#withIscsiInterface':: d.fn(help="\"iscsiInterface is the interface Name that uses an iSCSI transport.\\nDefaults to 'default' (tcp).\"", args=[d.arg(name='iscsiInterface', type=d.T.string)]), + withIscsiInterface(iscsiInterface): { iscsi+: { iscsiInterface: iscsiInterface } }, + '#withLun':: d.fn(help='"lun represents iSCSI Target Lun number."', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { iscsi+: { lun: lun } }, + '#withPortals':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='portals', type=d.T.array)]), + withPortals(portals): { iscsi+: { portals: if std.isArray(v=portals) then portals else [portals] } }, + '#withPortalsMixin':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='portals', type=d.T.array)]), + withPortalsMixin(portals): { iscsi+: { portals+: if std.isArray(v=portals) then portals else [portals] } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { iscsi+: { readOnly: readOnly } }, + '#withTargetPortal':: d.fn(help='"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='targetPortal', type=d.T.string)]), + withTargetPortal(targetPortal): { iscsi+: { targetPortal: targetPortal } }, + }, + '#nfs':: d.obj(help="\"nfs represents an NFS mount on the host that shares a pod's lifetime\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\""), + nfs: { + '#withPath':: d.fn(help='"path that is exported by the NFS server.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { nfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the NFS export to be mounted with read-only permissions.\\nDefaults to false.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { nfs+: { readOnly: readOnly } }, + '#withServer':: d.fn(help='"server is the hostname or IP address of the NFS server.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='server', type=d.T.string)]), + withServer(server): { nfs+: { server: server } }, + }, + '#persistentVolumeClaim':: d.obj(help='"persistentVolumeClaimVolumeSource represents a reference to a\\nPersistentVolumeClaim in the same namespace.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"'), + persistentVolumeClaim: { + '#withClaimName':: d.fn(help='"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"', args=[d.arg(name='claimName', type=d.T.string)]), + withClaimName(claimName): { persistentVolumeClaim+: { claimName: claimName } }, + '#withReadOnly':: d.fn(help='"readOnly Will force the ReadOnly setting in VolumeMounts.\\nDefault false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { persistentVolumeClaim+: { readOnly: readOnly } }, + }, + '#photonPersistentDisk':: d.obj(help='"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"'), + photonPersistentDisk: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { photonPersistentDisk+: { fsType: fsType } }, + '#withPdID':: d.fn(help='"pdID is the ID that identifies Photon Controller persistent disk"', args=[d.arg(name='pdID', type=d.T.string)]), + withPdID(pdID): { photonPersistentDisk+: { pdID: pdID } }, + }, + '#portworxVolume':: d.obj(help='"portworxVolume represents a portworx volume attached and mounted on kubelets host machine"'), + portworxVolume: { + '#withFsType':: d.fn(help='"fSType represents the filesystem type to mount\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { portworxVolume+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { portworxVolume+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID uniquely identifies a Portworx volume"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { portworxVolume+: { volumeID: volumeID } }, + }, + '#projected':: d.obj(help='"projected items for all in one resources secrets, configmaps, and downward API"'), + projected: { + '#sources':: d.obj(help='"sources is the list of volume projections"'), + sources: { + '#clusterTrustBundle':: d.obj(help='"ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\\nof ClusterTrustBundle objects in an auto-updating file.\\n\\n\\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\\n\\n\\nClusterTrustBundle objects can either be selected by name, or by the\\ncombination of signer name and a label selector.\\n\\n\\nKubelet performs aggressive normalization of the PEM contents written\\ninto the pod filesystem. Esoteric PEM features such as inter-block\\ncomments and block headers are stripped. Certificates are deduplicated.\\nThe ordering of certificates within the file is arbitrary, and Kubelet\\nmay change the order over time."'), + clusterTrustBundle: { + '#labelSelector':: d.obj(help='"Select all ClusterTrustBundles that match this label selector. Only has\\neffect if signerName is set. Mutually-exclusive with name. If unset,\\ninterpreted as \\"match nothing\\". If set but empty, interpreted as \\"match\\neverything\\"."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { clusterTrustBundle+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { clusterTrustBundle+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { clusterTrustBundle+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { clusterTrustBundle+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#withName':: d.fn(help='"Select a single ClusterTrustBundle by object name. Mutually-exclusive\\nwith signerName and labelSelector."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { clusterTrustBundle+: { name: name } }, + '#withOptional':: d.fn(help="\"If true, don't block pod startup if the referenced ClusterTrustBundle(s)\\naren't available. If using name, then the named ClusterTrustBundle is\\nallowed not to exist. If using signerName, then the combination of\\nsignerName and labelSelector is allowed to match zero\\nClusterTrustBundles.\"", args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { clusterTrustBundle+: { optional: optional } }, + '#withPath':: d.fn(help='"Relative path from the volume root to write the bundle."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { clusterTrustBundle+: { path: path } }, + '#withSignerName':: d.fn(help='"Select all ClusterTrustBundles that match this signer name.\\nMutually-exclusive with name. The contents of all selected\\nClusterTrustBundles will be unified and deduplicated."', args=[d.arg(name='signerName', type=d.T.string)]), + withSignerName(signerName): { clusterTrustBundle+: { signerName: signerName } }, + }, + '#configMap':: d.obj(help='"configMap information about the configMap data to project"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI information about the downwardAPI data to project"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of DownwardAPIVolume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value\\nbetween 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"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 '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help='"Items is a list of DownwardAPIVolume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of DownwardAPIVolume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#secret':: d.obj(help='"secret information about the secret data to project"'), + secret: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secret+: { name: name } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + }, + '#serviceAccountToken':: d.obj(help='"serviceAccountToken is information about the serviceAccountToken data to project"'), + serviceAccountToken: { + '#withAudience':: d.fn(help='"audience is the intended audience of the token. A recipient of a token\\nmust identify itself with an identifier specified in the audience of the\\ntoken, and otherwise should reject the token. The audience defaults to the\\nidentifier of the apiserver."', args=[d.arg(name='audience', type=d.T.string)]), + withAudience(audience): { serviceAccountToken+: { audience: audience } }, + '#withExpirationSeconds':: d.fn(help='"expirationSeconds is the requested duration of validity of the service\\naccount token. As the token approaches expiration, the kubelet volume\\nplugin will proactively rotate the service account token. The kubelet will\\nstart trying to rotate the token if the token is older than 80 percent of\\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\\nand must be at least 10 minutes."', args=[d.arg(name='expirationSeconds', type=d.T.integer)]), + withExpirationSeconds(expirationSeconds): { serviceAccountToken+: { expirationSeconds: expirationSeconds } }, + '#withPath':: d.fn(help='"path is the path relative to the mount point of the file to project the\\ntoken into."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { serviceAccountToken+: { path: path } }, + }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode are the mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { projected+: { defaultMode: defaultMode } }, + '#withSources':: d.fn(help='"sources is the list of volume projections"', args=[d.arg(name='sources', type=d.T.array)]), + withSources(sources): { projected+: { sources: if std.isArray(v=sources) then sources else [sources] } }, + '#withSourcesMixin':: d.fn(help='"sources is the list of volume projections"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sources', type=d.T.array)]), + withSourcesMixin(sources): { projected+: { sources+: if std.isArray(v=sources) then sources else [sources] } }, + }, + '#quobyte':: d.obj(help="\"quobyte represents a Quobyte mount on the host that shares a pod's lifetime\""), + quobyte: { + '#withGroup':: d.fn(help='"group to map volume access to\\nDefault is no group"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { quobyte+: { group: group } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Quobyte volume to be mounted with read-only permissions.\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { quobyte+: { readOnly: readOnly } }, + '#withRegistry':: d.fn(help='"registry represents a single or multiple Quobyte Registry services\\nspecified as a string as host:port pair (multiple entries are separated with commas)\\nwhich acts as the central registry for volumes"', args=[d.arg(name='registry', type=d.T.string)]), + withRegistry(registry): { quobyte+: { registry: registry } }, + '#withTenant':: d.fn(help='"tenant owning the given Quobyte volume in the Backend\\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin"', args=[d.arg(name='tenant', type=d.T.string)]), + withTenant(tenant): { quobyte+: { tenant: tenant } }, + '#withUser':: d.fn(help='"user to map volume access to\\nDefaults to serivceaccount user"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { quobyte+: { user: user } }, + '#withVolume':: d.fn(help='"volume is a string that references an already created Quobyte volume by name."', args=[d.arg(name='volume', type=d.T.string)]), + withVolume(volume): { quobyte+: { volume: volume } }, + }, + '#rbd':: d.obj(help="\"rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md\""), + rbd: { + '#secretRef':: d.obj(help='"secretRef is name of the authentication secret for RBDUser. If provided\\noverrides keyring.\\nDefault is nil.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { rbd+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { rbd+: { fsType: fsType } }, + '#withImage':: d.fn(help='"image is the rados image name.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { rbd+: { image: image } }, + '#withKeyring':: d.fn(help='"keyring is the path to key ring for RBDUser.\\nDefault is /etc/ceph/keyring.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='keyring', type=d.T.string)]), + withKeyring(keyring): { rbd+: { keyring: keyring } }, + '#withMonitors':: d.fn(help='"monitors is a collection of Ceph monitors.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { rbd+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is a collection of Ceph monitors.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { rbd+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPool':: d.fn(help='"pool is the rados pool name.\\nDefault is rbd.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='pool', type=d.T.string)]), + withPool(pool): { rbd+: { pool: pool } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { rbd+: { readOnly: readOnly } }, + '#withUser':: d.fn(help='"user is the rados user name.\\nDefault is admin.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { rbd+: { user: user } }, + }, + '#scaleIO':: d.obj(help='"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."'), + scaleIO: { + '#secretRef':: d.obj(help='"secretRef references to the secret for ScaleIO user and other\\nsensitive information. If this is not provided, Login operation will fail."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { scaleIO+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\".\\nDefault is \\"xfs\\"."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { scaleIO+: { fsType: fsType } }, + '#withGateway':: d.fn(help='"gateway is the host address of the ScaleIO API Gateway."', args=[d.arg(name='gateway', type=d.T.string)]), + withGateway(gateway): { scaleIO+: { gateway: gateway } }, + '#withProtectionDomain':: d.fn(help='"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage."', args=[d.arg(name='protectionDomain', type=d.T.string)]), + withProtectionDomain(protectionDomain): { scaleIO+: { protectionDomain: protectionDomain } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { scaleIO+: { readOnly: readOnly } }, + '#withSslEnabled':: d.fn(help='"sslEnabled Flag enable/disable SSL communication with Gateway, default false"', args=[d.arg(name='sslEnabled', type=d.T.boolean)]), + withSslEnabled(sslEnabled): { scaleIO+: { sslEnabled: sslEnabled } }, + '#withStorageMode':: d.fn(help='"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\\nDefault is ThinProvisioned."', args=[d.arg(name='storageMode', type=d.T.string)]), + withStorageMode(storageMode): { scaleIO+: { storageMode: storageMode } }, + '#withStoragePool':: d.fn(help='"storagePool is the ScaleIO Storage Pool associated with the protection domain."', args=[d.arg(name='storagePool', type=d.T.string)]), + withStoragePool(storagePool): { scaleIO+: { storagePool: storagePool } }, + '#withSystem':: d.fn(help='"system is the name of the storage system as configured in ScaleIO."', args=[d.arg(name='system', type=d.T.string)]), + withSystem(system): { scaleIO+: { system: system } }, + '#withVolumeName':: d.fn(help='"volumeName is the name of a volume already created in the ScaleIO system\\nthat is associated with this volume source."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { scaleIO+: { volumeName: volumeName } }, + }, + '#secret':: d.obj(help='"secret represents a secret that should populate this volume.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret"'), + secret: { + '#items':: d.obj(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is Optional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values\\nfor mode bits. Defaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { secret+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + '#withSecretName':: d.fn(help="\"secretName is the name of the secret in the pod's namespace to use.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\"", args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { secret+: { secretName: secretName } }, + }, + '#storageos':: d.obj(help='"storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."'), + storageos: { + '#secretRef':: d.obj(help='"secretRef specifies the secret to use for obtaining the StorageOS API\\ncredentials. If not specified, default values will be attempted."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storageos+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { storageos+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { storageos+: { readOnly: readOnly } }, + '#withVolumeName':: d.fn(help='"volumeName is the human-readable name of the StorageOS volume. Volume\\nnames are only unique within a namespace."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { storageos+: { volumeName: volumeName } }, + '#withVolumeNamespace':: d.fn(help="\"volumeNamespace specifies the scope of the volume within StorageOS. If no\\nnamespace is specified then the Pod's namespace will be used. This allows the\\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\\nSet VolumeName to any name to override the default behaviour.\\nSet to \\\"default\\\" if you are not using namespaces within StorageOS.\\nNamespaces that do not pre-exist within StorageOS will be created.\"", args=[d.arg(name='volumeNamespace', type=d.T.string)]), + withVolumeNamespace(volumeNamespace): { storageos+: { volumeNamespace: volumeNamespace } }, + }, + '#vsphereVolume':: d.obj(help='"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"'), + vsphereVolume: { + '#withFsType':: d.fn(help='"fsType is filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { vsphereVolume+: { fsType: fsType } }, + '#withStoragePolicyID':: d.fn(help='"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."', args=[d.arg(name='storagePolicyID', type=d.T.string)]), + withStoragePolicyID(storagePolicyID): { vsphereVolume+: { storagePolicyID: storagePolicyID } }, + '#withStoragePolicyName':: d.fn(help='"storagePolicyName is the storage Policy Based Management (SPBM) profile name."', args=[d.arg(name='storagePolicyName', type=d.T.string)]), + withStoragePolicyName(storagePolicyName): { vsphereVolume+: { storagePolicyName: storagePolicyName } }, + '#withVolumePath':: d.fn(help='"volumePath is the path that identifies vSphere volume vmdk"', args=[d.arg(name='volumePath', type=d.T.string)]), + withVolumePath(volumePath): { vsphereVolume+: { volumePath: volumePath } }, + }, + '#withName':: d.fn(help='"name of the volume.\\nMust be a DNS_LABEL and unique within the pod.\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#web':: d.obj(help='"Defines the configuration of the ThanosRuler web server."'), + web: { + '#httpConfig':: d.obj(help='"Defines HTTP parameters for web server."'), + httpConfig: { + '#headers':: d.obj(help='"List of headers that can be added to HTTP responses."'), + headers: { + '#withContentSecurityPolicy':: d.fn(help='"Set the Content-Security-Policy header to HTTP responses.\\nUnset if blank."', args=[d.arg(name='contentSecurityPolicy', type=d.T.string)]), + withContentSecurityPolicy(contentSecurityPolicy): { spec+: { web+: { httpConfig+: { headers+: { contentSecurityPolicy: contentSecurityPolicy } } } } }, + '#withStrictTransportSecurity':: d.fn(help='"Set the Strict-Transport-Security header to HTTP responses.\\nUnset if blank.\\nPlease make sure that you use this with care as this header might force\\nbrowsers to load Prometheus and the other applications hosted on the same\\ndomain and subdomains over HTTPS.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security"', args=[d.arg(name='strictTransportSecurity', type=d.T.string)]), + withStrictTransportSecurity(strictTransportSecurity): { spec+: { web+: { httpConfig+: { headers+: { strictTransportSecurity: strictTransportSecurity } } } } }, + '#withXContentTypeOptions':: d.fn(help='"Set the X-Content-Type-Options header to HTTP responses.\\nUnset if blank. Accepted value is nosniff.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options"', args=[d.arg(name='xContentTypeOptions', type=d.T.string)]), + withXContentTypeOptions(xContentTypeOptions): { spec+: { web+: { httpConfig+: { headers+: { xContentTypeOptions: xContentTypeOptions } } } } }, + '#withXFrameOptions':: d.fn(help='"Set the X-Frame-Options header to HTTP responses.\\nUnset if blank. Accepted values are deny and sameorigin.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options"', args=[d.arg(name='xFrameOptions', type=d.T.string)]), + withXFrameOptions(xFrameOptions): { spec+: { web+: { httpConfig+: { headers+: { xFrameOptions: xFrameOptions } } } } }, + '#withXXSSProtection':: d.fn(help='"Set the X-XSS-Protection header to all responses.\\nUnset if blank.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection"', args=[d.arg(name='xXSSProtection', type=d.T.string)]), + withXXSSProtection(xXSSProtection): { spec+: { web+: { httpConfig+: { headers+: { xXSSProtection: xXSSProtection } } } } }, + }, + '#withHttp2':: d.fn(help='"Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\\nWhenever the value of the field changes, a rolling update will be triggered."', args=[d.arg(name='http2', type=d.T.boolean)]), + withHttp2(http2): { spec+: { web+: { httpConfig+: { http2: http2 } } } }, + }, + '#tlsConfig':: d.obj(help='"Defines the TLS parameters for HTTPS."'), + tlsConfig: { + '#cert':: d.obj(help='"Contains the TLS certificate for the server."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#client_ca':: d.obj(help='"Contains the CA certificate for client certificate authentication to the server."'), + client_ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the TLS key for the server."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withCipherSuites':: d.fn(help='"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\\nGo default cipher suites are used. Available cipher suites are documented\\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"', args=[d.arg(name='cipherSuites', type=d.T.array)]), + withCipherSuites(cipherSuites): { spec+: { web+: { tlsConfig+: { cipherSuites: if std.isArray(v=cipherSuites) then cipherSuites else [cipherSuites] } } } }, + '#withCipherSuitesMixin':: d.fn(help='"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\\nGo default cipher suites are used. Available cipher suites are documented\\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='cipherSuites', type=d.T.array)]), + withCipherSuitesMixin(cipherSuites): { spec+: { web+: { tlsConfig+: { cipherSuites+: if std.isArray(v=cipherSuites) then cipherSuites else [cipherSuites] } } } }, + '#withClientAuthType':: d.fn(help='"Server policy for client authentication. Maps to ClientAuth Policies.\\nFor more detail on clientAuth options:\\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType"', args=[d.arg(name='clientAuthType', type=d.T.string)]), + withClientAuthType(clientAuthType): { spec+: { web+: { tlsConfig+: { clientAuthType: clientAuthType } } } }, + '#withCurvePreferences':: d.fn(help='"Elliptic curves that will be used in an ECDHE handshake, in preference\\norder. Available curves are documented in the go documentation:\\nhttps://golang.org/pkg/crypto/tls/#CurveID"', args=[d.arg(name='curvePreferences', type=d.T.array)]), + withCurvePreferences(curvePreferences): { spec+: { web+: { tlsConfig+: { curvePreferences: if std.isArray(v=curvePreferences) then curvePreferences else [curvePreferences] } } } }, + '#withCurvePreferencesMixin':: d.fn(help='"Elliptic curves that will be used in an ECDHE handshake, in preference\\norder. Available curves are documented in the go documentation:\\nhttps://golang.org/pkg/crypto/tls/#CurveID"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='curvePreferences', type=d.T.array)]), + withCurvePreferencesMixin(curvePreferences): { spec+: { web+: { tlsConfig+: { curvePreferences+: if std.isArray(v=curvePreferences) then curvePreferences else [curvePreferences] } } } }, + '#withMaxVersion':: d.fn(help='"Maximum TLS version that is acceptable. Defaults to TLS13."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { web+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum TLS version that is acceptable. Defaults to TLS12."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { web+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withPreferServerCipherSuites':: d.fn(help="\"Controls whether the server selects the\\nclient's most preferred cipher suite, or the server's most preferred\\ncipher suite. If true then the server's preference, as expressed in\\nthe order of elements in cipherSuites, is used.\"", args=[d.arg(name='preferServerCipherSuites', type=d.T.boolean)]), + withPreferServerCipherSuites(preferServerCipherSuites): { spec+: { web+: { tlsConfig+: { preferServerCipherSuites: preferServerCipherSuites } } } }, + }, + }, + '#withAdditionalArgs':: d.fn(help='"AdditionalArgs allows setting additional arguments for the ThanosRuler container.\\nIt is intended for e.g. activating hidden flags which are not supported by\\nthe dedicated configuration options yet. The arguments are passed as-is to the\\nThanosRuler container which may cause issues if they are invalid or not supported\\nby the given ThanosRuler version.\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument the reconciliation will\\nfail and an error will be logged."', args=[d.arg(name='additionalArgs', type=d.T.array)]), + withAdditionalArgs(additionalArgs): { spec+: { additionalArgs: if std.isArray(v=additionalArgs) then additionalArgs else [additionalArgs] } }, + '#withAdditionalArgsMixin':: d.fn(help='"AdditionalArgs allows setting additional arguments for the ThanosRuler container.\\nIt is intended for e.g. activating hidden flags which are not supported by\\nthe dedicated configuration options yet. The arguments are passed as-is to the\\nThanosRuler container which may cause issues if they are invalid or not supported\\nby the given ThanosRuler version.\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument the reconciliation will\\nfail and an error will be logged."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='additionalArgs', type=d.T.array)]), + withAdditionalArgsMixin(additionalArgs): { spec+: { additionalArgs+: if std.isArray(v=additionalArgs) then additionalArgs else [additionalArgs] } }, + '#withAlertDropLabels':: d.fn(help='"AlertDropLabels configure the label names which should be dropped in ThanosRuler alerts.\\nThe replica label `thanos_ruler_replica` will always be dropped in alerts."', args=[d.arg(name='alertDropLabels', type=d.T.array)]), + withAlertDropLabels(alertDropLabels): { spec+: { alertDropLabels: if std.isArray(v=alertDropLabels) then alertDropLabels else [alertDropLabels] } }, + '#withAlertDropLabelsMixin':: d.fn(help='"AlertDropLabels configure the label names which should be dropped in ThanosRuler alerts.\\nThe replica label `thanos_ruler_replica` will always be dropped in alerts."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='alertDropLabels', type=d.T.array)]), + withAlertDropLabelsMixin(alertDropLabels): { spec+: { alertDropLabels+: if std.isArray(v=alertDropLabels) then alertDropLabels else [alertDropLabels] } }, + '#withAlertQueryUrl':: d.fn(help="\"The external Query URL the Thanos Ruler will set in the 'Source' field\\nof all alerts.\\nMaps to the '--alert.query-url' CLI arg.\"", args=[d.arg(name='alertQueryUrl', type=d.T.string)]), + withAlertQueryUrl(alertQueryUrl): { spec+: { alertQueryUrl: alertQueryUrl } }, + '#withAlertRelabelConfigFile':: d.fn(help='"AlertRelabelConfigFile specifies the path of the alert relabeling configuration file.\\nWhen used alongside with AlertRelabelConfigs, alertRelabelConfigFile takes precedence."', args=[d.arg(name='alertRelabelConfigFile', type=d.T.string)]), + withAlertRelabelConfigFile(alertRelabelConfigFile): { spec+: { alertRelabelConfigFile: alertRelabelConfigFile } }, + '#withAlertmanagersUrl':: d.fn(help='"Define URLs to send alerts to Alertmanager. For Thanos v0.10.0 and higher,\\nAlertManagersConfig should be used instead. Note: this field will be ignored\\nif AlertManagersConfig is specified.\\nMaps to the `alertmanagers.url` arg."', args=[d.arg(name='alertmanagersUrl', type=d.T.array)]), + withAlertmanagersUrl(alertmanagersUrl): { spec+: { alertmanagersUrl: if std.isArray(v=alertmanagersUrl) then alertmanagersUrl else [alertmanagersUrl] } }, + '#withAlertmanagersUrlMixin':: d.fn(help='"Define URLs to send alerts to Alertmanager. For Thanos v0.10.0 and higher,\\nAlertManagersConfig should be used instead. Note: this field will be ignored\\nif AlertManagersConfig is specified.\\nMaps to the `alertmanagers.url` arg."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='alertmanagersUrl', type=d.T.array)]), + withAlertmanagersUrlMixin(alertmanagersUrl): { spec+: { alertmanagersUrl+: if std.isArray(v=alertmanagersUrl) then alertmanagersUrl else [alertmanagersUrl] } }, + '#withContainers':: d.fn(help='"Containers allows injecting additional containers or modifying operator generated\\ncontainers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or\\nto change the behavior of an operator generated container. Containers described here modify\\nan operator generated container if they share the same name and modifications are done via a\\nstrategic merge patch. The current container names are: `thanos-ruler` and `config-reloader`.\\nOverriding containers is entirely outside the scope of what the maintainers will support and by doing\\nso, you accept that this behaviour may break at any time without notice."', args=[d.arg(name='containers', type=d.T.array)]), + withContainers(containers): { spec+: { containers: if std.isArray(v=containers) then containers else [containers] } }, + '#withContainersMixin':: d.fn(help='"Containers allows injecting additional containers or modifying operator generated\\ncontainers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or\\nto change the behavior of an operator generated container. Containers described here modify\\nan operator generated container if they share the same name and modifications are done via a\\nstrategic merge patch. The current container names are: `thanos-ruler` and `config-reloader`.\\nOverriding containers is entirely outside the scope of what the maintainers will support and by doing\\nso, you accept that this behaviour may break at any time without notice."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='containers', type=d.T.array)]), + withContainersMixin(containers): { spec+: { containers+: if std.isArray(v=containers) then containers else [containers] } }, + '#withEnforcedNamespaceLabel':: d.fn(help='"EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert\\nand metric that is user created. The label value will always be the namespace of the object that is\\nbeing created."', args=[d.arg(name='enforcedNamespaceLabel', type=d.T.string)]), + withEnforcedNamespaceLabel(enforcedNamespaceLabel): { spec+: { enforcedNamespaceLabel: enforcedNamespaceLabel } }, + '#withEvaluationInterval':: d.fn(help='"Interval between consecutive evaluations."', args=[d.arg(name='evaluationInterval', type=d.T.string)]), + withEvaluationInterval(evaluationInterval): { spec+: { evaluationInterval: evaluationInterval } }, + '#withExcludedFromEnforcement':: d.fn(help='"List of references to PrometheusRule objects\\nto be excluded from enforcing a namespace label of origin.\\nApplies only if enforcedNamespaceLabel set to true."', args=[d.arg(name='excludedFromEnforcement', type=d.T.array)]), + withExcludedFromEnforcement(excludedFromEnforcement): { spec+: { excludedFromEnforcement: if std.isArray(v=excludedFromEnforcement) then excludedFromEnforcement else [excludedFromEnforcement] } }, + '#withExcludedFromEnforcementMixin':: d.fn(help='"List of references to PrometheusRule objects\\nto be excluded from enforcing a namespace label of origin.\\nApplies only if enforcedNamespaceLabel set to true."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='excludedFromEnforcement', type=d.T.array)]), + withExcludedFromEnforcementMixin(excludedFromEnforcement): { spec+: { excludedFromEnforcement+: if std.isArray(v=excludedFromEnforcement) then excludedFromEnforcement else [excludedFromEnforcement] } }, + '#withExternalPrefix':: d.fn(help='"The external URL the Thanos Ruler instances will be available under. This is\\nnecessary to generate correct URLs. This is necessary if Thanos Ruler is not\\nserved from root of a DNS name."', args=[d.arg(name='externalPrefix', type=d.T.string)]), + withExternalPrefix(externalPrefix): { spec+: { externalPrefix: externalPrefix } }, + '#withHostAliases':: d.fn(help="\"Pods' hostAliases configuration\"", args=[d.arg(name='hostAliases', type=d.T.array)]), + withHostAliases(hostAliases): { spec+: { hostAliases: if std.isArray(v=hostAliases) then hostAliases else [hostAliases] } }, + '#withHostAliasesMixin':: d.fn(help="\"Pods' hostAliases configuration\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='hostAliases', type=d.T.array)]), + withHostAliasesMixin(hostAliases): { spec+: { hostAliases+: if std.isArray(v=hostAliases) then hostAliases else [hostAliases] } }, + '#withImage':: d.fn(help='"Thanos container image URL."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { spec+: { image: image } }, + '#withImagePullPolicy':: d.fn(help="\"Image pull policy for the 'thanos', 'init-config-reloader' and 'config-reloader' containers.\\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.\"", args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { spec+: { imagePullPolicy: imagePullPolicy } }, + '#withImagePullSecrets':: d.fn(help='"An optional list of references to secrets in the same namespace\\nto use for pulling thanos images from registries\\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"', args=[d.arg(name='imagePullSecrets', type=d.T.array)]), + withImagePullSecrets(imagePullSecrets): { spec+: { imagePullSecrets: if std.isArray(v=imagePullSecrets) then imagePullSecrets else [imagePullSecrets] } }, + '#withImagePullSecretsMixin':: d.fn(help='"An optional list of references to secrets in the same namespace\\nto use for pulling thanos images from registries\\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='imagePullSecrets', type=d.T.array)]), + withImagePullSecretsMixin(imagePullSecrets): { spec+: { imagePullSecrets+: if std.isArray(v=imagePullSecrets) then imagePullSecrets else [imagePullSecrets] } }, + '#withInitContainers':: d.fn(help='"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\\nfetch secrets for injection into the ThanosRuler configuration from external sources. Any\\nerrors during the execution of an initContainer will lead to a restart of the Pod.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\\nof what the maintainers will support and by doing so, you accept that this behaviour may break\\nat any time without notice."', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainers(initContainers): { spec+: { initContainers: if std.isArray(v=initContainers) then initContainers else [initContainers] } }, + '#withInitContainersMixin':: d.fn(help='"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\\nfetch secrets for injection into the ThanosRuler configuration from external sources. Any\\nerrors during the execution of an initContainer will lead to a restart of the Pod.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\\nof what the maintainers will support and by doing so, you accept that this behaviour may break\\nat any time without notice."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainersMixin(initContainers): { spec+: { initContainers+: if std.isArray(v=initContainers) then initContainers else [initContainers] } }, + '#withLabels':: d.fn(help="\"Labels configure the external label pairs to ThanosRuler. A default replica label\\n`thanos_ruler_replica` will be always added as a label with the value of the pod's name and it will be dropped in the alerts.\"", args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help="\"Labels configure the external label pairs to ThanosRuler. A default replica label\\n`thanos_ruler_replica` will be always added as a label with the value of the pod's name and it will be dropped in the alerts.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { labels+: labels } }, + '#withListenLocal':: d.fn(help='"ListenLocal makes the Thanos ruler listen on loopback, so that it\\ndoes not bind against the Pod IP."', args=[d.arg(name='listenLocal', type=d.T.boolean)]), + withListenLocal(listenLocal): { spec+: { listenLocal: listenLocal } }, + '#withLogFormat':: d.fn(help='"Log format for ThanosRuler to be configured with."', args=[d.arg(name='logFormat', type=d.T.string)]), + withLogFormat(logFormat): { spec+: { logFormat: logFormat } }, + '#withLogLevel':: d.fn(help='"Log level for ThanosRuler to be configured with."', args=[d.arg(name='logLevel', type=d.T.string)]), + withLogLevel(logLevel): { spec+: { logLevel: logLevel } }, + '#withMinReadySeconds':: d.fn(help='"Minimum number of seconds for which a newly created pod should be ready\\nwithout any of its container crashing for it to be considered available.\\nDefaults to 0 (pod will be considered available as soon as it is ready)\\nThis is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate."', args=[d.arg(name='minReadySeconds', type=d.T.integer)]), + withMinReadySeconds(minReadySeconds): { spec+: { minReadySeconds: minReadySeconds } }, + '#withNodeSelector':: d.fn(help='"Define which Nodes the Pods are scheduled on."', args=[d.arg(name='nodeSelector', type=d.T.object)]), + withNodeSelector(nodeSelector): { spec+: { nodeSelector: nodeSelector } }, + '#withNodeSelectorMixin':: d.fn(help='"Define which Nodes the Pods are scheduled on."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeSelector', type=d.T.object)]), + withNodeSelectorMixin(nodeSelector): { spec+: { nodeSelector+: nodeSelector } }, + '#withObjectStorageConfigFile':: d.fn(help='"ObjectStorageConfigFile specifies the path of the object storage configuration file.\\nWhen used alongside with ObjectStorageConfig, ObjectStorageConfigFile takes precedence."', args=[d.arg(name='objectStorageConfigFile', type=d.T.string)]), + withObjectStorageConfigFile(objectStorageConfigFile): { spec+: { objectStorageConfigFile: objectStorageConfigFile } }, + '#withPaused':: d.fn(help='"When a ThanosRuler deployment is paused, no actions except for deletion\\nwill be performed on the underlying objects."', args=[d.arg(name='paused', type=d.T.boolean)]), + withPaused(paused): { spec+: { paused: paused } }, + '#withPortName':: d.fn(help='"Port name used for the pods and governing service.\\nDefaults to `web`."', args=[d.arg(name='portName', type=d.T.string)]), + withPortName(portName): { spec+: { portName: portName } }, + '#withPriorityClassName':: d.fn(help='"Priority class assigned to the Pods"', args=[d.arg(name='priorityClassName', type=d.T.string)]), + withPriorityClassName(priorityClassName): { spec+: { priorityClassName: priorityClassName } }, + '#withPrometheusRulesExcludedFromEnforce':: d.fn(help='"PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing\\nof adding namespace labels. Works only if enforcedNamespaceLabel set to true.\\nMake sure both ruleNamespace and ruleName are set for each pair\\nDeprecated: use excludedFromEnforcement instead."', args=[d.arg(name='prometheusRulesExcludedFromEnforce', type=d.T.array)]), + withPrometheusRulesExcludedFromEnforce(prometheusRulesExcludedFromEnforce): { spec+: { prometheusRulesExcludedFromEnforce: if std.isArray(v=prometheusRulesExcludedFromEnforce) then prometheusRulesExcludedFromEnforce else [prometheusRulesExcludedFromEnforce] } }, + '#withPrometheusRulesExcludedFromEnforceMixin':: d.fn(help='"PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing\\nof adding namespace labels. Works only if enforcedNamespaceLabel set to true.\\nMake sure both ruleNamespace and ruleName are set for each pair\\nDeprecated: use excludedFromEnforcement instead."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='prometheusRulesExcludedFromEnforce', type=d.T.array)]), + withPrometheusRulesExcludedFromEnforceMixin(prometheusRulesExcludedFromEnforce): { spec+: { prometheusRulesExcludedFromEnforce+: if std.isArray(v=prometheusRulesExcludedFromEnforce) then prometheusRulesExcludedFromEnforce else [prometheusRulesExcludedFromEnforce] } }, + '#withQueryEndpoints':: d.fn(help='"QueryEndpoints defines Thanos querier endpoints from which to query metrics.\\nMaps to the --query flag of thanos ruler."', args=[d.arg(name='queryEndpoints', type=d.T.array)]), + withQueryEndpoints(queryEndpoints): { spec+: { queryEndpoints: if std.isArray(v=queryEndpoints) then queryEndpoints else [queryEndpoints] } }, + '#withQueryEndpointsMixin':: d.fn(help='"QueryEndpoints defines Thanos querier endpoints from which to query metrics.\\nMaps to the --query flag of thanos ruler."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='queryEndpoints', type=d.T.array)]), + withQueryEndpointsMixin(queryEndpoints): { spec+: { queryEndpoints+: if std.isArray(v=queryEndpoints) then queryEndpoints else [queryEndpoints] } }, + '#withReplicas':: d.fn(help='"Number of thanos ruler instances to deploy."', args=[d.arg(name='replicas', type=d.T.integer)]), + withReplicas(replicas): { spec+: { replicas: replicas } }, + '#withRetention':: d.fn(help="\"Time duration ThanosRuler shall retain data for. Default is '24h',\\nand must match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds seconds minutes hours days weeks years).\"", args=[d.arg(name='retention', type=d.T.string)]), + withRetention(retention): { spec+: { retention: retention } }, + '#withRoutePrefix':: d.fn(help='"The route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path."', args=[d.arg(name='routePrefix', type=d.T.string)]), + withRoutePrefix(routePrefix): { spec+: { routePrefix: routePrefix } }, + '#withServiceAccountName':: d.fn(help='"ServiceAccountName is the name of the ServiceAccount to use to run the\\nThanos Ruler Pods."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withTolerations':: d.fn(help="\"If specified, the pod's tolerations.\"", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerations(tolerations): { spec+: { tolerations: if std.isArray(v=tolerations) then tolerations else [tolerations] } }, + '#withTolerationsMixin':: d.fn(help="\"If specified, the pod's tolerations.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerationsMixin(tolerations): { spec+: { tolerations+: if std.isArray(v=tolerations) then tolerations else [tolerations] } }, + '#withTopologySpreadConstraints':: d.fn(help="\"If specified, the pod's topology spread constraints.\"", args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), + withTopologySpreadConstraints(topologySpreadConstraints): { spec+: { topologySpreadConstraints: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, + '#withTopologySpreadConstraintsMixin':: d.fn(help="\"If specified, the pod's topology spread constraints.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), + withTopologySpreadConstraintsMixin(topologySpreadConstraints): { spec+: { topologySpreadConstraints+: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, + '#withTracingConfigFile':: d.fn(help='"TracingConfig specifies the path of the tracing configuration file.\\n\\n\\nThis field takes precedence over `tracingConfig`.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."', args=[d.arg(name='tracingConfigFile', type=d.T.string)]), + withTracingConfigFile(tracingConfigFile): { spec+: { tracingConfigFile: tracingConfigFile } }, + '#withVersion':: d.fn(help='"Version of Thanos to be deployed."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { version: version } }, + '#withVolumeMounts':: d.fn(help='"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\\nVolumeMounts specified will be appended to other VolumeMounts in the ruler container,\\nthat are generated as a result of StorageSpec objects."', args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { spec+: { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } }, + '#withVolumeMountsMixin':: d.fn(help='"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\\nVolumeMounts specified will be appended to other VolumeMounts in the ruler container,\\nthat are generated as a result of StorageSpec objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { spec+: { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } }, + '#withVolumes':: d.fn(help='"Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will\\nbe appended to other volumes that are generated as a result of StorageSpec objects."', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumes(volumes): { spec+: { volumes: if std.isArray(v=volumes) then volumes else [volumes] } }, + '#withVolumesMixin':: d.fn(help='"Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will\\nbe appended to other volumes that are generated as a result of StorageSpec objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumesMixin(volumes): { spec+: { volumes+: if std.isArray(v=volumes) then volumes else [volumes] } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/_gen/monitoring/v1alpha1/alertmanagerConfig.libsonnet b/0.14/_gen/monitoring/v1alpha1/alertmanagerConfig.libsonnet new file mode 100644 index 0000000..2bf5434 --- /dev/null +++ b/0.14/_gen/monitoring/v1alpha1/alertmanagerConfig.libsonnet @@ -0,0 +1,3587 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='alertmanagerConfig', url='', help='"AlertmanagerConfig configures the Prometheus Alertmanager,\\nspecifying how alerts should be grouped, inhibited and notified to external systems."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of AlertmanagerConfig', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1alpha1', + kind: 'AlertmanagerConfig', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"AlertmanagerConfigSpec is a specification of the desired behavior of the\\nAlertmanager configuration.\\nBy default, the Alertmanager configuration only applies to alerts for which\\nthe `namespace` label is equal to the namespace of the AlertmanagerConfig\\nresource (see the `.spec.alertmanagerConfigMatcherStrategy` field of the\\nAlertmanager CRD)."'), + spec: { + '#inhibitRules':: d.obj(help="\"List of inhibition rules. The rules will only apply to alerts matching\\nthe resource's namespace.\""), + inhibitRules: { + '#sourceMatch':: d.obj(help="\"Matchers for which one or more alerts have to exist for the inhibition\\nto take effect. The operator enforces that the alert matches the\\nresource's namespace.\""), + sourceMatch: { + '#withMatchType':: d.fn(help='"Match operation available with AlertManager >= v0.22.0 and\\ntakes precedence over Regex (deprecated) if non-empty."', args=[d.arg(name='matchType', type=d.T.string)]), + withMatchType(matchType): { matchType: matchType }, + '#withName':: d.fn(help='"Label to match."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withRegex':: d.fn(help='"Whether to match on equality (false) or regular-expression (true).\\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead."', args=[d.arg(name='regex', type=d.T.boolean)]), + withRegex(regex): { regex: regex }, + '#withValue':: d.fn(help='"Label value to match."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#targetMatch':: d.obj(help="\"Matchers that have to be fulfilled in the alerts to be muted. The\\noperator enforces that the alert matches the resource's namespace.\""), + targetMatch: { + '#withMatchType':: d.fn(help='"Match operation available with AlertManager >= v0.22.0 and\\ntakes precedence over Regex (deprecated) if non-empty."', args=[d.arg(name='matchType', type=d.T.string)]), + withMatchType(matchType): { matchType: matchType }, + '#withName':: d.fn(help='"Label to match."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withRegex':: d.fn(help='"Whether to match on equality (false) or regular-expression (true).\\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead."', args=[d.arg(name='regex', type=d.T.boolean)]), + withRegex(regex): { regex: regex }, + '#withValue':: d.fn(help='"Label value to match."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withEqual':: d.fn(help='"Labels that must have an equal value in the source and target alert for\\nthe inhibition to take effect."', args=[d.arg(name='equal', type=d.T.array)]), + withEqual(equal): { equal: if std.isArray(v=equal) then equal else [equal] }, + '#withEqualMixin':: d.fn(help='"Labels that must have an equal value in the source and target alert for\\nthe inhibition to take effect."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='equal', type=d.T.array)]), + withEqualMixin(equal): { equal+: if std.isArray(v=equal) then equal else [equal] }, + '#withSourceMatch':: d.fn(help="\"Matchers for which one or more alerts have to exist for the inhibition\\nto take effect. The operator enforces that the alert matches the\\nresource's namespace.\"", args=[d.arg(name='sourceMatch', type=d.T.array)]), + withSourceMatch(sourceMatch): { sourceMatch: if std.isArray(v=sourceMatch) then sourceMatch else [sourceMatch] }, + '#withSourceMatchMixin':: d.fn(help="\"Matchers for which one or more alerts have to exist for the inhibition\\nto take effect. The operator enforces that the alert matches the\\nresource's namespace.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='sourceMatch', type=d.T.array)]), + withSourceMatchMixin(sourceMatch): { sourceMatch+: if std.isArray(v=sourceMatch) then sourceMatch else [sourceMatch] }, + '#withTargetMatch':: d.fn(help="\"Matchers that have to be fulfilled in the alerts to be muted. The\\noperator enforces that the alert matches the resource's namespace.\"", args=[d.arg(name='targetMatch', type=d.T.array)]), + withTargetMatch(targetMatch): { targetMatch: if std.isArray(v=targetMatch) then targetMatch else [targetMatch] }, + '#withTargetMatchMixin':: d.fn(help="\"Matchers that have to be fulfilled in the alerts to be muted. The\\noperator enforces that the alert matches the resource's namespace.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='targetMatch', type=d.T.array)]), + withTargetMatchMixin(targetMatch): { targetMatch+: if std.isArray(v=targetMatch) then targetMatch else [targetMatch] }, + }, + '#muteTimeIntervals':: d.obj(help='"List of MuteTimeInterval specifying when the routes should be muted."'), + muteTimeIntervals: { + '#timeIntervals':: d.obj(help='"TimeIntervals is a list of TimeInterval"'), + timeIntervals: { + '#daysOfMonth':: d.obj(help='"DaysOfMonth is a list of DayOfMonthRange"'), + daysOfMonth: { + '#withEnd':: d.fn(help='"End of the inclusive range"', args=[d.arg(name='end', type=d.T.integer)]), + withEnd(end): { end: end }, + '#withStart':: d.fn(help='"Start of the inclusive range"', args=[d.arg(name='start', type=d.T.integer)]), + withStart(start): { start: start }, + }, + '#times':: d.obj(help='"Times is a list of TimeRange"'), + times: { + '#withEndTime':: d.fn(help='"EndTime is the end time in 24hr format."', args=[d.arg(name='endTime', type=d.T.string)]), + withEndTime(endTime): { endTime: endTime }, + '#withStartTime':: d.fn(help='"StartTime is the start time in 24hr format."', args=[d.arg(name='startTime', type=d.T.string)]), + withStartTime(startTime): { startTime: startTime }, + }, + '#withDaysOfMonth':: d.fn(help='"DaysOfMonth is a list of DayOfMonthRange"', args=[d.arg(name='daysOfMonth', type=d.T.array)]), + withDaysOfMonth(daysOfMonth): { daysOfMonth: if std.isArray(v=daysOfMonth) then daysOfMonth else [daysOfMonth] }, + '#withDaysOfMonthMixin':: d.fn(help='"DaysOfMonth is a list of DayOfMonthRange"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='daysOfMonth', type=d.T.array)]), + withDaysOfMonthMixin(daysOfMonth): { daysOfMonth+: if std.isArray(v=daysOfMonth) then daysOfMonth else [daysOfMonth] }, + '#withMonths':: d.fn(help='"Months is a list of MonthRange"', args=[d.arg(name='months', type=d.T.array)]), + withMonths(months): { months: if std.isArray(v=months) then months else [months] }, + '#withMonthsMixin':: d.fn(help='"Months is a list of MonthRange"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='months', type=d.T.array)]), + withMonthsMixin(months): { months+: if std.isArray(v=months) then months else [months] }, + '#withTimes':: d.fn(help='"Times is a list of TimeRange"', args=[d.arg(name='times', type=d.T.array)]), + withTimes(times): { times: if std.isArray(v=times) then times else [times] }, + '#withTimesMixin':: d.fn(help='"Times is a list of TimeRange"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='times', type=d.T.array)]), + withTimesMixin(times): { times+: if std.isArray(v=times) then times else [times] }, + '#withWeekdays':: d.fn(help='"Weekdays is a list of WeekdayRange"', args=[d.arg(name='weekdays', type=d.T.array)]), + withWeekdays(weekdays): { weekdays: if std.isArray(v=weekdays) then weekdays else [weekdays] }, + '#withWeekdaysMixin':: d.fn(help='"Weekdays is a list of WeekdayRange"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='weekdays', type=d.T.array)]), + withWeekdaysMixin(weekdays): { weekdays+: if std.isArray(v=weekdays) then weekdays else [weekdays] }, + '#withYears':: d.fn(help='"Years is a list of YearRange"', args=[d.arg(name='years', type=d.T.array)]), + withYears(years): { years: if std.isArray(v=years) then years else [years] }, + '#withYearsMixin':: d.fn(help='"Years is a list of YearRange"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='years', type=d.T.array)]), + withYearsMixin(years): { years+: if std.isArray(v=years) then years else [years] }, + }, + '#withName':: d.fn(help='"Name of the time interval"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withTimeIntervals':: d.fn(help='"TimeIntervals is a list of TimeInterval"', args=[d.arg(name='timeIntervals', type=d.T.array)]), + withTimeIntervals(timeIntervals): { timeIntervals: if std.isArray(v=timeIntervals) then timeIntervals else [timeIntervals] }, + '#withTimeIntervalsMixin':: d.fn(help='"TimeIntervals is a list of TimeInterval"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='timeIntervals', type=d.T.array)]), + withTimeIntervalsMixin(timeIntervals): { timeIntervals+: if std.isArray(v=timeIntervals) then timeIntervals else [timeIntervals] }, + }, + '#receivers':: d.obj(help='"List of receivers."'), + receivers: { + '#discordConfigs':: d.obj(help='"List of Discord configurations."'), + discordConfigs: { + '#apiURL':: d.obj(help="\"The secret's key that contains the Discord webhook URL.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + apiURL: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { apiURL+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { apiURL+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { apiURL+: { optional: optional } }, + }, + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#withMessage':: d.fn(help="\"The template of the message's body.\"", args=[d.arg(name='message', type=d.T.string)]), + withMessage(message): { message: message }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withTitle':: d.fn(help="\"The template of the message's title.\"", args=[d.arg(name='title', type=d.T.string)]), + withTitle(title): { title: title }, + }, + '#emailConfigs':: d.obj(help='"List of Email configurations."'), + emailConfigs: { + '#authPassword':: d.obj(help="\"The secret's key that contains the password to use for authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + authPassword: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authPassword+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authPassword+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authPassword+: { optional: optional } }, + }, + '#authSecret':: d.obj(help="\"The secret's key that contains the CRAM-MD5 secret.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + authSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authSecret+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authSecret+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authSecret+: { optional: optional } }, + }, + '#headers':: d.obj(help='"Further headers email header key/value pairs. Overrides any headers\\npreviously set by the notification implementation."'), + headers: { + '#withKey':: d.fn(help='"Key of the tuple."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withValue':: d.fn(help='"Value of the tuple."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration"'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withAuthIdentity':: d.fn(help='"The identity to use for authentication."', args=[d.arg(name='authIdentity', type=d.T.string)]), + withAuthIdentity(authIdentity): { authIdentity: authIdentity }, + '#withAuthUsername':: d.fn(help='"The username to use for authentication."', args=[d.arg(name='authUsername', type=d.T.string)]), + withAuthUsername(authUsername): { authUsername: authUsername }, + '#withFrom':: d.fn(help='"The sender address."', args=[d.arg(name='from', type=d.T.string)]), + withFrom(from): { from: from }, + '#withHeaders':: d.fn(help='"Further headers email header key/value pairs. Overrides any headers\\npreviously set by the notification implementation."', args=[d.arg(name='headers', type=d.T.array)]), + withHeaders(headers): { headers: if std.isArray(v=headers) then headers else [headers] }, + '#withHeadersMixin':: d.fn(help='"Further headers email header key/value pairs. Overrides any headers\\npreviously set by the notification implementation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='headers', type=d.T.array)]), + withHeadersMixin(headers): { headers+: if std.isArray(v=headers) then headers else [headers] }, + '#withHello':: d.fn(help='"The hostname to identify to the SMTP server."', args=[d.arg(name='hello', type=d.T.string)]), + withHello(hello): { hello: hello }, + '#withHtml':: d.fn(help='"The HTML body of the email notification."', args=[d.arg(name='html', type=d.T.string)]), + withHtml(html): { html: html }, + '#withRequireTLS':: d.fn(help='"The SMTP TLS requirement.\\nNote that Go does not support unencrypted connections to remote SMTP endpoints."', args=[d.arg(name='requireTLS', type=d.T.boolean)]), + withRequireTLS(requireTLS): { requireTLS: requireTLS }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withSmarthost':: d.fn(help='"The SMTP host and port through which emails are sent. E.g. example.com:25"', args=[d.arg(name='smarthost', type=d.T.string)]), + withSmarthost(smarthost): { smarthost: smarthost }, + '#withText':: d.fn(help='"The text body of the email notification."', args=[d.arg(name='text', type=d.T.string)]), + withText(text): { text: text }, + '#withTo':: d.fn(help='"The email address to send notifications to."', args=[d.arg(name='to', type=d.T.string)]), + withTo(to): { to: to }, + }, + '#msteamsConfigs':: d.obj(help='"List of MSTeams configurations.\\nIt requires Alertmanager >= 0.26.0."'), + msteamsConfigs: { + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#webhookUrl':: d.obj(help='"MSTeams webhook URL."'), + webhookUrl: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { webhookUrl+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { webhookUrl+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { webhookUrl+: { optional: optional } }, + }, + '#withSendResolved':: d.fn(help='"Whether to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withSummary':: d.fn(help='"Message summary template.\\nIt requires Alertmanager >= 0.27.0."', args=[d.arg(name='summary', type=d.T.string)]), + withSummary(summary): { summary: summary }, + '#withText':: d.fn(help='"Message body template."', args=[d.arg(name='text', type=d.T.string)]), + withText(text): { text: text }, + '#withTitle':: d.fn(help='"Message title template."', args=[d.arg(name='title', type=d.T.string)]), + withTitle(title): { title: title }, + }, + '#opsgenieConfigs':: d.obj(help='"List of OpsGenie configurations."'), + opsgenieConfigs: { + '#apiKey':: d.obj(help="\"The secret's key that contains the OpsGenie API key.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + apiKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { apiKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { apiKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { apiKey+: { optional: optional } }, + }, + '#details':: d.obj(help='"A set of arbitrary key/value pairs that provide further detail about the incident."'), + details: { + '#withKey':: d.fn(help='"Key of the tuple."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withValue':: d.fn(help='"Value of the tuple."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#responders':: d.obj(help='"List of responders responsible for notifications."'), + responders: { + '#withId':: d.fn(help='"ID of the responder."', args=[d.arg(name='id', type=d.T.string)]), + withId(id): { id: id }, + '#withName':: d.fn(help='"Name of the responder."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withType':: d.fn(help='"Type of responder."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { type: type }, + '#withUsername':: d.fn(help='"Username of the responder."', args=[d.arg(name='username', type=d.T.string)]), + withUsername(username): { username: username }, + }, + '#withActions':: d.fn(help='"Comma separated list of actions that will be available for the alert."', args=[d.arg(name='actions', type=d.T.string)]), + withActions(actions): { actions: actions }, + '#withApiURL':: d.fn(help='"The URL to send OpsGenie API requests to."', args=[d.arg(name='apiURL', type=d.T.string)]), + withApiURL(apiURL): { apiURL: apiURL }, + '#withDescription':: d.fn(help='"Description of the incident."', args=[d.arg(name='description', type=d.T.string)]), + withDescription(description): { description: description }, + '#withDetails':: d.fn(help='"A set of arbitrary key/value pairs that provide further detail about the incident."', args=[d.arg(name='details', type=d.T.array)]), + withDetails(details): { details: if std.isArray(v=details) then details else [details] }, + '#withDetailsMixin':: d.fn(help='"A set of arbitrary key/value pairs that provide further detail about the incident."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='details', type=d.T.array)]), + withDetailsMixin(details): { details+: if std.isArray(v=details) then details else [details] }, + '#withEntity':: d.fn(help='"Optional field that can be used to specify which domain alert is related to."', args=[d.arg(name='entity', type=d.T.string)]), + withEntity(entity): { entity: entity }, + '#withMessage':: d.fn(help='"Alert text limited to 130 characters."', args=[d.arg(name='message', type=d.T.string)]), + withMessage(message): { message: message }, + '#withNote':: d.fn(help='"Additional alert note."', args=[d.arg(name='note', type=d.T.string)]), + withNote(note): { note: note }, + '#withPriority':: d.fn(help='"Priority level of alert. Possible values are P1, P2, P3, P4, and P5."', args=[d.arg(name='priority', type=d.T.string)]), + withPriority(priority): { priority: priority }, + '#withResponders':: d.fn(help='"List of responders responsible for notifications."', args=[d.arg(name='responders', type=d.T.array)]), + withResponders(responders): { responders: if std.isArray(v=responders) then responders else [responders] }, + '#withRespondersMixin':: d.fn(help='"List of responders responsible for notifications."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='responders', type=d.T.array)]), + withRespondersMixin(responders): { responders+: if std.isArray(v=responders) then responders else [responders] }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withSource':: d.fn(help='"Backlink to the sender of the notification."', args=[d.arg(name='source', type=d.T.string)]), + withSource(source): { source: source }, + '#withTags':: d.fn(help='"Comma separated list of tags attached to the notifications."', args=[d.arg(name='tags', type=d.T.string)]), + withTags(tags): { tags: tags }, + '#withUpdateAlerts':: d.fn(help='"Whether to update message and description of the alert in OpsGenie if it already exists\\nBy default, the alert is never updated in OpsGenie, the new message only appears in activity log."', args=[d.arg(name='updateAlerts', type=d.T.boolean)]), + withUpdateAlerts(updateAlerts): { updateAlerts: updateAlerts }, + }, + '#pagerdutyConfigs':: d.obj(help='"List of PagerDuty configurations."'), + pagerdutyConfigs: { + '#details':: d.obj(help='"Arbitrary key/value pairs that provide further detail about the incident."'), + details: { + '#withKey':: d.fn(help='"Key of the tuple."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withValue':: d.fn(help='"Value of the tuple."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#pagerDutyImageConfigs':: d.obj(help='"A list of image details to attach that provide further detail about an incident."'), + pagerDutyImageConfigs: { + '#withAlt':: d.fn(help='"Alt is the optional alternative text for the image."', args=[d.arg(name='alt', type=d.T.string)]), + withAlt(alt): { alt: alt }, + '#withHref':: d.fn(help='"Optional URL; makes the image a clickable link."', args=[d.arg(name='href', type=d.T.string)]), + withHref(href): { href: href }, + '#withSrc':: d.fn(help='"Src of the image being attached to the incident"', args=[d.arg(name='src', type=d.T.string)]), + withSrc(src): { src: src }, + }, + '#pagerDutyLinkConfigs':: d.obj(help='"A list of link details to attach that provide further detail about an incident."'), + pagerDutyLinkConfigs: { + '#withAlt':: d.fn(help="\"Text that describes the purpose of the link, and can be used as the link's text.\"", args=[d.arg(name='alt', type=d.T.string)]), + withAlt(alt): { alt: alt }, + '#withHref':: d.fn(help='"Href is the URL of the link to be attached"', args=[d.arg(name='href', type=d.T.string)]), + withHref(href): { href: href }, + }, + '#routingKey':: d.obj(help="\"The secret's key that contains the PagerDuty integration key (when using\\nEvents API v2). Either this field or `serviceKey` needs to be defined.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + routingKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { routingKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { routingKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { routingKey+: { optional: optional } }, + }, + '#serviceKey':: d.obj(help="\"The secret's key that contains the PagerDuty service key (when using\\nintegration type \\\"Prometheus\\\"). Either this field or `routingKey` needs to\\nbe defined.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + serviceKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { serviceKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { serviceKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { serviceKey+: { optional: optional } }, + }, + '#withClass':: d.fn(help='"The class/type of the event."', args=[d.arg(name='class', type=d.T.string)]), + withClass(class): { class: class }, + '#withClient':: d.fn(help='"Client identification."', args=[d.arg(name='client', type=d.T.string)]), + withClient(client): { client: client }, + '#withClientURL':: d.fn(help='"Backlink to the sender of notification."', args=[d.arg(name='clientURL', type=d.T.string)]), + withClientURL(clientURL): { clientURL: clientURL }, + '#withComponent':: d.fn(help='"The part or component of the affected system that is broken."', args=[d.arg(name='component', type=d.T.string)]), + withComponent(component): { component: component }, + '#withDescription':: d.fn(help='"Description of the incident."', args=[d.arg(name='description', type=d.T.string)]), + withDescription(description): { description: description }, + '#withDetails':: d.fn(help='"Arbitrary key/value pairs that provide further detail about the incident."', args=[d.arg(name='details', type=d.T.array)]), + withDetails(details): { details: if std.isArray(v=details) then details else [details] }, + '#withDetailsMixin':: d.fn(help='"Arbitrary key/value pairs that provide further detail about the incident."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='details', type=d.T.array)]), + withDetailsMixin(details): { details+: if std.isArray(v=details) then details else [details] }, + '#withGroup':: d.fn(help='"A cluster or grouping of sources."', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { group: group }, + '#withPagerDutyImageConfigs':: d.fn(help='"A list of image details to attach that provide further detail about an incident."', args=[d.arg(name='pagerDutyImageConfigs', type=d.T.array)]), + withPagerDutyImageConfigs(pagerDutyImageConfigs): { pagerDutyImageConfigs: if std.isArray(v=pagerDutyImageConfigs) then pagerDutyImageConfigs else [pagerDutyImageConfigs] }, + '#withPagerDutyImageConfigsMixin':: d.fn(help='"A list of image details to attach that provide further detail about an incident."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='pagerDutyImageConfigs', type=d.T.array)]), + withPagerDutyImageConfigsMixin(pagerDutyImageConfigs): { pagerDutyImageConfigs+: if std.isArray(v=pagerDutyImageConfigs) then pagerDutyImageConfigs else [pagerDutyImageConfigs] }, + '#withPagerDutyLinkConfigs':: d.fn(help='"A list of link details to attach that provide further detail about an incident."', args=[d.arg(name='pagerDutyLinkConfigs', type=d.T.array)]), + withPagerDutyLinkConfigs(pagerDutyLinkConfigs): { pagerDutyLinkConfigs: if std.isArray(v=pagerDutyLinkConfigs) then pagerDutyLinkConfigs else [pagerDutyLinkConfigs] }, + '#withPagerDutyLinkConfigsMixin':: d.fn(help='"A list of link details to attach that provide further detail about an incident."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='pagerDutyLinkConfigs', type=d.T.array)]), + withPagerDutyLinkConfigsMixin(pagerDutyLinkConfigs): { pagerDutyLinkConfigs+: if std.isArray(v=pagerDutyLinkConfigs) then pagerDutyLinkConfigs else [pagerDutyLinkConfigs] }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withSeverity':: d.fn(help='"Severity of the incident."', args=[d.arg(name='severity', type=d.T.string)]), + withSeverity(severity): { severity: severity }, + '#withSource':: d.fn(help='"Unique location of the affected system."', args=[d.arg(name='source', type=d.T.string)]), + withSource(source): { source: source }, + '#withUrl':: d.fn(help='"The URL to send requests to."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { url: url }, + }, + '#pushoverConfigs':: d.obj(help='"List of Pushover configurations."'), + pushoverConfigs: { + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#token':: d.obj(help="\"The secret's key that contains the registered application's API token, see https://pushover.net/apps.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\\nEither `token` or `tokenFile` is required.\""), + token: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { token+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { token+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { token+: { optional: optional } }, + }, + '#userKey':: d.obj(help="\"The secret's key that contains the recipient user's user key.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\\nEither `userKey` or `userKeyFile` is required.\""), + userKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { userKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { userKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { userKey+: { optional: optional } }, + }, + '#withDevice':: d.fn(help='"The name of a device to send the notification to"', args=[d.arg(name='device', type=d.T.string)]), + withDevice(device): { device: device }, + '#withExpire':: d.fn(help='"How long your notification will continue to be retried for, unless the user\\nacknowledges the notification."', args=[d.arg(name='expire', type=d.T.string)]), + withExpire(expire): { expire: expire }, + '#withHtml':: d.fn(help='"Whether notification message is HTML or plain text."', args=[d.arg(name='html', type=d.T.boolean)]), + withHtml(html): { html: html }, + '#withMessage':: d.fn(help='"Notification message."', args=[d.arg(name='message', type=d.T.string)]), + withMessage(message): { message: message }, + '#withPriority':: d.fn(help='"Priority, see https://pushover.net/api#priority"', args=[d.arg(name='priority', type=d.T.string)]), + withPriority(priority): { priority: priority }, + '#withRetry':: d.fn(help='"How often the Pushover servers will send the same notification to the user.\\nMust be at least 30 seconds."', args=[d.arg(name='retry', type=d.T.string)]), + withRetry(retry): { retry: retry }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withSound':: d.fn(help="\"The name of one of the sounds supported by device clients to override the user's default sound choice\"", args=[d.arg(name='sound', type=d.T.string)]), + withSound(sound): { sound: sound }, + '#withTitle':: d.fn(help='"Notification title."', args=[d.arg(name='title', type=d.T.string)]), + withTitle(title): { title: title }, + '#withTokenFile':: d.fn(help="\"The token file that contains the registered application's API token, see https://pushover.net/apps.\\nEither `token` or `tokenFile` is required.\\nIt requires Alertmanager \u003e= v0.26.0.\"", args=[d.arg(name='tokenFile', type=d.T.string)]), + withTokenFile(tokenFile): { tokenFile: tokenFile }, + '#withTtl':: d.fn(help='"The time to live definition for the alert notification"', args=[d.arg(name='ttl', type=d.T.string)]), + withTtl(ttl): { ttl: ttl }, + '#withUrl':: d.fn(help='"A supplementary URL shown alongside the message."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { url: url }, + '#withUrlTitle':: d.fn(help='"A title for supplementary URL, otherwise just the URL is shown"', args=[d.arg(name='urlTitle', type=d.T.string)]), + withUrlTitle(urlTitle): { urlTitle: urlTitle }, + '#withUserKeyFile':: d.fn(help="\"The user key file that contains the recipient user's user key.\\nEither `userKey` or `userKeyFile` is required.\\nIt requires Alertmanager \u003e= v0.26.0.\"", args=[d.arg(name='userKeyFile', type=d.T.string)]), + withUserKeyFile(userKeyFile): { userKeyFile: userKeyFile }, + }, + '#slackConfigs':: d.obj(help='"List of Slack configurations."'), + slackConfigs: { + '#actions':: d.obj(help='"A list of Slack actions that are sent with each notification."'), + actions: { + '#confirm':: d.obj(help='"SlackConfirmationField protect users from destructive actions or\\nparticularly distinguished decisions by asking them to confirm their button\\nclick one more time.\\nSee https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields\\nfor more information."'), + confirm: { + '#withDismissText':: d.fn(help='', args=[d.arg(name='dismissText', type=d.T.string)]), + withDismissText(dismissText): { confirm+: { dismissText: dismissText } }, + '#withOkText':: d.fn(help='', args=[d.arg(name='okText', type=d.T.string)]), + withOkText(okText): { confirm+: { okText: okText } }, + '#withText':: d.fn(help='', args=[d.arg(name='text', type=d.T.string)]), + withText(text): { confirm+: { text: text } }, + '#withTitle':: d.fn(help='', args=[d.arg(name='title', type=d.T.string)]), + withTitle(title): { confirm+: { title: title } }, + }, + '#withName':: d.fn(help='', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withStyle':: d.fn(help='', args=[d.arg(name='style', type=d.T.string)]), + withStyle(style): { style: style }, + '#withText':: d.fn(help='', args=[d.arg(name='text', type=d.T.string)]), + withText(text): { text: text }, + '#withType':: d.fn(help='', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { type: type }, + '#withUrl':: d.fn(help='', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { url: url }, + '#withValue':: d.fn(help='', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#apiURL':: d.obj(help="\"The secret's key that contains the Slack webhook URL.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + apiURL: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { apiURL+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { apiURL+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { apiURL+: { optional: optional } }, + }, + '#fields':: d.obj(help='"A list of Slack fields that are sent with each notification."'), + fields: { + '#withShort':: d.fn(help='', args=[d.arg(name='short', type=d.T.boolean)]), + withShort(short): { short: short }, + '#withTitle':: d.fn(help='', args=[d.arg(name='title', type=d.T.string)]), + withTitle(title): { title: title }, + '#withValue':: d.fn(help='', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#withActions':: d.fn(help='"A list of Slack actions that are sent with each notification."', args=[d.arg(name='actions', type=d.T.array)]), + withActions(actions): { actions: if std.isArray(v=actions) then actions else [actions] }, + '#withActionsMixin':: d.fn(help='"A list of Slack actions that are sent with each notification."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='actions', type=d.T.array)]), + withActionsMixin(actions): { actions+: if std.isArray(v=actions) then actions else [actions] }, + '#withCallbackId':: d.fn(help='', args=[d.arg(name='callbackId', type=d.T.string)]), + withCallbackId(callbackId): { callbackId: callbackId }, + '#withChannel':: d.fn(help='"The channel or user to send notifications to."', args=[d.arg(name='channel', type=d.T.string)]), + withChannel(channel): { channel: channel }, + '#withColor':: d.fn(help='', args=[d.arg(name='color', type=d.T.string)]), + withColor(color): { color: color }, + '#withFallback':: d.fn(help='', args=[d.arg(name='fallback', type=d.T.string)]), + withFallback(fallback): { fallback: fallback }, + '#withFields':: d.fn(help='"A list of Slack fields that are sent with each notification."', args=[d.arg(name='fields', type=d.T.array)]), + withFields(fields): { fields: if std.isArray(v=fields) then fields else [fields] }, + '#withFieldsMixin':: d.fn(help='"A list of Slack fields that are sent with each notification."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='fields', type=d.T.array)]), + withFieldsMixin(fields): { fields+: if std.isArray(v=fields) then fields else [fields] }, + '#withFooter':: d.fn(help='', args=[d.arg(name='footer', type=d.T.string)]), + withFooter(footer): { footer: footer }, + '#withIconEmoji':: d.fn(help='', args=[d.arg(name='iconEmoji', type=d.T.string)]), + withIconEmoji(iconEmoji): { iconEmoji: iconEmoji }, + '#withIconURL':: d.fn(help='', args=[d.arg(name='iconURL', type=d.T.string)]), + withIconURL(iconURL): { iconURL: iconURL }, + '#withImageURL':: d.fn(help='', args=[d.arg(name='imageURL', type=d.T.string)]), + withImageURL(imageURL): { imageURL: imageURL }, + '#withLinkNames':: d.fn(help='', args=[d.arg(name='linkNames', type=d.T.boolean)]), + withLinkNames(linkNames): { linkNames: linkNames }, + '#withMrkdwnIn':: d.fn(help='', args=[d.arg(name='mrkdwnIn', type=d.T.array)]), + withMrkdwnIn(mrkdwnIn): { mrkdwnIn: if std.isArray(v=mrkdwnIn) then mrkdwnIn else [mrkdwnIn] }, + '#withMrkdwnInMixin':: d.fn(help='\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='mrkdwnIn', type=d.T.array)]), + withMrkdwnInMixin(mrkdwnIn): { mrkdwnIn+: if std.isArray(v=mrkdwnIn) then mrkdwnIn else [mrkdwnIn] }, + '#withPretext':: d.fn(help='', args=[d.arg(name='pretext', type=d.T.string)]), + withPretext(pretext): { pretext: pretext }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withShortFields':: d.fn(help='', args=[d.arg(name='shortFields', type=d.T.boolean)]), + withShortFields(shortFields): { shortFields: shortFields }, + '#withText':: d.fn(help='', args=[d.arg(name='text', type=d.T.string)]), + withText(text): { text: text }, + '#withThumbURL':: d.fn(help='', args=[d.arg(name='thumbURL', type=d.T.string)]), + withThumbURL(thumbURL): { thumbURL: thumbURL }, + '#withTitle':: d.fn(help='', args=[d.arg(name='title', type=d.T.string)]), + withTitle(title): { title: title }, + '#withTitleLink':: d.fn(help='', args=[d.arg(name='titleLink', type=d.T.string)]), + withTitleLink(titleLink): { titleLink: titleLink }, + '#withUsername':: d.fn(help='', args=[d.arg(name='username', type=d.T.string)]), + withUsername(username): { username: username }, + }, + '#snsConfigs':: d.obj(help='"List of SNS configurations"'), + snsConfigs: { + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#sigv4':: d.obj(help="\"Configures AWS's Signature Verification 4 signing process to sign requests.\""), + sigv4: { + '#accessKey':: d.obj(help='"AccessKey is the AWS API key. If not specified, the environment variable\\n`AWS_ACCESS_KEY_ID` is used."'), + accessKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { sigv4+: { accessKey+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { sigv4+: { accessKey+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { sigv4+: { accessKey+: { optional: optional } } }, + }, + '#secretKey':: d.obj(help='"SecretKey is the AWS API secret. If not specified, the environment\\nvariable `AWS_SECRET_ACCESS_KEY` is used."'), + secretKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { sigv4+: { secretKey+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { sigv4+: { secretKey+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { sigv4+: { secretKey+: { optional: optional } } }, + }, + '#withProfile':: d.fn(help='"Profile is the named AWS profile used to authenticate."', args=[d.arg(name='profile', type=d.T.string)]), + withProfile(profile): { sigv4+: { profile: profile } }, + '#withRegion':: d.fn(help='"Region is the AWS region. If blank, the region from the default credentials chain used."', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { sigv4+: { region: region } }, + '#withRoleArn':: d.fn(help='"RoleArn is the named AWS profile used to authenticate."', args=[d.arg(name='roleArn', type=d.T.string)]), + withRoleArn(roleArn): { sigv4+: { roleArn: roleArn } }, + }, + '#withApiURL':: d.fn(help='"The SNS API URL i.e. https://sns.us-east-2.amazonaws.com.\\nIf not specified, the SNS API URL from the SNS SDK will be used."', args=[d.arg(name='apiURL', type=d.T.string)]), + withApiURL(apiURL): { apiURL: apiURL }, + '#withAttributes':: d.fn(help='"SNS message attributes."', args=[d.arg(name='attributes', type=d.T.object)]), + withAttributes(attributes): { attributes: attributes }, + '#withAttributesMixin':: d.fn(help='"SNS message attributes."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='attributes', type=d.T.object)]), + withAttributesMixin(attributes): { attributes+: attributes }, + '#withMessage':: d.fn(help='"The message content of the SNS notification."', args=[d.arg(name='message', type=d.T.string)]), + withMessage(message): { message: message }, + '#withPhoneNumber':: d.fn(help="\"Phone number if message is delivered via SMS in E.164 format.\\nIf you don't specify this value, you must specify a value for the TopicARN or TargetARN.\"", args=[d.arg(name='phoneNumber', type=d.T.string)]), + withPhoneNumber(phoneNumber): { phoneNumber: phoneNumber }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withSubject':: d.fn(help='"Subject line when the message is delivered to email endpoints."', args=[d.arg(name='subject', type=d.T.string)]), + withSubject(subject): { subject: subject }, + '#withTargetARN':: d.fn(help="\"The mobile platform endpoint ARN if message is delivered via mobile notifications.\\nIf you don't specify this value, you must specify a value for the topic_arn or PhoneNumber.\"", args=[d.arg(name='targetARN', type=d.T.string)]), + withTargetARN(targetARN): { targetARN: targetARN }, + '#withTopicARN':: d.fn(help="\"SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic\\nIf you don't specify this value, you must specify a value for the PhoneNumber or TargetARN.\"", args=[d.arg(name='topicARN', type=d.T.string)]), + withTopicARN(topicARN): { topicARN: topicARN }, + }, + '#telegramConfigs':: d.obj(help='"List of Telegram configurations."'), + telegramConfigs: { + '#botToken':: d.obj(help='"Telegram bot token. It is mutually exclusive with `botTokenFile`.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\\n\\n\\nEither `botToken` or `botTokenFile` is required."'), + botToken: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { botToken+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { botToken+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { botToken+: { optional: optional } }, + }, + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#withApiURL':: d.fn(help='"The Telegram API URL i.e. https://api.telegram.org.\\nIf not specified, default API URL will be used."', args=[d.arg(name='apiURL', type=d.T.string)]), + withApiURL(apiURL): { apiURL: apiURL }, + '#withBotTokenFile':: d.fn(help='"File to read the Telegram bot token from. It is mutually exclusive with `botToken`.\\nEither `botToken` or `botTokenFile` is required.\\n\\n\\nIt requires Alertmanager >= v0.26.0."', args=[d.arg(name='botTokenFile', type=d.T.string)]), + withBotTokenFile(botTokenFile): { botTokenFile: botTokenFile }, + '#withChatID':: d.fn(help='"The Telegram chat ID."', args=[d.arg(name='chatID', type=d.T.integer)]), + withChatID(chatID): { chatID: chatID }, + '#withDisableNotifications':: d.fn(help='"Disable telegram notifications"', args=[d.arg(name='disableNotifications', type=d.T.boolean)]), + withDisableNotifications(disableNotifications): { disableNotifications: disableNotifications }, + '#withMessage':: d.fn(help='"Message template"', args=[d.arg(name='message', type=d.T.string)]), + withMessage(message): { message: message }, + '#withParseMode':: d.fn(help='"Parse mode for telegram message"', args=[d.arg(name='parseMode', type=d.T.string)]), + withParseMode(parseMode): { parseMode: parseMode }, + '#withSendResolved':: d.fn(help='"Whether to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + }, + '#victoropsConfigs':: d.obj(help='"List of VictorOps configurations."'), + victoropsConfigs: { + '#apiKey':: d.obj(help="\"The secret's key that contains the API key to use when talking to the VictorOps API.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + apiKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { apiKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { apiKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { apiKey+: { optional: optional } }, + }, + '#customFields':: d.obj(help='"Additional custom fields for notification."'), + customFields: { + '#withKey':: d.fn(help='"Key of the tuple."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withValue':: d.fn(help='"Value of the tuple."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#httpConfig':: d.obj(help="\"The HTTP client's configuration.\""), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#withApiUrl':: d.fn(help='"The VictorOps API URL."', args=[d.arg(name='apiUrl', type=d.T.string)]), + withApiUrl(apiUrl): { apiUrl: apiUrl }, + '#withCustomFields':: d.fn(help='"Additional custom fields for notification."', args=[d.arg(name='customFields', type=d.T.array)]), + withCustomFields(customFields): { customFields: if std.isArray(v=customFields) then customFields else [customFields] }, + '#withCustomFieldsMixin':: d.fn(help='"Additional custom fields for notification."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='customFields', type=d.T.array)]), + withCustomFieldsMixin(customFields): { customFields+: if std.isArray(v=customFields) then customFields else [customFields] }, + '#withEntityDisplayName':: d.fn(help='"Contains summary of the alerted problem."', args=[d.arg(name='entityDisplayName', type=d.T.string)]), + withEntityDisplayName(entityDisplayName): { entityDisplayName: entityDisplayName }, + '#withMessageType':: d.fn(help='"Describes the behavior of the alert (CRITICAL, WARNING, INFO)."', args=[d.arg(name='messageType', type=d.T.string)]), + withMessageType(messageType): { messageType: messageType }, + '#withMonitoringTool':: d.fn(help='"The monitoring tool the state message is from."', args=[d.arg(name='monitoringTool', type=d.T.string)]), + withMonitoringTool(monitoringTool): { monitoringTool: monitoringTool }, + '#withRoutingKey':: d.fn(help='"A key used to map the alert to a team."', args=[d.arg(name='routingKey', type=d.T.string)]), + withRoutingKey(routingKey): { routingKey: routingKey }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withStateMessage':: d.fn(help='"Contains long explanation of the alerted problem."', args=[d.arg(name='stateMessage', type=d.T.string)]), + withStateMessage(stateMessage): { stateMessage: stateMessage }, + }, + '#webexConfigs':: d.obj(help='"List of Webex configurations."'), + webexConfigs: { + '#httpConfig':: d.obj(help="\"The HTTP client's configuration.\\nYou must supply the bot token via the `httpConfig.authorization` field.\""), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#withApiURL':: d.fn(help='"The Webex Teams API URL i.e. https://webexapis.com/v1/messages\\nProvide if different from the default API URL."', args=[d.arg(name='apiURL', type=d.T.string)]), + withApiURL(apiURL): { apiURL: apiURL }, + '#withMessage':: d.fn(help='"Message template"', args=[d.arg(name='message', type=d.T.string)]), + withMessage(message): { message: message }, + '#withRoomID':: d.fn(help='"ID of the Webex Teams room where to send the messages."', args=[d.arg(name='roomID', type=d.T.string)]), + withRoomID(roomID): { roomID: roomID }, + '#withSendResolved':: d.fn(help='"Whether to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + }, + '#webhookConfigs':: d.obj(help='"List of webhook configurations."'), + webhookConfigs: { + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#urlSecret':: d.obj(help="\"The secret's key that contains the webhook URL to send HTTP requests to.\\n`urlSecret` takes precedence over `url`. One of `urlSecret` and `url`\\nshould be defined.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + urlSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { urlSecret+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { urlSecret+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { urlSecret+: { optional: optional } }, + }, + '#withMaxAlerts':: d.fn(help='"Maximum number of alerts to be sent per webhook message. When 0, all alerts are included."', args=[d.arg(name='maxAlerts', type=d.T.integer)]), + withMaxAlerts(maxAlerts): { maxAlerts: maxAlerts }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withUrl':: d.fn(help='"The URL to send HTTP POST requests to. `urlSecret` takes precedence over\\n`url`. One of `urlSecret` and `url` should be defined."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { url: url }, + }, + '#wechatConfigs':: d.obj(help='"List of WeChat configurations."'), + wechatConfigs: { + '#apiSecret':: d.obj(help="\"The secret's key that contains the WeChat API key.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + apiSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { apiSecret+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { apiSecret+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { apiSecret+: { optional: optional } }, + }, + '#httpConfig':: d.obj(help='"HTTP client configuration."'), + httpConfig: { + '#authorization':: d.obj(help='"Authorization header configuration for the client.\\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { httpConfig+: { authorization+: { type: type } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth for the client.\\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#bearerTokenSecret':: d.obj(help="\"The secret's key that contains the bearer token to be used by the client\\nfor authentication.\\nThe secret needs to be in the same namespace as the AlertmanagerConfig\\nobject and accessible by the Prometheus Operator.\""), + bearerTokenSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { bearerTokenSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { bearerTokenSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { bearerTokenSecret+: { optional: optional } } }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { httpConfig+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { httpConfig+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { httpConfig+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { httpConfig+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { httpConfig+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { httpConfig+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { httpConfig+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { httpConfig+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { httpConfig+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration for the client."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { httpConfig+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { httpConfig+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { httpConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { httpConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { httpConfig+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { httpConfig+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { httpConfig+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withFollowRedirects':: d.fn(help='"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { httpConfig+: { followRedirects: followRedirects } }, + '#withProxyURL':: d.fn(help='"Optional proxy URL."', args=[d.arg(name='proxyURL', type=d.T.string)]), + withProxyURL(proxyURL): { httpConfig+: { proxyURL: proxyURL } }, + }, + '#withAgentID':: d.fn(help='', args=[d.arg(name='agentID', type=d.T.string)]), + withAgentID(agentID): { agentID: agentID }, + '#withApiURL':: d.fn(help='"The WeChat API URL."', args=[d.arg(name='apiURL', type=d.T.string)]), + withApiURL(apiURL): { apiURL: apiURL }, + '#withCorpID':: d.fn(help='"The corp id for authentication."', args=[d.arg(name='corpID', type=d.T.string)]), + withCorpID(corpID): { corpID: corpID }, + '#withMessage':: d.fn(help='"API request data as defined by the WeChat API."', args=[d.arg(name='message', type=d.T.string)]), + withMessage(message): { message: message }, + '#withMessageType':: d.fn(help='', args=[d.arg(name='messageType', type=d.T.string)]), + withMessageType(messageType): { messageType: messageType }, + '#withSendResolved':: d.fn(help='"Whether or not to notify about resolved alerts."', args=[d.arg(name='sendResolved', type=d.T.boolean)]), + withSendResolved(sendResolved): { sendResolved: sendResolved }, + '#withToParty':: d.fn(help='', args=[d.arg(name='toParty', type=d.T.string)]), + withToParty(toParty): { toParty: toParty }, + '#withToTag':: d.fn(help='', args=[d.arg(name='toTag', type=d.T.string)]), + withToTag(toTag): { toTag: toTag }, + '#withToUser':: d.fn(help='', args=[d.arg(name='toUser', type=d.T.string)]), + withToUser(toUser): { toUser: toUser }, + }, + '#withDiscordConfigs':: d.fn(help='"List of Discord configurations."', args=[d.arg(name='discordConfigs', type=d.T.array)]), + withDiscordConfigs(discordConfigs): { discordConfigs: if std.isArray(v=discordConfigs) then discordConfigs else [discordConfigs] }, + '#withDiscordConfigsMixin':: d.fn(help='"List of Discord configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='discordConfigs', type=d.T.array)]), + withDiscordConfigsMixin(discordConfigs): { discordConfigs+: if std.isArray(v=discordConfigs) then discordConfigs else [discordConfigs] }, + '#withEmailConfigs':: d.fn(help='"List of Email configurations."', args=[d.arg(name='emailConfigs', type=d.T.array)]), + withEmailConfigs(emailConfigs): { emailConfigs: if std.isArray(v=emailConfigs) then emailConfigs else [emailConfigs] }, + '#withEmailConfigsMixin':: d.fn(help='"List of Email configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='emailConfigs', type=d.T.array)]), + withEmailConfigsMixin(emailConfigs): { emailConfigs+: if std.isArray(v=emailConfigs) then emailConfigs else [emailConfigs] }, + '#withMsteamsConfigs':: d.fn(help='"List of MSTeams configurations.\\nIt requires Alertmanager >= 0.26.0."', args=[d.arg(name='msteamsConfigs', type=d.T.array)]), + withMsteamsConfigs(msteamsConfigs): { msteamsConfigs: if std.isArray(v=msteamsConfigs) then msteamsConfigs else [msteamsConfigs] }, + '#withMsteamsConfigsMixin':: d.fn(help='"List of MSTeams configurations.\\nIt requires Alertmanager >= 0.26.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='msteamsConfigs', type=d.T.array)]), + withMsteamsConfigsMixin(msteamsConfigs): { msteamsConfigs+: if std.isArray(v=msteamsConfigs) then msteamsConfigs else [msteamsConfigs] }, + '#withName':: d.fn(help='"Name of the receiver. Must be unique across all items from the list."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withOpsgenieConfigs':: d.fn(help='"List of OpsGenie configurations."', args=[d.arg(name='opsgenieConfigs', type=d.T.array)]), + withOpsgenieConfigs(opsgenieConfigs): { opsgenieConfigs: if std.isArray(v=opsgenieConfigs) then opsgenieConfigs else [opsgenieConfigs] }, + '#withOpsgenieConfigsMixin':: d.fn(help='"List of OpsGenie configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='opsgenieConfigs', type=d.T.array)]), + withOpsgenieConfigsMixin(opsgenieConfigs): { opsgenieConfigs+: if std.isArray(v=opsgenieConfigs) then opsgenieConfigs else [opsgenieConfigs] }, + '#withPagerdutyConfigs':: d.fn(help='"List of PagerDuty configurations."', args=[d.arg(name='pagerdutyConfigs', type=d.T.array)]), + withPagerdutyConfigs(pagerdutyConfigs): { pagerdutyConfigs: if std.isArray(v=pagerdutyConfigs) then pagerdutyConfigs else [pagerdutyConfigs] }, + '#withPagerdutyConfigsMixin':: d.fn(help='"List of PagerDuty configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='pagerdutyConfigs', type=d.T.array)]), + withPagerdutyConfigsMixin(pagerdutyConfigs): { pagerdutyConfigs+: if std.isArray(v=pagerdutyConfigs) then pagerdutyConfigs else [pagerdutyConfigs] }, + '#withPushoverConfigs':: d.fn(help='"List of Pushover configurations."', args=[d.arg(name='pushoverConfigs', type=d.T.array)]), + withPushoverConfigs(pushoverConfigs): { pushoverConfigs: if std.isArray(v=pushoverConfigs) then pushoverConfigs else [pushoverConfigs] }, + '#withPushoverConfigsMixin':: d.fn(help='"List of Pushover configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='pushoverConfigs', type=d.T.array)]), + withPushoverConfigsMixin(pushoverConfigs): { pushoverConfigs+: if std.isArray(v=pushoverConfigs) then pushoverConfigs else [pushoverConfigs] }, + '#withSlackConfigs':: d.fn(help='"List of Slack configurations."', args=[d.arg(name='slackConfigs', type=d.T.array)]), + withSlackConfigs(slackConfigs): { slackConfigs: if std.isArray(v=slackConfigs) then slackConfigs else [slackConfigs] }, + '#withSlackConfigsMixin':: d.fn(help='"List of Slack configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='slackConfigs', type=d.T.array)]), + withSlackConfigsMixin(slackConfigs): { slackConfigs+: if std.isArray(v=slackConfigs) then slackConfigs else [slackConfigs] }, + '#withSnsConfigs':: d.fn(help='"List of SNS configurations"', args=[d.arg(name='snsConfigs', type=d.T.array)]), + withSnsConfigs(snsConfigs): { snsConfigs: if std.isArray(v=snsConfigs) then snsConfigs else [snsConfigs] }, + '#withSnsConfigsMixin':: d.fn(help='"List of SNS configurations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='snsConfigs', type=d.T.array)]), + withSnsConfigsMixin(snsConfigs): { snsConfigs+: if std.isArray(v=snsConfigs) then snsConfigs else [snsConfigs] }, + '#withTelegramConfigs':: d.fn(help='"List of Telegram configurations."', args=[d.arg(name='telegramConfigs', type=d.T.array)]), + withTelegramConfigs(telegramConfigs): { telegramConfigs: if std.isArray(v=telegramConfigs) then telegramConfigs else [telegramConfigs] }, + '#withTelegramConfigsMixin':: d.fn(help='"List of Telegram configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='telegramConfigs', type=d.T.array)]), + withTelegramConfigsMixin(telegramConfigs): { telegramConfigs+: if std.isArray(v=telegramConfigs) then telegramConfigs else [telegramConfigs] }, + '#withVictoropsConfigs':: d.fn(help='"List of VictorOps configurations."', args=[d.arg(name='victoropsConfigs', type=d.T.array)]), + withVictoropsConfigs(victoropsConfigs): { victoropsConfigs: if std.isArray(v=victoropsConfigs) then victoropsConfigs else [victoropsConfigs] }, + '#withVictoropsConfigsMixin':: d.fn(help='"List of VictorOps configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='victoropsConfigs', type=d.T.array)]), + withVictoropsConfigsMixin(victoropsConfigs): { victoropsConfigs+: if std.isArray(v=victoropsConfigs) then victoropsConfigs else [victoropsConfigs] }, + '#withWebexConfigs':: d.fn(help='"List of Webex configurations."', args=[d.arg(name='webexConfigs', type=d.T.array)]), + withWebexConfigs(webexConfigs): { webexConfigs: if std.isArray(v=webexConfigs) then webexConfigs else [webexConfigs] }, + '#withWebexConfigsMixin':: d.fn(help='"List of Webex configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='webexConfigs', type=d.T.array)]), + withWebexConfigsMixin(webexConfigs): { webexConfigs+: if std.isArray(v=webexConfigs) then webexConfigs else [webexConfigs] }, + '#withWebhookConfigs':: d.fn(help='"List of webhook configurations."', args=[d.arg(name='webhookConfigs', type=d.T.array)]), + withWebhookConfigs(webhookConfigs): { webhookConfigs: if std.isArray(v=webhookConfigs) then webhookConfigs else [webhookConfigs] }, + '#withWebhookConfigsMixin':: d.fn(help='"List of webhook configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='webhookConfigs', type=d.T.array)]), + withWebhookConfigsMixin(webhookConfigs): { webhookConfigs+: if std.isArray(v=webhookConfigs) then webhookConfigs else [webhookConfigs] }, + '#withWechatConfigs':: d.fn(help='"List of WeChat configurations."', args=[d.arg(name='wechatConfigs', type=d.T.array)]), + withWechatConfigs(wechatConfigs): { wechatConfigs: if std.isArray(v=wechatConfigs) then wechatConfigs else [wechatConfigs] }, + '#withWechatConfigsMixin':: d.fn(help='"List of WeChat configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='wechatConfigs', type=d.T.array)]), + withWechatConfigsMixin(wechatConfigs): { wechatConfigs+: if std.isArray(v=wechatConfigs) then wechatConfigs else [wechatConfigs] }, + }, + '#route':: d.obj(help="\"The Alertmanager route definition for alerts matching the resource's\\nnamespace. If present, it will be added to the generated Alertmanager\\nconfiguration as a first-level route.\""), + route: { + '#matchers':: d.obj(help="\"List of matchers that the alert's labels should match. For the first\\nlevel route, the operator removes any existing equality and regexp\\nmatcher on the `namespace` label and adds a `namespace: \u003cobject\\nnamespace\u003e` matcher.\""), + matchers: { + '#withMatchType':: d.fn(help='"Match operation available with AlertManager >= v0.22.0 and\\ntakes precedence over Regex (deprecated) if non-empty."', args=[d.arg(name='matchType', type=d.T.string)]), + withMatchType(matchType): { matchType: matchType }, + '#withName':: d.fn(help='"Label to match."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withRegex':: d.fn(help='"Whether to match on equality (false) or regular-expression (true).\\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead."', args=[d.arg(name='regex', type=d.T.boolean)]), + withRegex(regex): { regex: regex }, + '#withValue':: d.fn(help='"Label value to match."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withActiveTimeIntervals':: d.fn(help='"ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active."', args=[d.arg(name='activeTimeIntervals', type=d.T.array)]), + withActiveTimeIntervals(activeTimeIntervals): { spec+: { route+: { activeTimeIntervals: if std.isArray(v=activeTimeIntervals) then activeTimeIntervals else [activeTimeIntervals] } } }, + '#withActiveTimeIntervalsMixin':: d.fn(help='"ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='activeTimeIntervals', type=d.T.array)]), + withActiveTimeIntervalsMixin(activeTimeIntervals): { spec+: { route+: { activeTimeIntervals+: if std.isArray(v=activeTimeIntervals) then activeTimeIntervals else [activeTimeIntervals] } } }, + '#withContinue':: d.fn(help='"Boolean indicating whether an alert should continue matching subsequent\\nsibling nodes. It will always be overridden to true for the first-level\\nroute by the Prometheus operator."', args=[d.arg(name='continue', type=d.T.boolean)]), + withContinue(continue): { spec+: { route+: { continue: continue } } }, + '#withGroupBy':: d.fn(help='"List of labels to group by.\\nLabels must not be repeated (unique list).\\nSpecial label \\"...\\" (aggregate by all possible labels), if provided, must be the only element in the list."', args=[d.arg(name='groupBy', type=d.T.array)]), + withGroupBy(groupBy): { spec+: { route+: { groupBy: if std.isArray(v=groupBy) then groupBy else [groupBy] } } }, + '#withGroupByMixin':: d.fn(help='"List of labels to group by.\\nLabels must not be repeated (unique list).\\nSpecial label \\"...\\" (aggregate by all possible labels), if provided, must be the only element in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='groupBy', type=d.T.array)]), + withGroupByMixin(groupBy): { spec+: { route+: { groupBy+: if std.isArray(v=groupBy) then groupBy else [groupBy] } } }, + '#withGroupInterval':: d.fn(help='"How long to wait before sending an updated notification.\\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\\nExample: \\"5m\\', args=[d.arg(name='groupInterval', type=d.T.string)]), + withGroupInterval(groupInterval): { spec+: { route+: { groupInterval: groupInterval } } }, + '#withGroupWait':: d.fn(help='"How long to wait before sending the initial notification.\\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\\nExample: \\"30s\\', args=[d.arg(name='groupWait', type=d.T.string)]), + withGroupWait(groupWait): { spec+: { route+: { groupWait: groupWait } } }, + '#withMatchers':: d.fn(help="\"List of matchers that the alert's labels should match. For the first\\nlevel route, the operator removes any existing equality and regexp\\nmatcher on the `namespace` label and adds a `namespace: \u003cobject\\nnamespace\u003e` matcher.\"", args=[d.arg(name='matchers', type=d.T.array)]), + withMatchers(matchers): { spec+: { route+: { matchers: if std.isArray(v=matchers) then matchers else [matchers] } } }, + '#withMatchersMixin':: d.fn(help="\"List of matchers that the alert's labels should match. For the first\\nlevel route, the operator removes any existing equality and regexp\\nmatcher on the `namespace` label and adds a `namespace: \u003cobject\\nnamespace\u003e` matcher.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchers', type=d.T.array)]), + withMatchersMixin(matchers): { spec+: { route+: { matchers+: if std.isArray(v=matchers) then matchers else [matchers] } } }, + '#withMuteTimeIntervals':: d.fn(help="\"Note: this comment applies to the field definition above but appears\\nbelow otherwise it gets included in the generated manifest.\\nCRD schema doesn't support self-referential types for now (see\\nhttps://github.com/kubernetes/kubernetes/issues/62872). We have to use\\nan alternative type to circumvent the limitation. The downside is that\\nthe Kube API can't validate the data beyond the fact that it is a valid\\nJSON representation.\\nMuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,\"", args=[d.arg(name='muteTimeIntervals', type=d.T.array)]), + withMuteTimeIntervals(muteTimeIntervals): { spec+: { route+: { muteTimeIntervals: if std.isArray(v=muteTimeIntervals) then muteTimeIntervals else [muteTimeIntervals] } } }, + '#withMuteTimeIntervalsMixin':: d.fn(help="\"Note: this comment applies to the field definition above but appears\\nbelow otherwise it gets included in the generated manifest.\\nCRD schema doesn't support self-referential types for now (see\\nhttps://github.com/kubernetes/kubernetes/issues/62872). We have to use\\nan alternative type to circumvent the limitation. The downside is that\\nthe Kube API can't validate the data beyond the fact that it is a valid\\nJSON representation.\\nMuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='muteTimeIntervals', type=d.T.array)]), + withMuteTimeIntervalsMixin(muteTimeIntervals): { spec+: { route+: { muteTimeIntervals+: if std.isArray(v=muteTimeIntervals) then muteTimeIntervals else [muteTimeIntervals] } } }, + '#withReceiver':: d.fn(help='"Name of the receiver for this route. If not empty, it should be listed in\\nthe `receivers` field."', args=[d.arg(name='receiver', type=d.T.string)]), + withReceiver(receiver): { spec+: { route+: { receiver: receiver } } }, + '#withRepeatInterval':: d.fn(help='"How long to wait before repeating the last notification.\\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\\nExample: \\"4h\\', args=[d.arg(name='repeatInterval', type=d.T.string)]), + withRepeatInterval(repeatInterval): { spec+: { route+: { repeatInterval: repeatInterval } } }, + '#withRoutes':: d.fn(help='"Child routes."', args=[d.arg(name='routes', type=d.T.array)]), + withRoutes(routes): { spec+: { route+: { routes: if std.isArray(v=routes) then routes else [routes] } } }, + '#withRoutesMixin':: d.fn(help='"Child routes."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='routes', type=d.T.array)]), + withRoutesMixin(routes): { spec+: { route+: { routes+: if std.isArray(v=routes) then routes else [routes] } } }, + }, + '#withInhibitRules':: d.fn(help="\"List of inhibition rules. The rules will only apply to alerts matching\\nthe resource's namespace.\"", args=[d.arg(name='inhibitRules', type=d.T.array)]), + withInhibitRules(inhibitRules): { spec+: { inhibitRules: if std.isArray(v=inhibitRules) then inhibitRules else [inhibitRules] } }, + '#withInhibitRulesMixin':: d.fn(help="\"List of inhibition rules. The rules will only apply to alerts matching\\nthe resource's namespace.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='inhibitRules', type=d.T.array)]), + withInhibitRulesMixin(inhibitRules): { spec+: { inhibitRules+: if std.isArray(v=inhibitRules) then inhibitRules else [inhibitRules] } }, + '#withMuteTimeIntervals':: d.fn(help='"List of MuteTimeInterval specifying when the routes should be muted."', args=[d.arg(name='muteTimeIntervals', type=d.T.array)]), + withMuteTimeIntervals(muteTimeIntervals): { spec+: { muteTimeIntervals: if std.isArray(v=muteTimeIntervals) then muteTimeIntervals else [muteTimeIntervals] } }, + '#withMuteTimeIntervalsMixin':: d.fn(help='"List of MuteTimeInterval specifying when the routes should be muted."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='muteTimeIntervals', type=d.T.array)]), + withMuteTimeIntervalsMixin(muteTimeIntervals): { spec+: { muteTimeIntervals+: if std.isArray(v=muteTimeIntervals) then muteTimeIntervals else [muteTimeIntervals] } }, + '#withReceivers':: d.fn(help='"List of receivers."', args=[d.arg(name='receivers', type=d.T.array)]), + withReceivers(receivers): { spec+: { receivers: if std.isArray(v=receivers) then receivers else [receivers] } }, + '#withReceiversMixin':: d.fn(help='"List of receivers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='receivers', type=d.T.array)]), + withReceiversMixin(receivers): { spec+: { receivers+: if std.isArray(v=receivers) then receivers else [receivers] } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/_gen/monitoring/v1alpha1/main.libsonnet b/0.14/_gen/monitoring/v1alpha1/main.libsonnet new file mode 100644 index 0000000..646883d --- /dev/null +++ b/0.14/_gen/monitoring/v1alpha1/main.libsonnet @@ -0,0 +1,7 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='v1alpha1', url='', help=''), + alertmanagerConfig: (import 'alertmanagerConfig.libsonnet'), + prometheusAgent: (import 'prometheusAgent.libsonnet'), + scrapeConfig: (import 'scrapeConfig.libsonnet'), +} diff --git a/0.14/_gen/monitoring/v1alpha1/prometheusAgent.libsonnet b/0.14/_gen/monitoring/v1alpha1/prometheusAgent.libsonnet new file mode 100644 index 0000000..ead86a8 --- /dev/null +++ b/0.14/_gen/monitoring/v1alpha1/prometheusAgent.libsonnet @@ -0,0 +1,3581 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='prometheusAgent', url='', help="\"The `PrometheusAgent` custom resource definition (CRD) defines a desired [Prometheus Agent](https://prometheus.io/blog/2021/11/16/agent/) setup to run in a Kubernetes cluster.\\n\\n\\nThe CRD is very similar to the `Prometheus` CRD except for features which aren't available in agent mode like rule evaluation, persistent storage and Thanos sidecar.\""), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of PrometheusAgent', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1alpha1', + kind: 'PrometheusAgent', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"Specification of the desired behavior of the Prometheus agent. More info:\\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"'), + spec: { + '#additionalArgs':: d.obj(help="\"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\\n\\n\\nIt is intended for e.g. activating hidden flags which are not supported by\\nthe dedicated configuration options yet. The arguments are passed as-is to the\\nPrometheus container which may cause issues if they are invalid or not supported\\nby the given Prometheus version.\\n\\n\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument, the reconciliation will\\nfail and an error will be logged.\""), + additionalArgs: { + '#withName':: d.fn(help='"Name of the argument, e.g. \\"scrape.discovery-reload-interval\\"."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#additionalScrapeConfigs':: d.obj(help='"AdditionalScrapeConfigs allows specifying a key of a Secret containing\\nadditional Prometheus scrape configurations. Scrape configurations\\nspecified are appended to the configurations generated by the Prometheus\\nOperator. Job configurations specified must have the form as specified\\nin the official Prometheus documentation:\\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.\\nAs scrape configs are appended, the user is responsible to make sure it\\nis valid. Note that using this feature may expose the possibility to\\nbreak upgrades of Prometheus. It is advised to review Prometheus release\\nnotes to ensure that no incompatible scrape configs are going to break\\nPrometheus after the upgrade."'), + additionalScrapeConfigs: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { additionalScrapeConfigs+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { additionalScrapeConfigs+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { additionalScrapeConfigs+: { optional: optional } } }, + }, + '#affinity':: d.obj(help="\"Defines the Pods' affinity scheduling rules if specified.\""), + affinity: { + '#nodeAffinity':: d.obj(help='"Describes node affinity scheduling rules for the pod."'), + nodeAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#preference':: d.obj(help='"A node selector term, associated with the corresponding weight."'), + preference: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { preference+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { preference+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { preference+: { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { preference+: { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] } }, + }, + '#withWeight':: d.fn(help='"Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to an update), the system\\nmay or may not try to eventually evict the pod from its node."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#nodeSelectorTerms':: d.obj(help='"Required. A list of node selector terms. The terms are ORed."'), + nodeSelectorTerms: { + '#matchExpressions':: d.obj(help="\"A list of node selector requirements by node's labels.\""), + matchExpressions: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#matchFields':: d.obj(help="\"A list of node selector requirements by node's fields.\""), + matchFields: { + '#withKey':: d.fn(help='"The label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"An array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. If the operator is Gt or Lt, the values\\narray must have a single element, which will be interpreted as an integer.\\nThis array is replaced during a strategic merge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help="\"A list of node selector requirements by node's labels.\"", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchExpressionsMixin':: d.fn(help="\"A list of node selector requirements by node's labels.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] }, + '#withMatchFields':: d.fn(help="\"A list of node selector requirements by node's fields.\"", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFields(matchFields): { matchFields: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + '#withMatchFieldsMixin':: d.fn(help="\"A list of node selector requirements by node's fields.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchFields', type=d.T.array)]), + withMatchFieldsMixin(matchFields): { matchFields+: if std.isArray(v=matchFields) then matchFields else [matchFields] }, + }, + '#withNodeSelectorTerms':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTerms(nodeSelectorTerms): { spec+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } }, + '#withNodeSelectorTermsMixin':: d.fn(help='"Required. A list of node selector terms. The terms are ORed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeSelectorTerms', type=d.T.array)]), + withNodeSelectorTermsMixin(nodeSelectorTerms): { spec+: { affinity+: { nodeAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: { nodeSelectorTerms+: if std.isArray(v=nodeSelectorTerms) then nodeSelectorTerms else [nodeSelectorTerms] } } } } }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node matches the corresponding matchExpressions; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { nodeAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + '#podAffinity':: d.obj(help='"Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s))."'), + podAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm,\\nin the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + '#podAntiAffinity':: d.obj(help='"Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s))."'), + podAntiAffinity: { + '#preferredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."'), + preferredDuringSchedulingIgnoredDuringExecution: { + '#podAffinityTerm':: d.obj(help='"Required. A pod affinity term, associated with the corresponding weight."'), + podAffinityTerm: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { podAffinityTerm+: { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { podAffinityTerm+: { namespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { podAffinityTerm+: { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] } }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { podAffinityTerm+: { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] } }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { podAffinityTerm+: { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { podAffinityTerm+: { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] } }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { podAffinityTerm+: { topologyKey: topologyKey } }, + }, + '#withWeight':: d.fn(help='"weight associated with matching the corresponding podAffinityTerm,\\nin the range 1-100."', args=[d.arg(name='weight', type=d.T.integer)]), + withWeight(weight): { weight: weight }, + }, + '#requiredDuringSchedulingIgnoredDuringExecution':: d.obj(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."'), + requiredDuringSchedulingIgnoredDuringExecution: { + '#labelSelector':: d.obj(help="\"A label query over a set of resources, in this case pods.\\nIf it's null, this PodAffinityTerm matches with no Pods.\""), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#namespaceSelector':: d.obj(help="\"A label query over the set of namespaces that the term applies to.\\nThe term is applied to the union of the namespaces selected by this field\\nand the ones listed in the namespaces field.\\nnull selector and null or empty namespaces list means \\\"this pod's namespace\\\".\\nAn empty selector ({}) matches all namespaces.\""), + namespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { namespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { namespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { namespaceSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { namespaceSelector+: { matchLabels+: matchLabels } }, + }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMismatchLabelKeys':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeys(mismatchLabelKeys): { mismatchLabelKeys: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withMismatchLabelKeysMixin':: d.fn(help="\"MismatchLabelKeys is a set of pod label keys to select which pods will\\nbe taken into consideration. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\\nto select the group of existing pods which pods will be taken into consideration\\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\\npod labels will be ignored. The default value is empty.\\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='mismatchLabelKeys', type=d.T.array)]), + withMismatchLabelKeysMixin(mismatchLabelKeys): { mismatchLabelKeys+: if std.isArray(v=mismatchLabelKeys) then mismatchLabelKeys else [mismatchLabelKeys] }, + '#withNamespaces':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespaces(namespaces): { namespaces: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withNamespacesMixin':: d.fn(help="\"namespaces specifies a static list of namespace names that the term applies to.\\nThe term is applied to the union of the namespaces listed in this field\\nand the ones selected by namespaceSelector.\\nnull or empty namespaces list and null namespaceSelector means \\\"this pod's namespace\\\".\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='namespaces', type=d.T.array)]), + withNamespacesMixin(namespaces): { namespaces+: if std.isArray(v=namespaces) then namespaces else [namespaces] }, + '#withTopologyKey':: d.fn(help='"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\\nwhose value of the label with key topologyKey matches that of any node on which any of the\\nselected pods is running.\\nEmpty topologyKey is not allowed."', args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + }, + '#withPreferredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withPreferredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"The scheduler will prefer to schedule pods to nodes that satisfy\\nthe anti-affinity expressions specified by this field, but it may choose\\na node that violates one or more of the expressions. The node that is\\nmost preferred is the one with the greatest sum of weights, i.e.\\nfor each node that meets all of the scheduling requirements (resource\\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\\ncompute a sum by iterating through the elements of this field and adding\\n\\"weight\\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\\nnode(s) with the highest sum are the most preferred."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='preferredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { preferredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=preferredDuringSchedulingIgnoredDuringExecution) then preferredDuringSchedulingIgnoredDuringExecution else [preferredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecution':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + '#withRequiredDuringSchedulingIgnoredDuringExecutionMixin':: d.fn(help='"If the anti-affinity requirements specified by this field are not met at\\nscheduling time, the pod will not be scheduled onto the node.\\nIf the anti-affinity requirements specified by this field cease to be met\\nat some point during pod execution (e.g. due to a pod label update), the\\nsystem may or may not try to eventually evict the pod from its node.\\nWhen there are multiple elements, the lists of nodes corresponding to each\\npodAffinityTerm are intersected, i.e. all terms must be satisfied."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requiredDuringSchedulingIgnoredDuringExecution', type=d.T.array)]), + withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution): { spec+: { affinity+: { podAntiAffinity+: { requiredDuringSchedulingIgnoredDuringExecution+: if std.isArray(v=requiredDuringSchedulingIgnoredDuringExecution) then requiredDuringSchedulingIgnoredDuringExecution else [requiredDuringSchedulingIgnoredDuringExecution] } } } }, + }, + }, + '#apiserverConfig':: d.obj(help="\"APIServerConfig allows specifying a host and auth methods to access the\\nKuberntees API server.\\nIf null, Prometheus is assumed to run inside of the cluster: it will\\ndiscover the API servers automatically and use the Pod's CA certificate\\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.\""), + apiserverConfig: { + '#authorization':: d.obj(help='"Authorization section for the API server.\\n\\n\\nCannot be set at the same time as `basicAuth`, `bearerToken`, or\\n`bearerTokenFile`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { authorization+: { credentials+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { authorization+: { credentials+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { authorization+: { credentials+: { optional: optional } } } } }, + }, + '#withCredentialsFile':: d.fn(help='"File to read a secret from, mutually exclusive with `credentials`."', args=[d.arg(name='credentialsFile', type=d.T.string)]), + withCredentialsFile(credentialsFile): { spec+: { apiserverConfig+: { authorization+: { credentialsFile: credentialsFile } } } }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { apiserverConfig+: { authorization+: { type: type } } } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth configuration for the API server.\\n\\n\\nCannot be set at the same time as `authorization`, `bearerToken`, or\\n`bearerTokenFile`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { basicAuth+: { password+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { basicAuth+: { password+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { basicAuth+: { password+: { optional: optional } } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { basicAuth+: { username+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { basicAuth+: { username+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { basicAuth+: { username+: { optional: optional } } } } }, + }, + }, + '#tlsConfig':: d.obj(help='"TLS Config to use for the API server."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { apiserverConfig+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { apiserverConfig+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { apiserverConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { spec+: { apiserverConfig+: { tlsConfig+: { caFile: caFile } } } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { spec+: { apiserverConfig+: { tlsConfig+: { certFile: certFile } } } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { apiserverConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { spec+: { apiserverConfig+: { tlsConfig+: { keyFile: keyFile } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { apiserverConfig+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { apiserverConfig+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { apiserverConfig+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withBearerToken':: d.fn(help="\"*Warning: this field shouldn't be used because the token value appears\\nin clear-text. Prefer using `authorization`.*\\n\\n\\nDeprecated: this will be removed in a future release.\"", args=[d.arg(name='bearerToken', type=d.T.string)]), + withBearerToken(bearerToken): { spec+: { apiserverConfig+: { bearerToken: bearerToken } } }, + '#withBearerTokenFile':: d.fn(help='"File to read bearer token for accessing apiserver.\\n\\n\\nCannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`.\\n\\n\\nDeprecated: this will be removed in a future release. Prefer using `authorization`."', args=[d.arg(name='bearerTokenFile', type=d.T.string)]), + withBearerTokenFile(bearerTokenFile): { spec+: { apiserverConfig+: { bearerTokenFile: bearerTokenFile } } }, + '#withHost':: d.fn(help='"Kubernetes API address consisting of a hostname or IP address followed\\nby an optional port number."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { spec+: { apiserverConfig+: { host: host } } }, + }, + '#arbitraryFSAccessThroughSMs':: d.obj(help="\"When true, ServiceMonitor, PodMonitor and Probe object are forbidden to\\nreference arbitrary files on the file system of the 'prometheus'\\ncontainer.\\nWhen a ServiceMonitor's endpoint specifies a `bearerTokenFile` value\\n(e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a\\nmalicious target can get access to the Prometheus service account's\\ntoken in the Prometheus' scrape request. Setting\\n`spec.arbitraryFSAccessThroughSM` to 'true' would prevent the attack.\\nUsers should instead provide the credentials using the\\n`spec.bearerTokenSecret` field.\""), + arbitraryFSAccessThroughSMs: { + '#withDeny':: d.fn(help='', args=[d.arg(name='deny', type=d.T.boolean)]), + withDeny(deny): { spec+: { arbitraryFSAccessThroughSMs+: { deny: deny } } }, + }, + '#containers':: d.obj(help='"Containers allows injecting additional containers or modifying operator\\ngenerated containers. This can be used to allow adding an authentication\\nproxy to the Pods or to change the behavior of an operator generated\\ncontainer. Containers described here modify an operator generated\\ncontainer if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of containers managed by the operator are:\\n* `prometheus`\\n* `config-reloader`\\n* `thanos-sidecar`\\n\\n\\nOverriding containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."'), + containers: { + '#env':: d.obj(help='"List of environment variables to set in the container.\\nCannot be updated."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded\\nusing the previously defined environment variables in the container and\\nany service environment variables. If a variable cannot be resolved,\\nthe reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\\n\\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\".\\nEscaped references will never be expanded, regardless of whether the variable\\nexists or not.\\nDefaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#envFrom':: d.obj(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."'), + envFrom: { + '#configMapRef':: d.obj(help='"The ConfigMap to select from"'), + configMapRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMapRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMapRef+: { optional: optional } }, + }, + '#secretRef':: d.obj(help='"The Secret to select from"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretRef+: { optional: optional } }, + }, + '#withPrefix':: d.fn(help='"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { prefix: prefix }, + }, + '#lifecycle':: d.obj(help='"Actions that the management system should take in response to container lifecycle events.\\nCannot be updated."'), + lifecycle: { + '#postStart':: d.obj(help='"PostStart is called immediately after a container is created. If the handler fails,\\nthe container is terminated and restarted according to its restart policy.\\nOther management of the container blocks until the hook completes.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"'), + postStart: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { postStart+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { postStart+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { postStart+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { postStart+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { postStart+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { tcpSocket+: { port: port } } } }, + }, + }, + '#preStop':: d.obj(help="\"PreStop is called immediately before a container is terminated due to an\\nAPI request or management event such as liveness/startup probe failure,\\npreemption, resource contention, etc. The handler is not called if the\\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\\nPreStop hook is executed. Regardless of the outcome of the handler, the\\ncontainer will eventually terminate within the Pod's termination grace\\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\\nor until the termination grace period is reached.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\""), + preStop: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { preStop+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { preStop+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { preStop+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { preStop+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { preStop+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { tcpSocket+: { port: port } } } }, + }, + }, + }, + '#livenessProbe':: d.obj(help='"Periodic probe of container liveness.\\nContainer will be restarted if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + livenessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { livenessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { livenessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { livenessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { livenessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { livenessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { livenessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { livenessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { livenessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { livenessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { livenessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { livenessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { livenessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#ports':: d.obj(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."'), + ports: { + '#withContainerPort':: d.fn(help="\"Number of port to expose on the pod's IP address.\\nThis must be a valid port number, 0 \u003c x \u003c 65536.\"", args=[d.arg(name='containerPort', type=d.T.integer)]), + withContainerPort(containerPort): { containerPort: containerPort }, + '#withHostIP':: d.fn(help='"What host IP to bind the external port to."', args=[d.arg(name='hostIP', type=d.T.string)]), + withHostIP(hostIP): { hostIP: hostIP }, + '#withHostPort':: d.fn(help='"Number of port to expose on the host.\\nIf specified, this must be a valid port number, 0 < x < 65536.\\nIf HostNetwork is specified, this must match ContainerPort.\\nMost containers do not need this."', args=[d.arg(name='hostPort', type=d.T.integer)]), + withHostPort(hostPort): { hostPort: hostPort }, + '#withName':: d.fn(help='"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\\nnamed port in a pod must have a unique name. Name for the port that can be\\nreferred to by services."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withProtocol':: d.fn(help='"Protocol for port. Must be UDP, TCP, or SCTP.\\nDefaults to \\"TCP\\"."', args=[d.arg(name='protocol', type=d.T.string)]), + withProtocol(protocol): { protocol: protocol }, + }, + '#readinessProbe':: d.obj(help='"Periodic probe of container service readiness.\\nContainer will be removed from service endpoints if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + readinessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { readinessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { readinessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { readinessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { readinessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { readinessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { readinessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { readinessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { readinessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { readinessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { readinessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { readinessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { readinessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#resizePolicy':: d.obj(help='"Resources resize policy for the container."'), + resizePolicy: { + '#withResourceName':: d.fn(help='"Name of the resource to which this resource resize policy applies.\\nSupported values: cpu, memory."', args=[d.arg(name='resourceName', type=d.T.string)]), + withResourceName(resourceName): { resourceName: resourceName }, + '#withRestartPolicy':: d.fn(help='"Restart policy to apply when specified resource is resized.\\nIf not specified, it defaults to NotRequired."', args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + }, + '#resources':: d.obj(help='"Compute Resources required by this container.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { resources+: { limits: limits } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { resources+: { limits+: limits } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { resources+: { requests: requests } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { resources+: { requests+: requests } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with.\\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#appArmorProfile':: d.obj(help="\"appArmorProfile is the AppArmor options to use by this container. If set, this profile\\noverrides the pod's appArmorProfile.\\nNote that this field cannot be set when spec.os.name is windows.\""), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { appArmorProfile+: { type: type } } }, + }, + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers.\\nDefaults to the default set of capabilities granted by the container runtime.\\nNote that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { securityContext+: { seLinuxOptions+: { level: level } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { securityContext+: { seLinuxOptions+: { role: role } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seLinuxOptions+: { type: type } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { securityContext+: { seLinuxOptions+: { user: user } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are\\nprovided at both the pod & container level, the container options\\noverride the pod options.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seccompProfile+: { type: type } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers.\\nIf unspecified, the options from the PodSecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more\\nprivileges than its parent process. This bool directly controls if\\nthe no_new_privs flag will be set on the container process.\\nAllowPrivilegeEscalation is true always when the container is:\\n1) run as Privileged\\n2) has CAP_SYS_ADMIN\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode.\\nProcesses in privileged containers are essentially equivalent to root on the host.\\nDefaults to false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { securityContext+: { privileged: privileged } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers.\\nThe default is DefaultProcMount which uses the container runtime defaults for\\nreadonly paths and masked paths.\\nThis requires the ProcMountType feature flag to be enabled.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { securityContext+: { procMount: procMount } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem.\\nDefault is false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { securityContext+: { runAsGroup: runAsGroup } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { securityContext+: { runAsNonRoot: runAsNonRoot } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { securityContext+: { runAsUser: runAsUser } }, + }, + '#startupProbe':: d.obj(help="\"StartupProbe indicates that the Pod has successfully initialized.\\nIf specified, no other probes are executed until this completes successfully.\\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\\nThis cannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\""), + startupProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { startupProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { startupProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { startupProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { startupProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { startupProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { startupProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { startupProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { startupProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { startupProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { startupProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { startupProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { startupProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#volumeDevices':: d.obj(help='"volumeDevices is the list of block devices to be used by the container."'), + volumeDevices: { + '#withDevicePath':: d.fn(help='"devicePath is the path inside of the container that the device will be mapped to."', args=[d.arg(name='devicePath', type=d.T.string)]), + withDevicePath(devicePath): { devicePath: devicePath }, + '#withName':: d.fn(help='"name must match the name of a persistentVolumeClaim in the pod"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#volumeMounts':: d.obj(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withArgs':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='args', type=d.T.array)]), + withArgs(args): { args: if std.isArray(v=args) then args else [args] }, + '#withArgsMixin':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='args', type=d.T.array)]), + withArgsMixin(args): { args+: if std.isArray(v=args) then args else [args] }, + '#withCommand':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { command: if std.isArray(v=command) then command else [command] }, + '#withCommandMixin':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { command+: if std.isArray(v=command) then command else [command] }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { env: if std.isArray(v=env) then env else [env] }, + '#withEnvFrom':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFrom(envFrom): { envFrom: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvFromMixin':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFromMixin(envFrom): { envFrom+: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { env+: if std.isArray(v=env) then env else [env] }, + '#withImage':: d.fn(help='"Container image name.\\nMore info: https://kubernetes.io/docs/concepts/containers/images\\nThis field is optional to allow higher level config management to default or override\\ncontainer images in workload controllers like Deployments and StatefulSets."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { image: image }, + '#withImagePullPolicy':: d.fn(help='"Image pull policy.\\nOne of Always, Never, IfNotPresent.\\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images"', args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { imagePullPolicy: imagePullPolicy }, + '#withName':: d.fn(help='"Name of the container specified as a DNS_LABEL.\\nEach container in a pod must have a unique name (DNS_LABEL).\\nCannot be updated."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPorts':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."', args=[d.arg(name='ports', type=d.T.array)]), + withPorts(ports): { ports: if std.isArray(v=ports) then ports else [ports] }, + '#withPortsMixin':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ports', type=d.T.array)]), + withPortsMixin(ports): { ports+: if std.isArray(v=ports) then ports else [ports] }, + '#withResizePolicy':: d.fn(help='"Resources resize policy for the container."', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicy(resizePolicy): { resizePolicy: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withResizePolicyMixin':: d.fn(help='"Resources resize policy for the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicyMixin(resizePolicy): { resizePolicy+: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withRestartPolicy':: d.fn(help="\"RestartPolicy defines the restart behavior of individual containers in a pod.\\nThis field may only be set for init containers, and the only allowed value is \\\"Always\\\".\\nFor non-init containers or when this field is not specified,\\nthe restart behavior is defined by the Pod's restart policy and the container type.\\nSetting the RestartPolicy as \\\"Always\\\" for the init container will have the following effect:\\nthis init container will be continually restarted on\\nexit until all regular containers have terminated. Once all regular\\ncontainers have completed, all init containers with restartPolicy \\\"Always\\\"\\nwill be shut down. This lifecycle differs from normal init containers and\\nis often referred to as a \\\"sidecar\\\" container. Although this init\\ncontainer still starts in the init container sequence, it does not wait\\nfor the container to complete before proceeding to the next init\\ncontainer. Instead, the next init container starts immediately after this\\ninit container is started, or after any startupProbe has successfully\\ncompleted.\"", args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + '#withStdin':: d.fn(help='"Whether this container should allocate a buffer for stdin in the container runtime. If this\\nis not set, reads from stdin in the container will always result in EOF.\\nDefault is false."', args=[d.arg(name='stdin', type=d.T.boolean)]), + withStdin(stdin): { stdin: stdin }, + '#withStdinOnce':: d.fn(help='"Whether the container runtime should close the stdin channel after it has been opened by\\na single attach. When stdin is true the stdin stream will remain open across multiple attach\\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\\nat which time stdin is closed and remains closed until the container is restarted. If this\\nflag is false, a container processes that reads from stdin will never receive an EOF.\\nDefault is false"', args=[d.arg(name='stdinOnce', type=d.T.boolean)]), + withStdinOnce(stdinOnce): { stdinOnce: stdinOnce }, + '#withTerminationMessagePath':: d.fn(help="\"Optional: Path at which the file to which the container's termination message\\nwill be written is mounted into the container's filesystem.\\nMessage written is intended to be brief final status, such as an assertion failure message.\\nWill be truncated by the node if greater than 4096 bytes. The total message length across\\nall containers will be limited to 12kb.\\nDefaults to /dev/termination-log.\\nCannot be updated.\"", args=[d.arg(name='terminationMessagePath', type=d.T.string)]), + withTerminationMessagePath(terminationMessagePath): { terminationMessagePath: terminationMessagePath }, + '#withTerminationMessagePolicy':: d.fn(help='"Indicate how the termination message should be populated. File will use the contents of\\nterminationMessagePath to populate the container status message on both success and failure.\\nFallbackToLogsOnError will use the last chunk of container log output if the termination\\nmessage file is empty and the container exited with an error.\\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\\nDefaults to File.\\nCannot be updated."', args=[d.arg(name='terminationMessagePolicy', type=d.T.string)]), + withTerminationMessagePolicy(terminationMessagePolicy): { terminationMessagePolicy: terminationMessagePolicy }, + '#withTty':: d.fn(help="\"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\\nDefault is false.\"", args=[d.arg(name='tty', type=d.T.boolean)]), + withTty(tty): { tty: tty }, + '#withVolumeDevices':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevices(volumeDevices): { volumeDevices: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeDevicesMixin':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevicesMixin(volumeDevices): { volumeDevices+: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeMounts':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withVolumeMountsMixin':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withWorkingDir':: d.fn(help="\"Container's working directory.\\nIf not specified, the container runtime's default will be used, which\\nmight be configured in the container image.\\nCannot be updated.\"", args=[d.arg(name='workingDir', type=d.T.string)]), + withWorkingDir(workingDir): { workingDir: workingDir }, + }, + '#excludedFromEnforcement':: d.obj(help='"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\\nto be excluded from enforcing a namespace label of origin.\\n\\n\\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true."'), + excludedFromEnforcement: { + '#withGroup':: d.fn(help='"Group of the referent. When not specified, it defaults to `monitoring.coreos.com`"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { group: group }, + '#withName':: d.fn(help='"Name of the referent. When not set, all resources in the namespace are matched."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNamespace':: d.fn(help='"Namespace of the referent.\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + '#withResource':: d.fn(help='"Resource of the referent."', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resource: resource }, + }, + '#hostAliases':: d.obj(help="\"Optional list of hosts and IPs that will be injected into the Pod's\\nhosts file if specified.\""), + hostAliases: { + '#withHostnames':: d.fn(help='"Hostnames for the above IP address."', args=[d.arg(name='hostnames', type=d.T.array)]), + withHostnames(hostnames): { hostnames: if std.isArray(v=hostnames) then hostnames else [hostnames] }, + '#withHostnamesMixin':: d.fn(help='"Hostnames for the above IP address."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='hostnames', type=d.T.array)]), + withHostnamesMixin(hostnames): { hostnames+: if std.isArray(v=hostnames) then hostnames else [hostnames] }, + '#withIp':: d.fn(help='"IP address of the host file entry."', args=[d.arg(name='ip', type=d.T.string)]), + withIp(ip): { ip: ip }, + }, + '#imagePullSecrets':: d.obj(help='"An optional list of references to Secrets in the same namespace\\nto use for pulling images from registries.\\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"'), + imagePullSecrets: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#initContainers':: d.obj(help='"InitContainers allows injecting initContainers to the Pod definition. Those\\ncan be used to e.g. fetch secrets for injection into the Prometheus\\nconfiguration from external sources. Any errors during the execution of\\nan initContainer will lead to a restart of the Pod. More info:\\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nInitContainers described here modify an operator generated init\\ncontainers if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of init container name managed by the operator are:\\n* `init-config-reloader`.\\n\\n\\nOverriding init containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."'), + initContainers: { + '#env':: d.obj(help='"List of environment variables to set in the container.\\nCannot be updated."'), + env: { + '#valueFrom':: d.obj(help="\"Source for the environment variable's value. Cannot be used if value is not empty.\""), + valueFrom: { + '#configMapKeyRef':: d.obj(help='"Selects a key of a ConfigMap."'), + configMapKeyRef: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { configMapKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { configMapKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { configMapKeyRef+: { optional: optional } } }, + }, + '#fieldRef':: d.obj(help="\"Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.\""), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { valueFrom+: { fieldRef+: { apiVersion: apiVersion } } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { valueFrom+: { fieldRef+: { fieldPath: fieldPath } } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { valueFrom+: { resourceFieldRef+: { containerName: containerName } } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { valueFrom+: { resourceFieldRef+: { divisor: divisor } } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { valueFrom+: { resourceFieldRef+: { resource: resource } } }, + }, + '#secretKeyRef':: d.obj(help="\"Selects a key of a secret in the pod's namespace\""), + secretKeyRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { valueFrom+: { secretKeyRef+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { valueFrom+: { secretKeyRef+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { valueFrom+: { secretKeyRef+: { optional: optional } } }, + }, + }, + '#withName':: d.fn(help='"Name of the environment variable. Must be a C_IDENTIFIER."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Variable references $(VAR_NAME) are expanded\\nusing the previously defined environment variables in the container and\\nany service environment variables. If a variable cannot be resolved,\\nthe reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\\n\\"$$(VAR_NAME)\\" will produce the string literal \\"$(VAR_NAME)\\".\\nEscaped references will never be expanded, regardless of whether the variable\\nexists or not.\\nDefaults to \\"\\"."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#envFrom':: d.obj(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."'), + envFrom: { + '#configMapRef':: d.obj(help='"The ConfigMap to select from"'), + configMapRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMapRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMapRef+: { optional: optional } }, + }, + '#secretRef':: d.obj(help='"The Secret to select from"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretRef+: { optional: optional } }, + }, + '#withPrefix':: d.fn(help='"An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER."', args=[d.arg(name='prefix', type=d.T.string)]), + withPrefix(prefix): { prefix: prefix }, + }, + '#lifecycle':: d.obj(help='"Actions that the management system should take in response to container lifecycle events.\\nCannot be updated."'), + lifecycle: { + '#postStart':: d.obj(help='"PostStart is called immediately after a container is created. If the handler fails,\\nthe container is terminated and restarted according to its restart policy.\\nOther management of the container blocks until the hook completes.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks"'), + postStart: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { postStart+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { postStart+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { postStart+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { postStart+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { postStart+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { postStart+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { postStart+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { postStart+: { tcpSocket+: { port: port } } } }, + }, + }, + '#preStop':: d.obj(help="\"PreStop is called immediately before a container is terminated due to an\\nAPI request or management event such as liveness/startup probe failure,\\npreemption, resource contention, etc. The handler is not called if the\\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\\nPreStop hook is executed. Regardless of the outcome of the handler, the\\ncontainer will eventually terminate within the Pod's termination grace\\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\\nor until the termination grace period is reached.\\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks\""), + preStop: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { lifecycle+: { preStop+: { exec+: { command: if std.isArray(v=command) then command else [command] } } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { lifecycle+: { preStop+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { httpGet+: { host: host } } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { lifecycle+: { preStop+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { lifecycle+: { preStop+: { httpGet+: { path: path } } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { httpGet+: { port: port } } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { lifecycle+: { preStop+: { httpGet+: { scheme: scheme } } } }, + }, + '#sleep':: d.obj(help='"Sleep represents the duration that the container should sleep before being terminated."'), + sleep: { + '#withSeconds':: d.fn(help='"Seconds is the number of seconds to sleep."', args=[d.arg(name='seconds', type=d.T.integer)]), + withSeconds(seconds): { lifecycle+: { preStop+: { sleep+: { seconds: seconds } } } }, + }, + '#tcpSocket':: d.obj(help='"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\\nfor the backward compatibility. There are no validation of this field and\\nlifecycle hooks will fail in runtime when tcp handler is specified."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { lifecycle+: { preStop+: { tcpSocket+: { host: host } } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { lifecycle+: { preStop+: { tcpSocket+: { port: port } } } }, + }, + }, + }, + '#livenessProbe':: d.obj(help='"Periodic probe of container liveness.\\nContainer will be restarted if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + livenessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { livenessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { livenessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { livenessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { livenessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { livenessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { livenessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { livenessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { livenessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { livenessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { livenessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { livenessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { livenessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { livenessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { livenessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { livenessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#ports':: d.obj(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."'), + ports: { + '#withContainerPort':: d.fn(help="\"Number of port to expose on the pod's IP address.\\nThis must be a valid port number, 0 \u003c x \u003c 65536.\"", args=[d.arg(name='containerPort', type=d.T.integer)]), + withContainerPort(containerPort): { containerPort: containerPort }, + '#withHostIP':: d.fn(help='"What host IP to bind the external port to."', args=[d.arg(name='hostIP', type=d.T.string)]), + withHostIP(hostIP): { hostIP: hostIP }, + '#withHostPort':: d.fn(help='"Number of port to expose on the host.\\nIf specified, this must be a valid port number, 0 < x < 65536.\\nIf HostNetwork is specified, this must match ContainerPort.\\nMost containers do not need this."', args=[d.arg(name='hostPort', type=d.T.integer)]), + withHostPort(hostPort): { hostPort: hostPort }, + '#withName':: d.fn(help='"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\\nnamed port in a pod must have a unique name. Name for the port that can be\\nreferred to by services."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withProtocol':: d.fn(help='"Protocol for port. Must be UDP, TCP, or SCTP.\\nDefaults to \\"TCP\\"."', args=[d.arg(name='protocol', type=d.T.string)]), + withProtocol(protocol): { protocol: protocol }, + }, + '#readinessProbe':: d.obj(help='"Periodic probe of container service readiness.\\nContainer will be removed from service endpoints if the probe fails.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"'), + readinessProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { readinessProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { readinessProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { readinessProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { readinessProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { readinessProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { readinessProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { readinessProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { readinessProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { readinessProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { readinessProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { readinessProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { readinessProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { readinessProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { readinessProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { readinessProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#resizePolicy':: d.obj(help='"Resources resize policy for the container."'), + resizePolicy: { + '#withResourceName':: d.fn(help='"Name of the resource to which this resource resize policy applies.\\nSupported values: cpu, memory."', args=[d.arg(name='resourceName', type=d.T.string)]), + withResourceName(resourceName): { resourceName: resourceName }, + '#withRestartPolicy':: d.fn(help='"Restart policy to apply when specified resource is resized.\\nIf not specified, it defaults to NotRequired."', args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + }, + '#resources':: d.obj(help='"Compute Resources required by this container.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"'), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { resources+: { limits: limits } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { resources+: { limits+: limits } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { resources+: { requests: requests } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { resources+: { requests+: requests } }, + }, + '#securityContext':: d.obj(help='"SecurityContext defines the security options the container should be run with.\\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/"'), + securityContext: { + '#appArmorProfile':: d.obj(help="\"appArmorProfile is the AppArmor options to use by this container. If set, this profile\\noverrides the pod's appArmorProfile.\\nNote that this field cannot be set when spec.os.name is windows.\""), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { appArmorProfile+: { type: type } } }, + }, + '#capabilities':: d.obj(help='"The capabilities to add/drop when running containers.\\nDefaults to the default set of capabilities granted by the container runtime.\\nNote that this field cannot be set when spec.os.name is windows."'), + capabilities: { + '#withAdd':: d.fn(help='"Added capabilities"', args=[d.arg(name='add', type=d.T.array)]), + withAdd(add): { securityContext+: { capabilities+: { add: if std.isArray(v=add) then add else [add] } } }, + '#withAddMixin':: d.fn(help='"Added capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='add', type=d.T.array)]), + withAddMixin(add): { securityContext+: { capabilities+: { add+: if std.isArray(v=add) then add else [add] } } }, + '#withDrop':: d.fn(help='"Removed capabilities"', args=[d.arg(name='drop', type=d.T.array)]), + withDrop(drop): { securityContext+: { capabilities+: { drop: if std.isArray(v=drop) then drop else [drop] } } }, + '#withDropMixin':: d.fn(help='"Removed capabilities"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='drop', type=d.T.array)]), + withDropMixin(drop): { securityContext+: { capabilities+: { drop+: if std.isArray(v=drop) then drop else [drop] } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to the container.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { securityContext+: { seLinuxOptions+: { level: level } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { securityContext+: { seLinuxOptions+: { role: role } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seLinuxOptions+: { type: type } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { securityContext+: { seLinuxOptions+: { user: user } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by this container. If seccomp options are\\nprovided at both the pod & container level, the container options\\noverride the pod options.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { securityContext+: { seccompProfile+: { type: type } } }, + }, + '#windowsOptions':: d.obj(help='"The Windows specific settings applied to all containers.\\nIf unspecified, the options from the PodSecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux."'), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } }, + }, + '#withAllowPrivilegeEscalation':: d.fn(help='"AllowPrivilegeEscalation controls whether a process can gain more\\nprivileges than its parent process. This bool directly controls if\\nthe no_new_privs flag will be set on the container process.\\nAllowPrivilegeEscalation is true always when the container is:\\n1) run as Privileged\\n2) has CAP_SYS_ADMIN\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='allowPrivilegeEscalation', type=d.T.boolean)]), + withAllowPrivilegeEscalation(allowPrivilegeEscalation): { securityContext+: { allowPrivilegeEscalation: allowPrivilegeEscalation } }, + '#withPrivileged':: d.fn(help='"Run container in privileged mode.\\nProcesses in privileged containers are essentially equivalent to root on the host.\\nDefaults to false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='privileged', type=d.T.boolean)]), + withPrivileged(privileged): { securityContext+: { privileged: privileged } }, + '#withProcMount':: d.fn(help='"procMount denotes the type of proc mount to use for the containers.\\nThe default is DefaultProcMount which uses the container runtime defaults for\\nreadonly paths and masked paths.\\nThis requires the ProcMountType feature flag to be enabled.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='procMount', type=d.T.string)]), + withProcMount(procMount): { securityContext+: { procMount: procMount } }, + '#withReadOnlyRootFilesystem':: d.fn(help='"Whether this container has a read-only root filesystem.\\nDefault is false.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='readOnlyRootFilesystem', type=d.T.boolean)]), + withReadOnlyRootFilesystem(readOnlyRootFilesystem): { securityContext+: { readOnlyRootFilesystem: readOnlyRootFilesystem } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { securityContext+: { runAsGroup: runAsGroup } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { securityContext+: { runAsNonRoot: runAsNonRoot } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { securityContext+: { runAsUser: runAsUser } }, + }, + '#startupProbe':: d.obj(help="\"StartupProbe indicates that the Pod has successfully initialized.\\nIf specified, no other probes are executed until this completes successfully.\\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\\nThis cannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\""), + startupProbe: { + '#exec':: d.obj(help='"Exec specifies the action to take."'), + exec: { + '#withCommand':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { startupProbe+: { exec+: { command: if std.isArray(v=command) then command else [command] } } }, + '#withCommandMixin':: d.fn(help="\"Command is the command line to execute inside the container, the working directory for the\\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\\na shell, you need to explicitly call out to that shell.\\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { startupProbe+: { exec+: { command+: if std.isArray(v=command) then command else [command] } } }, + }, + '#grpc':: d.obj(help='"GRPC specifies an action involving a GRPC port."'), + grpc: { + '#withPort':: d.fn(help='"Port number of the gRPC service. Number must be in the range 1 to 65535."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { startupProbe+: { grpc+: { port: port } } }, + '#withService':: d.fn(help='"Service is the name of the service to place in the gRPC HealthCheckRequest\\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\\n\\n\\nIf this is not specified, the default behavior is defined by gRPC."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { startupProbe+: { grpc+: { service: service } } }, + }, + '#httpGet':: d.obj(help='"HTTPGet specifies the http request to perform."'), + httpGet: { + '#httpHeaders':: d.obj(help='"Custom headers to set in the request. HTTP allows repeated headers."'), + httpHeaders: { + '#withName':: d.fn(help='"The header field name.\\nThis will be canonicalized upon output, so case-variant names will be understood as the same header."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"The header field value"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#withHost':: d.fn(help='"Host name to connect to, defaults to the pod IP. You probably want to set\\n\\"Host\\" in httpHeaders instead."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { httpGet+: { host: host } } }, + '#withHttpHeaders':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeaders(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withHttpHeadersMixin':: d.fn(help='"Custom headers to set in the request. HTTP allows repeated headers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpHeaders', type=d.T.array)]), + withHttpHeadersMixin(httpHeaders): { startupProbe+: { httpGet+: { httpHeaders+: if std.isArray(v=httpHeaders) then httpHeaders else [httpHeaders] } } }, + '#withPath':: d.fn(help='"Path to access on the HTTP server."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { startupProbe+: { httpGet+: { path: path } } }, + '#withPort':: d.fn(help='"Name or number of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { httpGet+: { port: port } } }, + '#withScheme':: d.fn(help='"Scheme to use for connecting to the host.\\nDefaults to HTTP."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { startupProbe+: { httpGet+: { scheme: scheme } } }, + }, + '#tcpSocket':: d.obj(help='"TCPSocket specifies an action involving a TCP port."'), + tcpSocket: { + '#withHost':: d.fn(help='"Optional: Host name to connect to, defaults to the pod IP."', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { startupProbe+: { tcpSocket+: { host: host } } }, + '#withPort':: d.fn(help='"Number or name of the port to access on the container.\\nNumber must be in the range 1 to 65535.\\nName must be an IANA_SVC_NAME."', args=[d.arg(name='port', type=d.T.any)]), + withPort(port): { startupProbe+: { tcpSocket+: { port: port } } }, + }, + '#withFailureThreshold':: d.fn(help='"Minimum consecutive failures for the probe to be considered failed after having succeeded.\\nDefaults to 3. Minimum value is 1."', args=[d.arg(name='failureThreshold', type=d.T.integer)]), + withFailureThreshold(failureThreshold): { startupProbe+: { failureThreshold: failureThreshold } }, + '#withInitialDelaySeconds':: d.fn(help='"Number of seconds after the container has started before liveness probes are initiated.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='initialDelaySeconds', type=d.T.integer)]), + withInitialDelaySeconds(initialDelaySeconds): { startupProbe+: { initialDelaySeconds: initialDelaySeconds } }, + '#withPeriodSeconds':: d.fn(help='"How often (in seconds) to perform the probe.\\nDefault to 10 seconds. Minimum value is 1."', args=[d.arg(name='periodSeconds', type=d.T.integer)]), + withPeriodSeconds(periodSeconds): { startupProbe+: { periodSeconds: periodSeconds } }, + '#withSuccessThreshold':: d.fn(help='"Minimum consecutive successes for the probe to be considered successful after having failed.\\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1."', args=[d.arg(name='successThreshold', type=d.T.integer)]), + withSuccessThreshold(successThreshold): { startupProbe+: { successThreshold: successThreshold } }, + '#withTerminationGracePeriodSeconds':: d.fn(help="\"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\\nThe grace period is the duration in seconds after the processes running in the pod are sent\\na termination signal and the time when the processes are forcibly halted with a kill signal.\\nSet this value longer than the expected cleanup time for your process.\\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\\nvalue overrides the value provided by the pod spec.\\nValue must be non-negative integer. The value zero indicates stop immediately via\\nthe kill signal (no opportunity to shut down).\\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.\"", args=[d.arg(name='terminationGracePeriodSeconds', type=d.T.integer)]), + withTerminationGracePeriodSeconds(terminationGracePeriodSeconds): { startupProbe+: { terminationGracePeriodSeconds: terminationGracePeriodSeconds } }, + '#withTimeoutSeconds':: d.fn(help='"Number of seconds after which the probe times out.\\nDefaults to 1 second. Minimum value is 1.\\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes"', args=[d.arg(name='timeoutSeconds', type=d.T.integer)]), + withTimeoutSeconds(timeoutSeconds): { startupProbe+: { timeoutSeconds: timeoutSeconds } }, + }, + '#volumeDevices':: d.obj(help='"volumeDevices is the list of block devices to be used by the container."'), + volumeDevices: { + '#withDevicePath':: d.fn(help='"devicePath is the path inside of the container that the device will be mapped to."', args=[d.arg(name='devicePath', type=d.T.string)]), + withDevicePath(devicePath): { devicePath: devicePath }, + '#withName':: d.fn(help='"name must match the name of a persistentVolumeClaim in the pod"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#volumeMounts':: d.obj(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#withArgs':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='args', type=d.T.array)]), + withArgs(args): { args: if std.isArray(v=args) then args else [args] }, + '#withArgsMixin':: d.fn(help="\"Arguments to the entrypoint.\\nThe container image's CMD is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='args', type=d.T.array)]), + withArgsMixin(args): { args+: if std.isArray(v=args) then args else [args] }, + '#withCommand':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"", args=[d.arg(name='command', type=d.T.array)]), + withCommand(command): { command: if std.isArray(v=command) then command else [command] }, + '#withCommandMixin':: d.fn(help="\"Entrypoint array. Not executed within a shell.\\nThe container image's ENTRYPOINT is used if this is not provided.\\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \\\"$$(VAR_NAME)\\\" will\\nproduce the string literal \\\"$(VAR_NAME)\\\". Escaped references will never be expanded, regardless\\nof whether the variable exists or not. Cannot be updated.\\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='command', type=d.T.array)]), + withCommandMixin(command): { command+: if std.isArray(v=command) then command else [command] }, + '#withEnv':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."', args=[d.arg(name='env', type=d.T.array)]), + withEnv(env): { env: if std.isArray(v=env) then env else [env] }, + '#withEnvFrom':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFrom(envFrom): { envFrom: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvFromMixin':: d.fn(help='"List of sources to populate environment variables in the container.\\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\\nwill be reported as an event when the container is starting. When a key exists in multiple\\nsources, the value associated with the last source will take precedence.\\nValues defined by an Env with a duplicate key will take precedence.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='envFrom', type=d.T.array)]), + withEnvFromMixin(envFrom): { envFrom+: if std.isArray(v=envFrom) then envFrom else [envFrom] }, + '#withEnvMixin':: d.fn(help='"List of environment variables to set in the container.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='env', type=d.T.array)]), + withEnvMixin(env): { env+: if std.isArray(v=env) then env else [env] }, + '#withImage':: d.fn(help='"Container image name.\\nMore info: https://kubernetes.io/docs/concepts/containers/images\\nThis field is optional to allow higher level config management to default or override\\ncontainer images in workload controllers like Deployments and StatefulSets."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { image: image }, + '#withImagePullPolicy':: d.fn(help='"Image pull policy.\\nOne of Always, Never, IfNotPresent.\\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\\nCannot be updated.\\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images"', args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { imagePullPolicy: imagePullPolicy }, + '#withName':: d.fn(help='"Name of the container specified as a DNS_LABEL.\\nEach container in a pod must have a unique name (DNS_LABEL).\\nCannot be updated."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withPorts':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."', args=[d.arg(name='ports', type=d.T.array)]), + withPorts(ports): { ports: if std.isArray(v=ports) then ports else [ports] }, + '#withPortsMixin':: d.fn(help='"List of ports to expose from the container. Not specifying a port here\\nDOES NOT prevent that port from being exposed. Any port which is\\nlistening on the default \\"0.0.0.0\\" address inside a container will be\\naccessible from the network.\\nModifying this array with strategic merge patch may corrupt the data.\\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\\nCannot be updated."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ports', type=d.T.array)]), + withPortsMixin(ports): { ports+: if std.isArray(v=ports) then ports else [ports] }, + '#withResizePolicy':: d.fn(help='"Resources resize policy for the container."', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicy(resizePolicy): { resizePolicy: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withResizePolicyMixin':: d.fn(help='"Resources resize policy for the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='resizePolicy', type=d.T.array)]), + withResizePolicyMixin(resizePolicy): { resizePolicy+: if std.isArray(v=resizePolicy) then resizePolicy else [resizePolicy] }, + '#withRestartPolicy':: d.fn(help="\"RestartPolicy defines the restart behavior of individual containers in a pod.\\nThis field may only be set for init containers, and the only allowed value is \\\"Always\\\".\\nFor non-init containers or when this field is not specified,\\nthe restart behavior is defined by the Pod's restart policy and the container type.\\nSetting the RestartPolicy as \\\"Always\\\" for the init container will have the following effect:\\nthis init container will be continually restarted on\\nexit until all regular containers have terminated. Once all regular\\ncontainers have completed, all init containers with restartPolicy \\\"Always\\\"\\nwill be shut down. This lifecycle differs from normal init containers and\\nis often referred to as a \\\"sidecar\\\" container. Although this init\\ncontainer still starts in the init container sequence, it does not wait\\nfor the container to complete before proceeding to the next init\\ncontainer. Instead, the next init container starts immediately after this\\ninit container is started, or after any startupProbe has successfully\\ncompleted.\"", args=[d.arg(name='restartPolicy', type=d.T.string)]), + withRestartPolicy(restartPolicy): { restartPolicy: restartPolicy }, + '#withStdin':: d.fn(help='"Whether this container should allocate a buffer for stdin in the container runtime. If this\\nis not set, reads from stdin in the container will always result in EOF.\\nDefault is false."', args=[d.arg(name='stdin', type=d.T.boolean)]), + withStdin(stdin): { stdin: stdin }, + '#withStdinOnce':: d.fn(help='"Whether the container runtime should close the stdin channel after it has been opened by\\na single attach. When stdin is true the stdin stream will remain open across multiple attach\\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\\nat which time stdin is closed and remains closed until the container is restarted. If this\\nflag is false, a container processes that reads from stdin will never receive an EOF.\\nDefault is false"', args=[d.arg(name='stdinOnce', type=d.T.boolean)]), + withStdinOnce(stdinOnce): { stdinOnce: stdinOnce }, + '#withTerminationMessagePath':: d.fn(help="\"Optional: Path at which the file to which the container's termination message\\nwill be written is mounted into the container's filesystem.\\nMessage written is intended to be brief final status, such as an assertion failure message.\\nWill be truncated by the node if greater than 4096 bytes. The total message length across\\nall containers will be limited to 12kb.\\nDefaults to /dev/termination-log.\\nCannot be updated.\"", args=[d.arg(name='terminationMessagePath', type=d.T.string)]), + withTerminationMessagePath(terminationMessagePath): { terminationMessagePath: terminationMessagePath }, + '#withTerminationMessagePolicy':: d.fn(help='"Indicate how the termination message should be populated. File will use the contents of\\nterminationMessagePath to populate the container status message on both success and failure.\\nFallbackToLogsOnError will use the last chunk of container log output if the termination\\nmessage file is empty and the container exited with an error.\\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\\nDefaults to File.\\nCannot be updated."', args=[d.arg(name='terminationMessagePolicy', type=d.T.string)]), + withTerminationMessagePolicy(terminationMessagePolicy): { terminationMessagePolicy: terminationMessagePolicy }, + '#withTty':: d.fn(help="\"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\\nDefault is false.\"", args=[d.arg(name='tty', type=d.T.boolean)]), + withTty(tty): { tty: tty }, + '#withVolumeDevices':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevices(volumeDevices): { volumeDevices: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeDevicesMixin':: d.fn(help='"volumeDevices is the list of block devices to be used by the container."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumeDevices', type=d.T.array)]), + withVolumeDevicesMixin(volumeDevices): { volumeDevices+: if std.isArray(v=volumeDevices) then volumeDevices else [volumeDevices] }, + '#withVolumeMounts':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withVolumeMountsMixin':: d.fn(help="\"Pod volumes to mount into the container's filesystem.\\nCannot be updated.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] }, + '#withWorkingDir':: d.fn(help="\"Container's working directory.\\nIf not specified, the container runtime's default will be used, which\\nmight be configured in the container image.\\nCannot be updated.\"", args=[d.arg(name='workingDir', type=d.T.string)]), + withWorkingDir(workingDir): { workingDir: workingDir }, + }, + '#persistentVolumeClaimRetentionPolicy':: d.obj(help='"The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\\nThe default behavior is all PVCs are retained.\\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\\nIt requires enabling the StatefulSetAutoDeletePVC feature gate."'), + persistentVolumeClaimRetentionPolicy: { + '#withWhenDeleted':: d.fn(help='"WhenDeleted specifies what happens to PVCs created from StatefulSet\\nVolumeClaimTemplates when the StatefulSet is deleted. The default policy\\nof `Retain` causes PVCs to not be affected by StatefulSet deletion. The\\n`Delete` policy causes those PVCs to be deleted."', args=[d.arg(name='whenDeleted', type=d.T.string)]), + withWhenDeleted(whenDeleted): { spec+: { persistentVolumeClaimRetentionPolicy+: { whenDeleted: whenDeleted } } }, + '#withWhenScaled':: d.fn(help='"WhenScaled specifies what happens to PVCs created from StatefulSet\\nVolumeClaimTemplates when the StatefulSet is scaled down. The default\\npolicy of `Retain` causes PVCs to not be affected by a scaledown. The\\n`Delete` policy causes the associated PVCs for any excess pods above\\nthe replica count to be deleted."', args=[d.arg(name='whenScaled', type=d.T.string)]), + withWhenScaled(whenScaled): { spec+: { persistentVolumeClaimRetentionPolicy+: { whenScaled: whenScaled } } }, + }, + '#podMetadata':: d.obj(help='"PodMetadata configures labels and annotations which are propagated to the Prometheus pods.\\n\\n\\nThe following items are reserved and cannot be overridden:\\n* \\"prometheus\\" label, set to the name of the Prometheus object.\\n* \\"app.kubernetes.io/instance\\" label, set to the name of the Prometheus object.\\n* \\"app.kubernetes.io/managed-by\\" label, set to \\"prometheus-operator\\".\\n* \\"app.kubernetes.io/name\\" label, set to \\"prometheus\\".\\n* \\"app.kubernetes.io/version\\" label, set to the Prometheus version.\\n* \\"operator.prometheus.io/name\\" label, set to the name of the Prometheus object.\\n* \\"operator.prometheus.io/shard\\" label, set to the shard number of the Prometheus object.\\n* \\"kubectl.kubernetes.io/default-container\\" annotation, set to \\"prometheus\\"."'), + podMetadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { podMetadata+: { annotations: annotations } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { podMetadata+: { annotations+: annotations } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { podMetadata+: { labels: labels } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { podMetadata+: { labels+: labels } } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although\\nsome resources may allow a client to request the generation of an appropriate name\\nautomatically. Name is primarily intended for creation idempotence and configuration\\ndefinition.\\nCannot be updated.\\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { podMetadata+: { name: name } } }, + }, + '#podMonitorNamespaceSelector':: d.obj(help='"Namespaces to match for PodMonitors discovery. An empty label selector\\nmatches all namespaces. A null label selector (default value) matches the current\\nnamespace only."'), + podMonitorNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { podMonitorNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { podMonitorNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { podMonitorNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { podMonitorNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#podMonitorSelector':: d.obj(help="\"PodMonitors to be selected for target discovery. An empty label selector\\nmatches all objects. A null label selector matches no objects.\\n\\n\\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\\nThe Prometheus operator will ensure that the Prometheus configuration's\\nSecret exists, but it is the responsibility of the user to provide the raw\\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\\nThis behavior is *deprecated* and will be removed in the next major version\\nof the custom resource definition. It is recommended to use\\n`spec.additionalScrapeConfigs` instead.\""), + podMonitorSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { podMonitorSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { podMonitorSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { podMonitorSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { podMonitorSelector+: { matchLabels+: matchLabels } } }, + }, + '#probeNamespaceSelector':: d.obj(help='"Namespaces to match for Probe discovery. An empty label\\nselector matches all namespaces. A null label selector matches the\\ncurrent namespace only."'), + probeNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { probeNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { probeNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { probeNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { probeNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#probeSelector':: d.obj(help="\"Probes to be selected for target discovery. An empty label selector\\nmatches all objects. A null label selector matches no objects.\\n\\n\\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\\nThe Prometheus operator will ensure that the Prometheus configuration's\\nSecret exists, but it is the responsibility of the user to provide the raw\\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\\nThis behavior is *deprecated* and will be removed in the next major version\\nof the custom resource definition. It is recommended to use\\n`spec.additionalScrapeConfigs` instead.\""), + probeSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { probeSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { probeSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { probeSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { probeSelector+: { matchLabels+: matchLabels } } }, + }, + '#remoteWrite':: d.obj(help='"Defines the list of remote write configurations."'), + remoteWrite: { + '#authorization':: d.obj(help='"Authorization section for the URL.\\n\\n\\nIt requires Prometheus >= v2.26.0.\\n\\n\\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withCredentialsFile':: d.fn(help='"File to read a secret from, mutually exclusive with `credentials`."', args=[d.arg(name='credentialsFile', type=d.T.string)]), + withCredentialsFile(credentialsFile): { authorization+: { credentialsFile: credentialsFile } }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#azureAd':: d.obj(help='"AzureAD for the URL.\\n\\n\\nIt requires Prometheus >= v2.45.0.\\n\\n\\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`."'), + azureAd: { + '#managedIdentity':: d.obj(help='"ManagedIdentity defines the Azure User-assigned Managed identity.\\nCannot be set at the same time as `oauth` or `sdk`."'), + managedIdentity: { + '#withClientId':: d.fn(help='"The client id"', args=[d.arg(name='clientId', type=d.T.string)]), + withClientId(clientId): { azureAd+: { managedIdentity+: { clientId: clientId } } }, + }, + '#oauth':: d.obj(help='"OAuth defines the oauth config that is being used to authenticate.\\nCannot be set at the same time as `managedIdentity` or `sdk`.\\n\\n\\nIt requires Prometheus >= v2.48.0."'), + oauth: { + '#clientSecret':: d.obj(help='"`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate."'), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { azureAd+: { oauth+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { azureAd+: { oauth+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { azureAd+: { oauth+: { clientSecret+: { optional: optional } } } }, + }, + '#withClientId':: d.fn(help='"`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate."', args=[d.arg(name='clientId', type=d.T.string)]), + withClientId(clientId): { azureAd+: { oauth+: { clientId: clientId } } }, + '#withTenantId':: d.fn(help='"`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate."', args=[d.arg(name='tenantId', type=d.T.string)]), + withTenantId(tenantId): { azureAd+: { oauth+: { tenantId: tenantId } } }, + }, + '#sdk':: d.obj(help='"SDK defines the Azure SDK config that is being used to authenticate.\\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\\nCannot be set at the same time as `oauth` or `managedIdentity`.\\n\\n\\nIt requires Prometheus >= 2.52.0."'), + sdk: { + '#withTenantId':: d.fn(help='"`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate."', args=[d.arg(name='tenantId', type=d.T.string)]), + withTenantId(tenantId): { azureAd+: { sdk+: { tenantId: tenantId } } }, + }, + '#withCloud':: d.fn(help="\"The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.\"", args=[d.arg(name='cloud', type=d.T.string)]), + withCloud(cloud): { azureAd+: { cloud: cloud } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth configuration for the URL.\\n\\n\\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#metadataConfig':: d.obj(help='"MetadataConfig configures the sending of series metadata to the remote storage."'), + metadataConfig: { + '#withSend':: d.fn(help='"Defines whether metric metadata is sent to the remote storage or not."', args=[d.arg(name='send', type=d.T.boolean)]), + withSend(send): { metadataConfig+: { send: send } }, + '#withSendInterval':: d.fn(help='"Defines how frequently metric metadata is sent to the remote storage."', args=[d.arg(name='sendInterval', type=d.T.string)]), + withSendInterval(sendInterval): { metadataConfig+: { sendInterval: sendInterval } }, + }, + '#oauth2':: d.obj(help='"OAuth2 configuration for the URL.\\n\\n\\nIt requires Prometheus >= v2.27.0.\\n\\n\\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#queueConfig':: d.obj(help='"QueueConfig allows tuning of the remote write queue parameters."'), + queueConfig: { + '#withBatchSendDeadline':: d.fn(help='"BatchSendDeadline is the maximum time a sample will wait in buffer."', args=[d.arg(name='batchSendDeadline', type=d.T.string)]), + withBatchSendDeadline(batchSendDeadline): { queueConfig+: { batchSendDeadline: batchSendDeadline } }, + '#withCapacity':: d.fn(help='"Capacity is the number of samples to buffer per shard before we start\\ndropping them."', args=[d.arg(name='capacity', type=d.T.integer)]), + withCapacity(capacity): { queueConfig+: { capacity: capacity } }, + '#withMaxBackoff':: d.fn(help='"MaxBackoff is the maximum retry delay."', args=[d.arg(name='maxBackoff', type=d.T.string)]), + withMaxBackoff(maxBackoff): { queueConfig+: { maxBackoff: maxBackoff } }, + '#withMaxRetries':: d.fn(help='"MaxRetries is the maximum number of times to retry a batch on recoverable errors."', args=[d.arg(name='maxRetries', type=d.T.integer)]), + withMaxRetries(maxRetries): { queueConfig+: { maxRetries: maxRetries } }, + '#withMaxSamplesPerSend':: d.fn(help='"MaxSamplesPerSend is the maximum number of samples per send."', args=[d.arg(name='maxSamplesPerSend', type=d.T.integer)]), + withMaxSamplesPerSend(maxSamplesPerSend): { queueConfig+: { maxSamplesPerSend: maxSamplesPerSend } }, + '#withMaxShards':: d.fn(help='"MaxShards is the maximum number of shards, i.e. amount of concurrency."', args=[d.arg(name='maxShards', type=d.T.integer)]), + withMaxShards(maxShards): { queueConfig+: { maxShards: maxShards } }, + '#withMinBackoff':: d.fn(help='"MinBackoff is the initial retry delay. Gets doubled for every retry."', args=[d.arg(name='minBackoff', type=d.T.string)]), + withMinBackoff(minBackoff): { queueConfig+: { minBackoff: minBackoff } }, + '#withMinShards':: d.fn(help='"MinShards is the minimum number of shards, i.e. amount of concurrency."', args=[d.arg(name='minShards', type=d.T.integer)]), + withMinShards(minShards): { queueConfig+: { minShards: minShards } }, + '#withRetryOnRateLimit':: d.fn(help='"Retry upon receiving a 429 status code from the remote-write storage.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."', args=[d.arg(name='retryOnRateLimit', type=d.T.boolean)]), + withRetryOnRateLimit(retryOnRateLimit): { queueConfig+: { retryOnRateLimit: retryOnRateLimit } }, + '#withSampleAgeLimit':: d.fn(help='"SampleAgeLimit drops samples older than the limit.\\nIt requires Prometheus >= v2.50.0."', args=[d.arg(name='sampleAgeLimit', type=d.T.string)]), + withSampleAgeLimit(sampleAgeLimit): { queueConfig+: { sampleAgeLimit: sampleAgeLimit } }, + }, + '#sigv4':: d.obj(help="\"Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\\n\\n\\nIt requires Prometheus \u003e= v2.26.0.\\n\\n\\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.\""), + sigv4: { + '#accessKey':: d.obj(help='"AccessKey is the AWS API key. If not specified, the environment variable\\n`AWS_ACCESS_KEY_ID` is used."'), + accessKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { sigv4+: { accessKey+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { sigv4+: { accessKey+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { sigv4+: { accessKey+: { optional: optional } } }, + }, + '#secretKey':: d.obj(help='"SecretKey is the AWS API secret. If not specified, the environment\\nvariable `AWS_SECRET_ACCESS_KEY` is used."'), + secretKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { sigv4+: { secretKey+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { sigv4+: { secretKey+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { sigv4+: { secretKey+: { optional: optional } } }, + }, + '#withProfile':: d.fn(help='"Profile is the named AWS profile used to authenticate."', args=[d.arg(name='profile', type=d.T.string)]), + withProfile(profile): { sigv4+: { profile: profile } }, + '#withRegion':: d.fn(help='"Region is the AWS region. If blank, the region from the default credentials chain used."', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { sigv4+: { region: region } }, + '#withRoleArn':: d.fn(help='"RoleArn is the named AWS profile used to authenticate."', args=[d.arg(name='roleArn', type=d.T.string)]), + withRoleArn(roleArn): { sigv4+: { roleArn: roleArn } }, + }, + '#tlsConfig':: d.obj(help='"TLS Config to use for the URL."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { tlsConfig+: { caFile: caFile } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { tlsConfig+: { certFile: certFile } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { tlsConfig+: { keyFile: keyFile } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withBearerToken':: d.fn(help="\"*Warning: this field shouldn't be used because the token value appears\\nin clear-text. Prefer using `authorization`.*\\n\\n\\nDeprecated: this will be removed in a future release.\"", args=[d.arg(name='bearerToken', type=d.T.string)]), + withBearerToken(bearerToken): { bearerToken: bearerToken }, + '#withBearerTokenFile':: d.fn(help='"File from which to read bearer token for the URL.\\n\\n\\nDeprecated: this will be removed in a future release. Prefer using `authorization`."', args=[d.arg(name='bearerTokenFile', type=d.T.string)]), + withBearerTokenFile(bearerTokenFile): { bearerTokenFile: bearerTokenFile }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects.\\n\\n\\nIt requires Prometheus >= v2.26.0."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withHeaders':: d.fn(help="\"Custom HTTP headers to be sent along with each remote write request.\\nBe aware that headers that are set by Prometheus itself can't be overwritten.\\n\\n\\nIt requires Prometheus \u003e= v2.25.0.\"", args=[d.arg(name='headers', type=d.T.object)]), + withHeaders(headers): { headers: headers }, + '#withHeadersMixin':: d.fn(help="\"Custom HTTP headers to be sent along with each remote write request.\\nBe aware that headers that are set by Prometheus itself can't be overwritten.\\n\\n\\nIt requires Prometheus \u003e= v2.25.0.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='headers', type=d.T.object)]), + withHeadersMixin(headers): { headers+: headers }, + '#withName':: d.fn(help='"The name of the remote write queue, it must be unique if specified. The\\nname is used in metrics and logging in order to differentiate queues.\\n\\n\\nIt requires Prometheus >= v2.15.0."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRemoteTimeout':: d.fn(help='"Timeout for requests to the remote write endpoint."', args=[d.arg(name='remoteTimeout', type=d.T.string)]), + withRemoteTimeout(remoteTimeout): { remoteTimeout: remoteTimeout }, + '#withSendExemplars':: d.fn(help='"Enables sending of exemplars over remote write. Note that\\nexemplar-storage itself must be enabled using the `spec.enableFeature`\\noption for exemplars to be scraped in the first place.\\n\\n\\nIt requires Prometheus >= v2.27.0."', args=[d.arg(name='sendExemplars', type=d.T.boolean)]), + withSendExemplars(sendExemplars): { sendExemplars: sendExemplars }, + '#withSendNativeHistograms':: d.fn(help='"Enables sending of native histograms, also known as sparse histograms\\nover remote write.\\n\\n\\nIt requires Prometheus >= v2.40.0."', args=[d.arg(name='sendNativeHistograms', type=d.T.boolean)]), + withSendNativeHistograms(sendNativeHistograms): { sendNativeHistograms: sendNativeHistograms }, + '#withUrl':: d.fn(help='"The URL of the endpoint to send samples to."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { url: url }, + '#withWriteRelabelConfigs':: d.fn(help='"The list of remote write relabel configurations."', args=[d.arg(name='writeRelabelConfigs', type=d.T.array)]), + withWriteRelabelConfigs(writeRelabelConfigs): { writeRelabelConfigs: if std.isArray(v=writeRelabelConfigs) then writeRelabelConfigs else [writeRelabelConfigs] }, + '#withWriteRelabelConfigsMixin':: d.fn(help='"The list of remote write relabel configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='writeRelabelConfigs', type=d.T.array)]), + withWriteRelabelConfigsMixin(writeRelabelConfigs): { writeRelabelConfigs+: if std.isArray(v=writeRelabelConfigs) then writeRelabelConfigs else [writeRelabelConfigs] }, + '#writeRelabelConfigs':: d.obj(help='"The list of remote write relabel configurations."'), + writeRelabelConfigs: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + }, + '#resources':: d.obj(help="\"Defines the resources requests and limits of the 'prometheus' container.\""), + resources: { + '#claims':: d.obj(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."'), + claims: { + '#withName':: d.fn(help='"Name must match the name of one entry in pod.spec.resourceClaims of\\nthe Pod where this field is used. It makes that resource available\\ninside a container."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#withClaims':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."', args=[d.arg(name='claims', type=d.T.array)]), + withClaims(claims): { spec+: { resources+: { claims: if std.isArray(v=claims) then claims else [claims] } } }, + '#withClaimsMixin':: d.fn(help='"Claims lists the names of resources, defined in spec.resourceClaims,\\nthat are used by this container.\\n\\n\\nThis is an alpha field and requires enabling the\\nDynamicResourceAllocation feature gate.\\n\\n\\nThis field is immutable. It can only be set for containers."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='claims', type=d.T.array)]), + withClaimsMixin(claims): { spec+: { resources+: { claims+: if std.isArray(v=claims) then claims else [claims] } } }, + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { resources+: { limits: limits } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { resources+: { limits+: limits } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { resources+: { requests: requests } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { resources+: { requests+: requests } } }, + }, + '#scrapeClasses':: d.obj(help='"List of scrape classes to expose to scraping objects such as\\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."'), + scrapeClasses: { + '#attachMetadata':: d.obj(help='"AttachMetadata configures additional metadata to the discovered targets.\\nWhen the scrape object defines its own configuration, it takes\\nprecedence over the scrape class configuration."'), + attachMetadata: { + '#withNode':: d.fn(help='"When set to true, Prometheus attaches node metadata to the discovered\\ntargets.\\n\\n\\nThe Prometheus service account must have the `list` and `watch`\\npermissions on the `Nodes` objects."', args=[d.arg(name='node', type=d.T.boolean)]), + withNode(node): { attachMetadata+: { node: node } }, + }, + '#metricRelabelings':: d.obj(help="\"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\\n\\n\\nThe Operator adds the scrape class metric relabelings defined here.\\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs\""), + metricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#relabelings':: d.obj(help='"Relabelings configures the relabeling rules to apply to all scrape targets.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\\nThen the Operator adds the scrape class relabelings defined here.\\nThen the Operator adds the target-specific relabelings defined in the scrape object.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"'), + relabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#tlsConfig':: d.obj(help='"TLSConfig defines the TLS settings to use for the scrape. When the\\nscrape objects define their own CA, certificate and/or key, they take\\nprecedence over the corresponding scrape class fields.\\n\\n\\nFor now only the `caFile`, `certFile` and `keyFile` fields are supported."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { tlsConfig+: { caFile: caFile } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { tlsConfig+: { certFile: certFile } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { tlsConfig+: { keyFile: keyFile } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withDefault':: d.fn(help="\"Default indicates that the scrape applies to all scrape objects that\\ndon't configure an explicit scrape class name.\\n\\n\\nOnly one scrape class can be set as the default.\"", args=[d.arg(name='default', type=d.T.boolean)]), + withDefault(default): { default: default }, + '#withMetricRelabelings':: d.fn(help="\"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\\n\\n\\nThe Operator adds the scrape class metric relabelings defined here.\\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs\"", args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelings(metricRelabelings): { metricRelabelings: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] }, + '#withMetricRelabelingsMixin':: d.fn(help="\"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\\n\\n\\nThe Operator adds the scrape class metric relabelings defined here.\\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelingsMixin(metricRelabelings): { metricRelabelings+: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] }, + '#withName':: d.fn(help='"Name of the scrape class."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withRelabelings':: d.fn(help='"Relabelings configures the relabeling rules to apply to all scrape targets.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\\nThen the Operator adds the scrape class relabelings defined here.\\nThen the Operator adds the target-specific relabelings defined in the scrape object.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"', args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelings(relabelings): { relabelings: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + '#withRelabelingsMixin':: d.fn(help='"Relabelings configures the relabeling rules to apply to all scrape targets.\\n\\n\\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\\nThen the Operator adds the scrape class relabelings defined here.\\nThen the Operator adds the target-specific relabelings defined in the scrape object.\\n\\n\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelingsMixin(relabelings): { relabelings+: if std.isArray(v=relabelings) then relabelings else [relabelings] }, + }, + '#scrapeConfigNamespaceSelector':: d.obj(help='"Namespaces to match for ScrapeConfig discovery. An empty label selector\\nmatches all namespaces. A null label selector matches the current\\nnamespace only.\\n\\n\\nNote that the ScrapeConfig custom resource definition is currently at Alpha level."'), + scrapeConfigNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { scrapeConfigNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { scrapeConfigNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { scrapeConfigNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { scrapeConfigNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#scrapeConfigSelector':: d.obj(help="\"ScrapeConfigs to be selected for target discovery. An empty label\\nselector matches all objects. A null label selector matches no objects.\\n\\n\\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\\nThe Prometheus operator will ensure that the Prometheus configuration's\\nSecret exists, but it is the responsibility of the user to provide the raw\\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\\nThis behavior is *deprecated* and will be removed in the next major version\\nof the custom resource definition. It is recommended to use\\n`spec.additionalScrapeConfigs` instead.\\n\\n\\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.\""), + scrapeConfigSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { scrapeConfigSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { scrapeConfigSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { scrapeConfigSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { scrapeConfigSelector+: { matchLabels+: matchLabels } } }, + }, + '#securityContext':: d.obj(help='"SecurityContext holds pod-level security attributes and common container settings.\\nThis defaults to the default PodSecurityContext."'), + securityContext: { + '#appArmorProfile':: d.obj(help='"appArmorProfile is the AppArmor options to use by the containers in this pod.\\nNote that this field cannot be set when spec.os.name is windows."'), + appArmorProfile: { + '#withLocalhostProfile':: d.fn(help='"localhostProfile indicates a profile loaded on the node that should be used.\\nThe profile must be preconfigured on the node to work.\\nMust match the loaded name of the profile.\\nMust be set if and only if type is \\"Localhost\\"."', args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { securityContext+: { appArmorProfile+: { localhostProfile: localhostProfile } } } }, + '#withType':: d.fn(help="\"type indicates which kind of AppArmor profile will be applied.\\nValid options are:\\n Localhost - a profile pre-loaded on the node.\\n RuntimeDefault - the container runtime's default profile.\\n Unconfined - no AppArmor enforcement.\"", args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { appArmorProfile+: { type: type } } } }, + }, + '#seLinuxOptions':: d.obj(help='"The SELinux context to be applied to all containers.\\nIf unspecified, the container runtime will allocate a random SELinux context for each\\ncontainer. May also be set in SecurityContext. If set in\\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\\ntakes precedence for that container.\\nNote that this field cannot be set when spec.os.name is windows."'), + seLinuxOptions: { + '#withLevel':: d.fn(help='"Level is SELinux level label that applies to the container."', args=[d.arg(name='level', type=d.T.string)]), + withLevel(level): { spec+: { securityContext+: { seLinuxOptions+: { level: level } } } }, + '#withRole':: d.fn(help='"Role is a SELinux role label that applies to the container."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { spec+: { securityContext+: { seLinuxOptions+: { role: role } } } }, + '#withType':: d.fn(help='"Type is a SELinux type label that applies to the container."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { seLinuxOptions+: { type: type } } } }, + '#withUser':: d.fn(help='"User is a SELinux user label that applies to the container."', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { spec+: { securityContext+: { seLinuxOptions+: { user: user } } } }, + }, + '#seccompProfile':: d.obj(help='"The seccomp options to use by the containers in this pod.\\nNote that this field cannot be set when spec.os.name is windows."'), + seccompProfile: { + '#withLocalhostProfile':: d.fn(help="\"localhostProfile indicates a profile defined in a file on the node should be used.\\nThe profile must be preconfigured on the node to work.\\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\\nMust be set if type is \\\"Localhost\\\". Must NOT be set for any other type.\"", args=[d.arg(name='localhostProfile', type=d.T.string)]), + withLocalhostProfile(localhostProfile): { spec+: { securityContext+: { seccompProfile+: { localhostProfile: localhostProfile } } } }, + '#withType':: d.fn(help='"type indicates which kind of seccomp profile will be applied.\\nValid options are:\\n\\n\\nLocalhost - a profile defined in a file on the node should be used.\\nRuntimeDefault - the container runtime default profile should be used.\\nUnconfined - no profile should be applied."', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { securityContext+: { seccompProfile+: { type: type } } } }, + }, + '#sysctls':: d.obj(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."'), + sysctls: { + '#withName':: d.fn(help='"Name of a property to set"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValue':: d.fn(help='"Value of a property to set"', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#windowsOptions':: d.obj(help="\"The Windows specific settings applied to all containers.\\nIf unspecified, the options within a container's SecurityContext will be used.\\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\\nNote that this field cannot be set when spec.os.name is linux.\""), + windowsOptions: { + '#withGmsaCredentialSpec':: d.fn(help='"GMSACredentialSpec is where the GMSA admission webhook\\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\\nGMSA credential spec named by the GMSACredentialSpecName field."', args=[d.arg(name='gmsaCredentialSpec', type=d.T.string)]), + withGmsaCredentialSpec(gmsaCredentialSpec): { spec+: { securityContext+: { windowsOptions+: { gmsaCredentialSpec: gmsaCredentialSpec } } } }, + '#withGmsaCredentialSpecName':: d.fn(help='"GMSACredentialSpecName is the name of the GMSA credential spec to use."', args=[d.arg(name='gmsaCredentialSpecName', type=d.T.string)]), + withGmsaCredentialSpecName(gmsaCredentialSpecName): { spec+: { securityContext+: { windowsOptions+: { gmsaCredentialSpecName: gmsaCredentialSpecName } } } }, + '#withHostProcess':: d.fn(help="\"HostProcess determines if a container should be run as a 'Host Process' container.\\nAll of a Pod's containers must have the same effective HostProcess value\\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\\nIn addition, if HostProcess is true then HostNetwork must also be set to true.\"", args=[d.arg(name='hostProcess', type=d.T.boolean)]), + withHostProcess(hostProcess): { spec+: { securityContext+: { windowsOptions+: { hostProcess: hostProcess } } } }, + '#withRunAsUserName':: d.fn(help='"The UserName in Windows to run the entrypoint of the container process.\\nDefaults to the user specified in image metadata if unspecified.\\nMay also be set in PodSecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsUserName', type=d.T.string)]), + withRunAsUserName(runAsUserName): { spec+: { securityContext+: { windowsOptions+: { runAsUserName: runAsUserName } } } }, + }, + '#withFsGroup':: d.fn(help="\"A special supplemental group that applies to all containers in a pod.\\nSome volume types allow the Kubelet to change the ownership of that volume\\nto be owned by the pod:\\n\\n\\n1. The owning GID will be the FSGroup\\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\\n3. The permission bits are OR'd with rw-rw----\\n\\n\\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\\nNote that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='fsGroup', type=d.T.integer)]), + withFsGroup(fsGroup): { spec+: { securityContext+: { fsGroup: fsGroup } } }, + '#withFsGroupChangePolicy':: d.fn(help='"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\\nbefore being exposed inside Pod. This field will only apply to\\nvolume types which support fsGroup based ownership(and permissions).\\nIt will have no effect on ephemeral volume types such as: secret, configmaps\\nand emptydir.\\nValid values are \\"OnRootMismatch\\" and \\"Always\\". If not specified, \\"Always\\" is used.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='fsGroupChangePolicy', type=d.T.string)]), + withFsGroupChangePolicy(fsGroupChangePolicy): { spec+: { securityContext+: { fsGroupChangePolicy: fsGroupChangePolicy } } }, + '#withRunAsGroup':: d.fn(help='"The GID to run the entrypoint of the container process.\\nUses runtime default if unset.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence\\nfor that container.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsGroup', type=d.T.integer)]), + withRunAsGroup(runAsGroup): { spec+: { securityContext+: { runAsGroup: runAsGroup } } }, + '#withRunAsNonRoot':: d.fn(help='"Indicates that the container must run as a non-root user.\\nIf true, the Kubelet will validate the image at runtime to ensure that it\\ndoes not run as UID 0 (root) and fail to start the container if it does.\\nIf unset or false, no such validation will be performed.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence."', args=[d.arg(name='runAsNonRoot', type=d.T.boolean)]), + withRunAsNonRoot(runAsNonRoot): { spec+: { securityContext+: { runAsNonRoot: runAsNonRoot } } }, + '#withRunAsUser':: d.fn(help='"The UID to run the entrypoint of the container process.\\nDefaults to user specified in image metadata if unspecified.\\nMay also be set in SecurityContext. If set in both SecurityContext and\\nPodSecurityContext, the value specified in SecurityContext takes precedence\\nfor that container.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='runAsUser', type=d.T.integer)]), + withRunAsUser(runAsUser): { spec+: { securityContext+: { runAsUser: runAsUser } } }, + '#withSupplementalGroups':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition\\nto the container's primary GID, the fsGroup (if specified), and group memberships\\ndefined in the container image for the uid of the container process. If unspecified,\\nno additional groups are added to any container. Note that group memberships\\ndefined in the container image for the uid of the container process are still effective,\\neven if they are not included in this list.\\nNote that this field cannot be set when spec.os.name is windows.\"", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroups(supplementalGroups): { spec+: { securityContext+: { supplementalGroups: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } }, + '#withSupplementalGroupsMixin':: d.fn(help="\"A list of groups applied to the first process run in each container, in addition\\nto the container's primary GID, the fsGroup (if specified), and group memberships\\ndefined in the container image for the uid of the container process. If unspecified,\\nno additional groups are added to any container. Note that group memberships\\ndefined in the container image for the uid of the container process are still effective,\\neven if they are not included in this list.\\nNote that this field cannot be set when spec.os.name is windows.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='supplementalGroups', type=d.T.array)]), + withSupplementalGroupsMixin(supplementalGroups): { spec+: { securityContext+: { supplementalGroups+: if std.isArray(v=supplementalGroups) then supplementalGroups else [supplementalGroups] } } }, + '#withSysctls':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctls(sysctls): { spec+: { securityContext+: { sysctls: if std.isArray(v=sysctls) then sysctls else [sysctls] } } }, + '#withSysctlsMixin':: d.fn(help='"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\\nsysctls (by the container runtime) might fail to launch.\\nNote that this field cannot be set when spec.os.name is windows."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sysctls', type=d.T.array)]), + withSysctlsMixin(sysctls): { spec+: { securityContext+: { sysctls+: if std.isArray(v=sysctls) then sysctls else [sysctls] } } }, + }, + '#serviceMonitorNamespaceSelector':: d.obj(help='"Namespaces to match for ServicedMonitors discovery. An empty label selector\\nmatches all namespaces. A null label selector (default value) matches the current\\nnamespace only."'), + serviceMonitorNamespaceSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { serviceMonitorNamespaceSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { serviceMonitorNamespaceSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { serviceMonitorNamespaceSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { serviceMonitorNamespaceSelector+: { matchLabels+: matchLabels } } }, + }, + '#serviceMonitorSelector':: d.obj(help="\"ServiceMonitors to be selected for target discovery. An empty label\\nselector matches all objects. A null label selector matches no objects.\\n\\n\\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\\nThe Prometheus operator will ensure that the Prometheus configuration's\\nSecret exists, but it is the responsibility of the user to provide the raw\\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\\nThis behavior is *deprecated* and will be removed in the next major version\\nof the custom resource definition. It is recommended to use\\n`spec.additionalScrapeConfigs` instead.\""), + serviceMonitorSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { serviceMonitorSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { serviceMonitorSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { serviceMonitorSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { serviceMonitorSelector+: { matchLabels+: matchLabels } } }, + }, + '#storage':: d.obj(help='"Storage defines the storage used by Prometheus."'), + storage: { + '#emptyDir':: d.obj(help='"EmptyDirVolumeSource to be used by the StatefulSet.\\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir"'), + emptyDir: { + '#withMedium':: d.fn(help="\"medium represents what type of storage medium should back this directory.\\nThe default is \\\"\\\" which means to use the node's default medium.\\nMust be an empty string (default) or Memory.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\"", args=[d.arg(name='medium', type=d.T.string)]), + withMedium(medium): { spec+: { storage+: { emptyDir+: { medium: medium } } } }, + '#withSizeLimit':: d.fn(help='"sizeLimit is the total amount of local storage required for this EmptyDir volume.\\nThe size limit is also applicable for memory medium.\\nThe maximum usage on memory medium EmptyDir would be the minimum value between\\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\\nThe default is nil which means that the limit is undefined.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"', args=[d.arg(name='sizeLimit', type=d.T.any)]), + withSizeLimit(sizeLimit): { spec+: { storage+: { emptyDir+: { sizeLimit: sizeLimit } } } }, + }, + '#ephemeral':: d.obj(help='"EphemeralVolumeSource to be used by the StatefulSet.\\nThis is a beta field in k8s 1.21 and GA in 1.15.\\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes"'), + ephemeral: { + '#volumeClaimTemplate':: d.obj(help='"Will be used to create a stand-alone PVC to provision the volume.\\nThe pod in which this EphemeralVolumeSource is embedded will be the\\nowner of the PVC, i.e. the PVC will be deleted together with the\\npod. The name of the PVC will be `-` where\\n`` is the name from the `PodSpec.Volumes` array\\nentry. Pod validation will reject the pod if the concatenated name\\nis not valid for a PVC (for example, too long).\\n\\n\\nAn existing PVC with that name that is not owned by the pod\\nwill *not* be used for the pod to avoid using an unrelated\\nvolume by mistake. Starting the pod is then blocked until\\nthe unrelated PVC is removed. If such a pre-created PVC is\\nmeant to be used by the pod, the PVC has to updated with an\\nowner reference to the pod once the pod exists. Normally\\nthis should not be necessary, but it may be useful when\\nmanually reconstructing a broken cluster.\\n\\n\\nThis field is read-only and no changes will be made by Kubernetes\\nto the PVC after it has been created.\\n\\n\\nRequired, must not be nil."'), + volumeClaimTemplate: { + '#spec':: d.obj(help='"The specification for the PersistentVolumeClaim. The entire content is\\ncopied unchanged into the PVC that gets created from this\\ntemplate. The same fields as in a PersistentVolumeClaim\\nare also valid here."'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } } } }, + }, + '#withMetadata':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadata(metadata): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { metadata: metadata } } } } }, + '#withMetadataMixin':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadataMixin(metadata): { spec+: { storage+: { ephemeral+: { volumeClaimTemplate+: { metadata+: metadata } } } } }, + }, + }, + '#volumeClaimTemplate':: d.obj(help='"Defines the PVC spec to be used by the Prometheus StatefulSets.\\nThe easiest way to use a volume that cannot be automatically provisioned\\nis to use a label selector alongside manually created PersistentVolumes."'), + volumeClaimTemplate: { + '#metadata':: d.obj(help='"EmbeddedMetadata contains metadata relevant to an EmbeddedResource."'), + metadata: { + '#withAnnotations':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { annotations: annotations } } } } }, + '#withAnnotationsMixin':: d.fn(help='"Annotations is an unstructured key value map stored with a resource that may be\\nset by external tools to store and retrieve arbitrary metadata. They are not\\nqueryable and should be preserved when modifying objects.\\nMore info: http://kubernetes.io/docs/user-guide/annotations"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { annotations+: annotations } } } } }, + '#withLabels':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { labels: labels } } } } }, + '#withLabelsMixin':: d.fn(help='"Map of string keys and values that can be used to organize and categorize\\n(scope and select) objects. May match selectors of replication controllers\\nand services.\\nMore info: http://kubernetes.io/docs/user-guide/labels"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { labels+: labels } } } } }, + '#withName':: d.fn(help='"Name must be unique within a namespace. Is required when creating resources, although\\nsome resources may allow a client to request the generation of an appropriate name\\nautomatically. Name is primarily intended for creation idempotence and configuration\\ndefinition.\\nCannot be updated.\\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { metadata+: { name: name } } } } }, + }, + '#spec':: d.obj(help='"Defines the desired characteristics of a volume requested by a pod author.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { spec+: { storage+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } } }, + }, + '#withApiVersion':: d.fn(help='"APIVersion defines the versioned schema of this representation of an object.\\nServers should convert recognized schemas to the latest internal value, and\\nmay reject unrecognized values.\\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { spec+: { storage+: { volumeClaimTemplate+: { apiVersion: apiVersion } } } }, + '#withKind':: d.fn(help='"Kind is a string value representing the REST resource this object represents.\\nServers may infer this from the endpoint the client submits requests to.\\nCannot be updated.\\nIn CamelCase.\\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { spec+: { storage+: { volumeClaimTemplate+: { kind: kind } } } }, + }, + '#withDisableMountSubPath':: d.fn(help='"Deprecated: subPath usage will be removed in a future release."', args=[d.arg(name='disableMountSubPath', type=d.T.boolean)]), + withDisableMountSubPath(disableMountSubPath): { spec+: { storage+: { disableMountSubPath: disableMountSubPath } } }, + }, + '#tolerations':: d.obj(help="\"Defines the Pods' tolerations if specified.\""), + tolerations: { + '#withEffect':: d.fn(help='"Effect indicates the taint effect to match. Empty means match all taint effects.\\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute."', args=[d.arg(name='effect', type=d.T.string)]), + withEffect(effect): { effect: effect }, + '#withKey':: d.fn(help='"Key is the taint key that the toleration applies to. Empty means match all taint keys.\\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"Operator represents a key's relationship to the value.\\nValid operators are Exists and Equal. Defaults to Equal.\\nExists is equivalent to wildcard for value, so that a pod can\\ntolerate all taints of a particular category.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withTolerationSeconds':: d.fn(help='"TolerationSeconds represents the period of time the toleration (which must be\\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\\nit is not set, which means tolerate the taint forever (do not evict). Zero and\\nnegative values will be treated as 0 (evict immediately) by the system."', args=[d.arg(name='tolerationSeconds', type=d.T.integer)]), + withTolerationSeconds(tolerationSeconds): { tolerationSeconds: tolerationSeconds }, + '#withValue':: d.fn(help='"Value is the taint value the toleration matches to.\\nIf the operator is Exists, the value should be empty, otherwise just a regular string."', args=[d.arg(name='value', type=d.T.string)]), + withValue(value): { value: value }, + }, + '#topologySpreadConstraints':: d.obj(help="\"Defines the pod's topology spread constraints if specified.\""), + topologySpreadConstraints: { + '#labelSelector':: d.obj(help='"LabelSelector is used to find matching pods.\\nPods that match this label selector are counted to determine the number of pods\\nin their corresponding topology domain."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { labelSelector+: { matchLabels: matchLabels } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { labelSelector+: { matchLabels+: matchLabels } }, + }, + '#withAdditionalLabelSelectors':: d.fn(help='"Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint."', args=[d.arg(name='additionalLabelSelectors', type=d.T.string)]), + withAdditionalLabelSelectors(additionalLabelSelectors): { additionalLabelSelectors: additionalLabelSelectors }, + '#withMatchLabelKeys':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select the pods over which\\nspreading will be calculated. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are ANDed with labelSelector\\nto select the group of existing pods over which spreading will be calculated\\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\\nMatchLabelKeys cannot be set when LabelSelector isn't set.\\nKeys that don't exist in the incoming pod labels will\\nbe ignored. A null or empty list means only match against labelSelector.\\n\\n\\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\"", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeys(matchLabelKeys): { matchLabelKeys: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMatchLabelKeysMixin':: d.fn(help="\"MatchLabelKeys is a set of pod label keys to select the pods over which\\nspreading will be calculated. The keys are used to lookup values from the\\nincoming pod labels, those key-value labels are ANDed with labelSelector\\nto select the group of existing pods over which spreading will be calculated\\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\\nMatchLabelKeys cannot be set when LabelSelector isn't set.\\nKeys that don't exist in the incoming pod labels will\\nbe ignored. A null or empty list means only match against labelSelector.\\n\\n\\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='matchLabelKeys', type=d.T.array)]), + withMatchLabelKeysMixin(matchLabelKeys): { matchLabelKeys+: if std.isArray(v=matchLabelKeys) then matchLabelKeys else [matchLabelKeys] }, + '#withMaxSkew':: d.fn(help="\"MaxSkew describes the degree to which pods may be unevenly distributed.\\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\\nbetween the number of matching pods in the target topology and the global minimum.\\nThe global minimum is the minimum number of matching pods in an eligible domain\\nor zero if the number of eligible domains is less than MinDomains.\\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\\nlabelSelector spread as 2/2/1:\\nIn this case, the global minimum is 1.\\n| zone1 | zone2 | zone3 |\\n| P P | P P | P |\\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\\nviolate MaxSkew(1).\\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\\nto topologies that satisfy it.\\nIt's a required field. Default value is 1 and 0 is not allowed.\"", args=[d.arg(name='maxSkew', type=d.T.integer)]), + withMaxSkew(maxSkew): { maxSkew: maxSkew }, + '#withMinDomains':: d.fn(help="\"MinDomains indicates a minimum number of eligible domains.\\nWhen the number of eligible domains with matching topology keys is less than minDomains,\\nPod Topology Spread treats \\\"global minimum\\\" as 0, and then the calculation of Skew is performed.\\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\\nthis value has no effect on scheduling.\\nAs a result, when the number of eligible domains is less than minDomains,\\nscheduler won't schedule more than maxSkew Pods to those domains.\\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\\nValid values are integers greater than 0.\\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\\n\\n\\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\\nlabelSelector spread as 2/2/2:\\n| zone1 | zone2 | zone3 |\\n| P P | P P | P P |\\nThe number of domains is less than 5(MinDomains), so \\\"global minimum\\\" is treated as 0.\\nIn this situation, new pod with the same labelSelector cannot be scheduled,\\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\\nit will violate MaxSkew.\"", args=[d.arg(name='minDomains', type=d.T.integer)]), + withMinDomains(minDomains): { minDomains: minDomains }, + '#withNodeAffinityPolicy':: d.fn(help="\"NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\\nwhen calculating pod topology spread skew. Options are:\\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\\n\\n\\nIf this value is nil, the behavior is equivalent to the Honor policy.\\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.\"", args=[d.arg(name='nodeAffinityPolicy', type=d.T.string)]), + withNodeAffinityPolicy(nodeAffinityPolicy): { nodeAffinityPolicy: nodeAffinityPolicy }, + '#withNodeTaintsPolicy':: d.fn(help='"NodeTaintsPolicy indicates how we will treat node taints when calculating\\npod topology spread skew. Options are:\\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\\nhas a toleration, are included.\\n- Ignore: node taints are ignored. All nodes are included.\\n\\n\\nIf this value is nil, the behavior is equivalent to the Ignore policy.\\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag."', args=[d.arg(name='nodeTaintsPolicy', type=d.T.string)]), + withNodeTaintsPolicy(nodeTaintsPolicy): { nodeTaintsPolicy: nodeTaintsPolicy }, + '#withTopologyKey':: d.fn(help="\"TopologyKey is the key of node labels. Nodes that have a label with this key\\nand identical values are considered to be in the same topology.\\nWe consider each \u003ckey, value\u003e as a \\\"bucket\\\", and try to put balanced number\\nof pods into each bucket.\\nWe define a domain as a particular instance of a topology.\\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\\nnodeAffinityPolicy and nodeTaintsPolicy.\\ne.g. If TopologyKey is \\\"kubernetes.io/hostname\\\", each Node is a domain of that topology.\\nAnd, if TopologyKey is \\\"topology.kubernetes.io/zone\\\", each zone is a domain of that topology.\\nIt's a required field.\"", args=[d.arg(name='topologyKey', type=d.T.string)]), + withTopologyKey(topologyKey): { topologyKey: topologyKey }, + '#withWhenUnsatisfiable':: d.fn(help="\"WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\\nthe spread constraint.\\n- DoNotSchedule (default) tells the scheduler not to schedule it.\\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\\n but giving higher precedence to topologies that would help reduce the\\n skew.\\nA constraint is considered \\\"Unsatisfiable\\\" for an incoming pod\\nif and only if every possible node assignment for that pod would violate\\n\\\"MaxSkew\\\" on some topology.\\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\\nlabelSelector spread as 3/1/1:\\n| zone1 | zone2 | zone3 |\\n| P P P | P | P |\\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\\nwon't make it *more* imbalanced.\\nIt's a required field.\"", args=[d.arg(name='whenUnsatisfiable', type=d.T.string)]), + withWhenUnsatisfiable(whenUnsatisfiable): { whenUnsatisfiable: whenUnsatisfiable }, + }, + '#tracingConfig':: d.obj(help='"TracingConfig configures tracing in Prometheus.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."'), + tracingConfig: { + '#tlsConfig':: d.obj(help='"TLS Config to use when sending traces."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tracingConfig+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tracingConfig+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tracingConfig+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withCaFile':: d.fn(help='"Path to the CA cert in the Prometheus container to use for the targets."', args=[d.arg(name='caFile', type=d.T.string)]), + withCaFile(caFile): { spec+: { tracingConfig+: { tlsConfig+: { caFile: caFile } } } }, + '#withCertFile':: d.fn(help='"Path to the client cert file in the Prometheus container for the targets."', args=[d.arg(name='certFile', type=d.T.string)]), + withCertFile(certFile): { spec+: { tracingConfig+: { tlsConfig+: { certFile: certFile } } } }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { tracingConfig+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withKeyFile':: d.fn(help='"Path to the client key file in the Prometheus container for the targets."', args=[d.arg(name='keyFile', type=d.T.string)]), + withKeyFile(keyFile): { spec+: { tracingConfig+: { tlsConfig+: { keyFile: keyFile } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { tracingConfig+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { tracingConfig+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { tracingConfig+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withClientType':: d.fn(help='"Client used to export the traces. Supported values are `http` or `grpc`."', args=[d.arg(name='clientType', type=d.T.string)]), + withClientType(clientType): { spec+: { tracingConfig+: { clientType: clientType } } }, + '#withCompression':: d.fn(help='"Compression key for supported compression types. The only supported value is `gzip`."', args=[d.arg(name='compression', type=d.T.string)]), + withCompression(compression): { spec+: { tracingConfig+: { compression: compression } } }, + '#withEndpoint':: d.fn(help='"Endpoint to send the traces to. Should be provided in format :."', args=[d.arg(name='endpoint', type=d.T.string)]), + withEndpoint(endpoint): { spec+: { tracingConfig+: { endpoint: endpoint } } }, + '#withHeaders':: d.fn(help='"Key-value pairs to be used as headers associated with gRPC or HTTP requests."', args=[d.arg(name='headers', type=d.T.object)]), + withHeaders(headers): { spec+: { tracingConfig+: { headers: headers } } }, + '#withHeadersMixin':: d.fn(help='"Key-value pairs to be used as headers associated with gRPC or HTTP requests."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='headers', type=d.T.object)]), + withHeadersMixin(headers): { spec+: { tracingConfig+: { headers+: headers } } }, + '#withInsecure':: d.fn(help='"If disabled, the client will use a secure connection."', args=[d.arg(name='insecure', type=d.T.boolean)]), + withInsecure(insecure): { spec+: { tracingConfig+: { insecure: insecure } } }, + '#withSamplingFraction':: d.fn(help='"Sets the probability a given trace will be sampled. Must be a float from 0 through 1."', args=[d.arg(name='samplingFraction', type=d.T.any)]), + withSamplingFraction(samplingFraction): { spec+: { tracingConfig+: { samplingFraction: samplingFraction } } }, + '#withTimeout':: d.fn(help='"Maximum time the exporter will wait for each batch export."', args=[d.arg(name='timeout', type=d.T.string)]), + withTimeout(timeout): { spec+: { tracingConfig+: { timeout: timeout } } }, + }, + '#volumeMounts':: d.obj(help="\"VolumeMounts allows the configuration of additional VolumeMounts.\\n\\n\\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\\ncontainer, that are generated as a result of StorageSpec objects.\""), + volumeMounts: { + '#withMountPath':: d.fn(help="\"Path within the container at which the volume should be mounted. Must\\nnot contain ':'.\"", args=[d.arg(name='mountPath', type=d.T.string)]), + withMountPath(mountPath): { mountPath: mountPath }, + '#withMountPropagation':: d.fn(help='"mountPropagation determines how mounts are propagated from the host\\nto container and the other way around.\\nWhen not set, MountPropagationNone is used.\\nThis field is beta in 1.10.\\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\\n(which defaults to None)."', args=[d.arg(name='mountPropagation', type=d.T.string)]), + withMountPropagation(mountPropagation): { mountPropagation: mountPropagation }, + '#withName':: d.fn(help='"This must match the Name of a Volume."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withReadOnly':: d.fn(help='"Mounted read-only if true, read-write otherwise (false or unspecified).\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { readOnly: readOnly }, + '#withRecursiveReadOnly':: d.fn(help='"RecursiveReadOnly specifies whether read-only mounts should be handled\\nrecursively.\\n\\n\\nIf ReadOnly is false, this field has no meaning and must be unspecified.\\n\\n\\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\\nrecursively read-only. If this field is set to IfPossible, the mount is made\\nrecursively read-only, if it is supported by the container runtime. If this\\nfield is set to Enabled, the mount is made recursively read-only if it is\\nsupported by the container runtime, otherwise the pod will not be started and\\nan error will be generated to indicate the reason.\\n\\n\\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\\nNone (or be unspecified, which defaults to None).\\n\\n\\nIf this field is not specified, it is treated as an equivalent of Disabled."', args=[d.arg(name='recursiveReadOnly', type=d.T.string)]), + withRecursiveReadOnly(recursiveReadOnly): { recursiveReadOnly: recursiveReadOnly }, + '#withSubPath':: d.fn(help="\"Path within the volume from which the container's volume should be mounted.\\nDefaults to \\\"\\\" (volume's root).\"", args=[d.arg(name='subPath', type=d.T.string)]), + withSubPath(subPath): { subPath: subPath }, + '#withSubPathExpr':: d.fn(help="\"Expanded path within the volume from which the container's volume should be mounted.\\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\\nDefaults to \\\"\\\" (volume's root).\\nSubPathExpr and SubPath are mutually exclusive.\"", args=[d.arg(name='subPathExpr', type=d.T.string)]), + withSubPathExpr(subPathExpr): { subPathExpr: subPathExpr }, + }, + '#volumes':: d.obj(help='"Volumes allows the configuration of additional volumes on the output\\nStatefulSet definition. Volumes specified will be appended to other\\nvolumes that are generated as a result of StorageSpec objects."'), + volumes: { + '#awsElasticBlockStore':: d.obj(help="\"awsElasticBlockStore represents an AWS Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\""), + awsElasticBlockStore: { + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { awsElasticBlockStore+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount.\\nIf omitted, the default is to mount by volume name.\\nExamples: For volume /dev/sda1, you specify the partition as \\"1\\".\\nSimilarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty)."', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { awsElasticBlockStore+: { partition: partition } }, + '#withReadOnly':: d.fn(help='"readOnly value true will force the readOnly setting in VolumeMounts.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { awsElasticBlockStore+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { awsElasticBlockStore+: { volumeID: volumeID } }, + }, + '#azureDisk':: d.obj(help='"azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod."'), + azureDisk: { + '#withCachingMode':: d.fn(help='"cachingMode is the Host Caching mode: None, Read Only, Read Write."', args=[d.arg(name='cachingMode', type=d.T.string)]), + withCachingMode(cachingMode): { azureDisk+: { cachingMode: cachingMode } }, + '#withDiskName':: d.fn(help='"diskName is the Name of the data disk in the blob storage"', args=[d.arg(name='diskName', type=d.T.string)]), + withDiskName(diskName): { azureDisk+: { diskName: diskName } }, + '#withDiskURI':: d.fn(help='"diskURI is the URI of data disk in the blob storage"', args=[d.arg(name='diskURI', type=d.T.string)]), + withDiskURI(diskURI): { azureDisk+: { diskURI: diskURI } }, + '#withFsType':: d.fn(help='"fsType is Filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { azureDisk+: { fsType: fsType } }, + '#withKind':: d.fn(help='"kind expected values are 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"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { azureDisk+: { kind: kind } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureDisk+: { readOnly: readOnly } }, + }, + '#azureFile':: d.obj(help='"azureFile represents an Azure File Service mount on the host and bind mount to the pod."'), + azureFile: { + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { azureFile+: { readOnly: readOnly } }, + '#withSecretName':: d.fn(help='"secretName is the name of secret that contains Azure Storage Account Name and Key"', args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { azureFile+: { secretName: secretName } }, + '#withShareName':: d.fn(help='"shareName is the azure share Name"', args=[d.arg(name='shareName', type=d.T.string)]), + withShareName(shareName): { azureFile+: { shareName: shareName } }, + }, + '#cephfs':: d.obj(help="\"cephFS represents a Ceph FS mount on the host that shares a pod's lifetime\""), + cephfs: { + '#secretRef':: d.obj(help='"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cephfs+: { secretRef+: { name: name } } }, + }, + '#withMonitors':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { cephfs+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is Required: Monitors is a collection of Ceph monitors\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { cephfs+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPath':: d.fn(help='"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { cephfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts.\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cephfs+: { readOnly: readOnly } }, + '#withSecretFile':: d.fn(help='"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='secretFile', type=d.T.string)]), + withSecretFile(secretFile): { cephfs+: { secretFile: secretFile } }, + '#withUser':: d.fn(help='"user is optional: User is the rados user name, default is admin\\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { cephfs+: { user: user } }, + }, + '#cinder':: d.obj(help='"cinder represents a cinder volume attached and mounted on kubelets host machine.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"'), + cinder: { + '#secretRef':: d.obj(help='"secretRef is optional: points to a secret object containing parameters used to connect\\nto OpenStack."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { cinder+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { cinder+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { cinder+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID used to identify the volume in cinder.\\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { cinder+: { volumeID: volumeID } }, + }, + '#configMap':: d.obj(help='"configMap represents a configMap that should populate this volume"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is optional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDefaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { configMap+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#csi':: d.obj(help='"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)."'), + csi: { + '#nodePublishSecretRef':: d.obj(help='"nodePublishSecretRef is a reference to the secret object containing\\nsensitive information to pass to the CSI driver to complete the CSI\\nNodePublishVolume and NodeUnpublishVolume calls.\\nThis field is optional, and may be empty if no secret is required. If the\\nsecret object contains more than one secret, all secret references are passed."'), + nodePublishSecretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { csi+: { nodePublishSecretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the CSI driver that handles this volume.\\nConsult with your admin for the correct name as registered in the cluster."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { csi+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType to mount. Ex. \\"ext4\\", \\"xfs\\", \\"ntfs\\".\\nIf not provided, the empty value is passed to the associated CSI driver\\nwhich will determine the default filesystem to apply."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { csi+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly specifies a read-only configuration for the volume.\\nDefaults to false (read/write)."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { csi+: { readOnly: readOnly } }, + '#withVolumeAttributes':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI\\ndriver. Consult your driver's documentation for supported values.\"", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributes(volumeAttributes): { csi+: { volumeAttributes: volumeAttributes } }, + '#withVolumeAttributesMixin':: d.fn(help="\"volumeAttributes stores driver-specific properties that are passed to the CSI\\ndriver. Consult your driver's documentation for supported values.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeAttributes', type=d.T.object)]), + withVolumeAttributesMixin(volumeAttributes): { csi+: { volumeAttributes+: volumeAttributes } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI represents downward API about the pod that should populate this volume"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of downward API volume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value\\nbetween 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"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 '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"Optional: mode bits to use on created files by default. Must be a\\nOptional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDefaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { downwardAPI+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help='"Items is a list of downward API volume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of downward API volume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#emptyDir':: d.obj(help="\"emptyDir represents a temporary directory that shares a pod's lifetime.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\""), + emptyDir: { + '#withMedium':: d.fn(help="\"medium represents what type of storage medium should back this directory.\\nThe default is \\\"\\\" which means to use the node's default medium.\\nMust be an empty string (default) or Memory.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir\"", args=[d.arg(name='medium', type=d.T.string)]), + withMedium(medium): { emptyDir+: { medium: medium } }, + '#withSizeLimit':: d.fn(help='"sizeLimit is the total amount of local storage required for this EmptyDir volume.\\nThe size limit is also applicable for memory medium.\\nThe maximum usage on memory medium EmptyDir would be the minimum value between\\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\\nThe default is nil which means that the limit is undefined.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"', args=[d.arg(name='sizeLimit', type=d.T.any)]), + withSizeLimit(sizeLimit): { emptyDir+: { sizeLimit: sizeLimit } }, + }, + '#ephemeral':: d.obj(help="\"ephemeral represents a volume that is handled by a cluster storage driver.\\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\\nand deleted when the pod is removed.\\n\\n\\nUse this if:\\na) the volume is only needed while the pod runs,\\nb) features of normal volumes like restoring from snapshot or capacity\\n tracking are needed,\\nc) the storage driver is specified through a storage class, and\\nd) the storage driver supports dynamic volume provisioning through\\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\\n information on the connection between this volume type\\n and PersistentVolumeClaim).\\n\\n\\nUse PersistentVolumeClaim or one of the vendor-specific\\nAPIs for volumes that persist for longer than the lifecycle\\nof an individual pod.\\n\\n\\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\\nbe used that way - see the documentation of the driver for\\nmore information.\\n\\n\\nA pod can use both types of ephemeral volumes and\\npersistent volumes at the same time.\""), + ephemeral: { + '#volumeClaimTemplate':: d.obj(help='"Will be used to create a stand-alone PVC to provision the volume.\\nThe pod in which this EphemeralVolumeSource is embedded will be the\\nowner of the PVC, i.e. the PVC will be deleted together with the\\npod. The name of the PVC will be `-` where\\n`` is the name from the `PodSpec.Volumes` array\\nentry. Pod validation will reject the pod if the concatenated name\\nis not valid for a PVC (for example, too long).\\n\\n\\nAn existing PVC with that name that is not owned by the pod\\nwill *not* be used for the pod to avoid using an unrelated\\nvolume by mistake. Starting the pod is then blocked until\\nthe unrelated PVC is removed. If such a pre-created PVC is\\nmeant to be used by the pod, the PVC has to updated with an\\nowner reference to the pod once the pod exists. Normally\\nthis should not be necessary, but it may be useful when\\nmanually reconstructing a broken cluster.\\n\\n\\nThis field is read-only and no changes will be made by Kubernetes\\nto the PVC after it has been created.\\n\\n\\nRequired, must not be nil."'), + volumeClaimTemplate: { + '#spec':: d.obj(help='"The specification for the PersistentVolumeClaim. The entire content is\\ncopied unchanged into the PVC that gets created from this\\ntemplate. The same fields as in a PersistentVolumeClaim\\nare also valid here."'), + spec: { + '#dataSource':: d.obj(help='"dataSource field can be used to specify either:\\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\\n* An existing PVC (PersistentVolumeClaim)\\nIf the provisioner or an external controller can support the specified data source,\\nit will create a new volume based on the contents of the specified data source.\\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource."'), + dataSource: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSource+: { name: name } } } } }, + }, + '#dataSourceRef':: d.obj(help="\"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\\nvolume is desired. This may be any object from a non-empty API group (non\\ncore object) or a PersistentVolumeClaim object.\\nWhen this field is specified, volume binding will only succeed if the type of\\nthe specified object matches some installed volume populator or dynamic\\nprovisioner.\\nThis field will replace the functionality of the dataSource field and as such\\nif both fields are non-empty, they must have the same value. For backwards\\ncompatibility, when namespace isn't specified in dataSourceRef,\\nboth fields (dataSource and dataSourceRef) will be set to the same\\nvalue automatically if one of them is empty and the other is non-empty.\\nWhen namespace is specified in dataSourceRef,\\ndataSource isn't set to the same value and must be empty.\\nThere are three important differences between dataSource and dataSourceRef:\\n* While dataSource only allows two specific types of objects, dataSourceRef\\n allows any non-core object, as well as PersistentVolumeClaim objects.\\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\\n preserves all values, and generates an error if a disallowed value is\\n specified.\\n* While dataSource only allows local objects, dataSourceRef allows objects\\n in any namespaces.\\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\""), + dataSourceRef: { + '#withApiGroup':: d.fn(help='"APIGroup is the group for the resource being referenced.\\nIf APIGroup is not specified, the specified Kind must be in the core API group.\\nFor any other third-party types, APIGroup is required."', args=[d.arg(name='apiGroup', type=d.T.string)]), + withApiGroup(apiGroup): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { apiGroup: apiGroup } } } } }, + '#withKind':: d.fn(help='"Kind is the type of resource being referenced"', args=[d.arg(name='kind', type=d.T.string)]), + withKind(kind): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { kind: kind } } } } }, + '#withName':: d.fn(help='"Name is the name of resource being referenced"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { name: name } } } } }, + '#withNamespace':: d.fn(help="\"Namespace is the namespace of resource being referenced\\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.\"", args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { ephemeral+: { volumeClaimTemplate+: { spec+: { dataSourceRef+: { namespace: namespace } } } } }, + }, + '#resources':: d.obj(help='"resources represents the minimum resources the volume should have.\\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\\nthat are lower than previous value but must still be higher than capacity recorded in the\\nstatus field of the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources"'), + resources: { + '#withLimits':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='limits', type=d.T.object)]), + withLimits(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits: limits } } } } }, + '#withLimitsMixin':: d.fn(help='"Limits describes the maximum amount of compute resources allowed.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='limits', type=d.T.object)]), + withLimitsMixin(limits): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { limits+: limits } } } } }, + '#withRequests':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"', args=[d.arg(name='requests', type=d.T.object)]), + withRequests(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests: requests } } } } }, + '#withRequestsMixin':: d.fn(help='"Requests describes the minimum amount of compute resources required.\\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\\notherwise to an implementation-defined value. Requests cannot exceed Limits.\\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='requests', type=d.T.object)]), + withRequestsMixin(requests): { ephemeral+: { volumeClaimTemplate+: { spec+: { resources+: { requests+: requests } } } } }, + }, + '#selector':: d.obj(help='"selector is a label query over volumes to consider for binding."'), + selector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels: matchLabels } } } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { ephemeral+: { volumeClaimTemplate+: { spec+: { selector+: { matchLabels+: matchLabels } } } } }, + }, + '#withAccessModes':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModes(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withAccessModesMixin':: d.fn(help='"accessModes contains the desired access modes the volume should have.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='accessModes', type=d.T.array)]), + withAccessModesMixin(accessModes): { ephemeral+: { volumeClaimTemplate+: { spec+: { accessModes+: if std.isArray(v=accessModes) then accessModes else [accessModes] } } } }, + '#withStorageClassName':: d.fn(help='"storageClassName is the name of the StorageClass required by the claim.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"', args=[d.arg(name='storageClassName', type=d.T.string)]), + withStorageClassName(storageClassName): { ephemeral+: { volumeClaimTemplate+: { spec+: { storageClassName: storageClassName } } } }, + '#withVolumeAttributesClassName':: d.fn(help="\"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\\nIf specified, the CSI driver will create or update the volume with the attributes defined\\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\\nwill be set by the persistentvolume controller if it exists.\\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\\nexists.\\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.\"", args=[d.arg(name='volumeAttributesClassName', type=d.T.string)]), + withVolumeAttributesClassName(volumeAttributesClassName): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeAttributesClassName: volumeAttributesClassName } } } }, + '#withVolumeMode':: d.fn(help='"volumeMode defines what type of volume is required by the claim.\\nValue of Filesystem is implied when not included in claim spec."', args=[d.arg(name='volumeMode', type=d.T.string)]), + withVolumeMode(volumeMode): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeMode: volumeMode } } } }, + '#withVolumeName':: d.fn(help='"volumeName is the binding reference to the PersistentVolume backing this claim."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { ephemeral+: { volumeClaimTemplate+: { spec+: { volumeName: volumeName } } } }, + }, + '#withMetadata':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadata(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata: metadata } } }, + '#withMetadataMixin':: d.fn(help='"May contain labels and annotations that will be copied into the PVC\\nwhen creating it. No other fields are allowed and will be rejected during\\nvalidation."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metadata', type=d.T.object)]), + withMetadataMixin(metadata): { ephemeral+: { volumeClaimTemplate+: { metadata+: metadata } } }, + }, + }, + '#fc':: d.obj(help="\"fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.\""), + fc: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { fc+: { fsType: fsType } }, + '#withLun':: d.fn(help='"lun is Optional: FC target lun number"', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { fc+: { lun: lun } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { fc+: { readOnly: readOnly } }, + '#withTargetWWNs':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNs(targetWWNs): { fc+: { targetWWNs: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withTargetWWNsMixin':: d.fn(help='"targetWWNs is Optional: FC target worldwide names (WWNs)"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='targetWWNs', type=d.T.array)]), + withTargetWWNsMixin(targetWWNs): { fc+: { targetWWNs+: if std.isArray(v=targetWWNs) then targetWWNs else [targetWWNs] } }, + '#withWwids':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids)\\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously."', args=[d.arg(name='wwids', type=d.T.array)]), + withWwids(wwids): { fc+: { wwids: if std.isArray(v=wwids) then wwids else [wwids] } }, + '#withWwidsMixin':: d.fn(help='"wwids Optional: FC volume world wide identifiers (wwids)\\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='wwids', type=d.T.array)]), + withWwidsMixin(wwids): { fc+: { wwids+: if std.isArray(v=wwids) then wwids else [wwids] } }, + }, + '#flexVolume':: d.obj(help='"flexVolume represents a generic volume resource that is\\nprovisioned/attached using an exec based plugin."'), + flexVolume: { + '#secretRef':: d.obj(help='"secretRef is Optional: secretRef is reference to the secret object containing\\nsensitive information to pass to the plugin scripts. This may be\\nempty if no secret object is specified. If the secret object\\ncontains more than one secret, all secrets are passed to the plugin\\nscripts."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { flexVolume+: { secretRef+: { name: name } } }, + }, + '#withDriver':: d.fn(help='"driver is the name of the driver to use for this volume."', args=[d.arg(name='driver', type=d.T.string)]), + withDriver(driver): { flexVolume+: { driver: driver } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". The default filesystem depends on FlexVolume script."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { flexVolume+: { fsType: fsType } }, + '#withOptions':: d.fn(help='"options is Optional: this field holds extra command options if any."', args=[d.arg(name='options', type=d.T.object)]), + withOptions(options): { flexVolume+: { options: options } }, + '#withOptionsMixin':: d.fn(help='"options is Optional: this field holds extra command options if any."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='options', type=d.T.object)]), + withOptionsMixin(options): { flexVolume+: { options+: options } }, + '#withReadOnly':: d.fn(help='"readOnly is Optional: defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { flexVolume+: { readOnly: readOnly } }, + }, + '#flocker':: d.obj(help="\"flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running\""), + flocker: { + '#withDatasetName':: d.fn(help='"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\\nshould be considered as deprecated"', args=[d.arg(name='datasetName', type=d.T.string)]), + withDatasetName(datasetName): { flocker+: { datasetName: datasetName } }, + '#withDatasetUUID':: d.fn(help='"datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset"', args=[d.arg(name='datasetUUID', type=d.T.string)]), + withDatasetUUID(datasetUUID): { flocker+: { datasetUUID: datasetUUID } }, + }, + '#gcePersistentDisk':: d.obj(help="\"gcePersistentDisk represents a GCE Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\""), + gcePersistentDisk: { + '#withFsType':: d.fn(help='"fsType is filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { gcePersistentDisk+: { fsType: fsType } }, + '#withPartition':: d.fn(help='"partition is the partition in the volume that you want to mount.\\nIf omitted, the default is to mount by volume name.\\nExamples: For volume /dev/sda1, you specify the partition as \\"1\\".\\nSimilarly, the volume partition for /dev/sda is \\"0\\" (or you can leave the property empty).\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='partition', type=d.T.integer)]), + withPartition(partition): { gcePersistentDisk+: { partition: partition } }, + '#withPdName':: d.fn(help='"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='pdName', type=d.T.string)]), + withPdName(pdName): { gcePersistentDisk+: { pdName: pdName } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { gcePersistentDisk+: { readOnly: readOnly } }, + }, + '#gitRepo':: d.obj(help="\"gitRepo represents a git repository at a particular revision.\\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\\ninto the Pod's container.\""), + gitRepo: { + '#withDirectory':: d.fn(help="\"directory is the target directory name.\\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\\ngit repository. Otherwise, if specified, the volume will contain the git repository in\\nthe subdirectory with the given name.\"", args=[d.arg(name='directory', type=d.T.string)]), + withDirectory(directory): { gitRepo+: { directory: directory } }, + '#withRepository':: d.fn(help='"repository is the URL"', args=[d.arg(name='repository', type=d.T.string)]), + withRepository(repository): { gitRepo+: { repository: repository } }, + '#withRevision':: d.fn(help='"revision is the commit hash for the specified revision."', args=[d.arg(name='revision', type=d.T.string)]), + withRevision(revision): { gitRepo+: { revision: revision } }, + }, + '#glusterfs':: d.obj(help="\"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md\""), + glusterfs: { + '#withEndpoints':: d.fn(help='"endpoints is the endpoint name that details Glusterfs topology.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='endpoints', type=d.T.string)]), + withEndpoints(endpoints): { glusterfs+: { endpoints: endpoints } }, + '#withPath':: d.fn(help='"path is the Glusterfs volume path.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { glusterfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\\nDefaults to false.\\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { glusterfs+: { readOnly: readOnly } }, + }, + '#hostPath':: d.obj(help='"hostPath represents a pre-existing file or directory on the host\\nmachine that is directly exposed to the container. This is generally\\nused for system agents or other privileged things that are allowed\\nto see the host machine. Most containers will NOT need this.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\\n---\\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\\nmount host directories as read/write."'), + hostPath: { + '#withPath':: d.fn(help='"path of the directory on the host.\\nIf the path is a symlink, it will follow the link to the real path.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { hostPath+: { path: path } }, + '#withType':: d.fn(help='"type for HostPath Volume\\nDefaults to \\"\\"\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath"', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { hostPath+: { type: type } }, + }, + '#iscsi':: d.obj(help="\"iscsi represents an ISCSI Disk resource that is attached to a\\nkubelet's host machine and then exposed to the pod.\\nMore info: https://examples.k8s.io/volumes/iscsi/README.md\""), + iscsi: { + '#secretRef':: d.obj(help='"secretRef is the CHAP Secret for iSCSI target and initiator authentication"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { iscsi+: { secretRef+: { name: name } } }, + }, + '#withChapAuthDiscovery':: d.fn(help='"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication"', args=[d.arg(name='chapAuthDiscovery', type=d.T.boolean)]), + withChapAuthDiscovery(chapAuthDiscovery): { iscsi+: { chapAuthDiscovery: chapAuthDiscovery } }, + '#withChapAuthSession':: d.fn(help='"chapAuthSession defines whether support iSCSI Session CHAP authentication"', args=[d.arg(name='chapAuthSession', type=d.T.boolean)]), + withChapAuthSession(chapAuthSession): { iscsi+: { chapAuthSession: chapAuthSession } }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { iscsi+: { fsType: fsType } }, + '#withInitiatorName':: d.fn(help='"initiatorName is the custom iSCSI Initiator Name.\\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\\n: will be created for the connection."', args=[d.arg(name='initiatorName', type=d.T.string)]), + withInitiatorName(initiatorName): { iscsi+: { initiatorName: initiatorName } }, + '#withIqn':: d.fn(help='"iqn is the target iSCSI Qualified Name."', args=[d.arg(name='iqn', type=d.T.string)]), + withIqn(iqn): { iscsi+: { iqn: iqn } }, + '#withIscsiInterface':: d.fn(help="\"iscsiInterface is the interface Name that uses an iSCSI transport.\\nDefaults to 'default' (tcp).\"", args=[d.arg(name='iscsiInterface', type=d.T.string)]), + withIscsiInterface(iscsiInterface): { iscsi+: { iscsiInterface: iscsiInterface } }, + '#withLun':: d.fn(help='"lun represents iSCSI Target Lun number."', args=[d.arg(name='lun', type=d.T.integer)]), + withLun(lun): { iscsi+: { lun: lun } }, + '#withPortals':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='portals', type=d.T.array)]), + withPortals(portals): { iscsi+: { portals: if std.isArray(v=portals) then portals else [portals] } }, + '#withPortalsMixin':: d.fn(help='"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='portals', type=d.T.array)]), + withPortalsMixin(portals): { iscsi+: { portals+: if std.isArray(v=portals) then portals else [portals] } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { iscsi+: { readOnly: readOnly } }, + '#withTargetPortal':: d.fn(help='"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\\nis other than default (typically TCP ports 860 and 3260)."', args=[d.arg(name='targetPortal', type=d.T.string)]), + withTargetPortal(targetPortal): { iscsi+: { targetPortal: targetPortal } }, + }, + '#nfs':: d.obj(help="\"nfs represents an NFS mount on the host that shares a pod's lifetime\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs\""), + nfs: { + '#withPath':: d.fn(help='"path that is exported by the NFS server.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { nfs+: { path: path } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the NFS export to be mounted with read-only permissions.\\nDefaults to false.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { nfs+: { readOnly: readOnly } }, + '#withServer':: d.fn(help='"server is the hostname or IP address of the NFS server.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"', args=[d.arg(name='server', type=d.T.string)]), + withServer(server): { nfs+: { server: server } }, + }, + '#persistentVolumeClaim':: d.obj(help='"persistentVolumeClaimVolumeSource represents a reference to a\\nPersistentVolumeClaim in the same namespace.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"'), + persistentVolumeClaim: { + '#withClaimName':: d.fn(help='"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"', args=[d.arg(name='claimName', type=d.T.string)]), + withClaimName(claimName): { persistentVolumeClaim+: { claimName: claimName } }, + '#withReadOnly':: d.fn(help='"readOnly Will force the ReadOnly setting in VolumeMounts.\\nDefault false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { persistentVolumeClaim+: { readOnly: readOnly } }, + }, + '#photonPersistentDisk':: d.obj(help='"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine"'), + photonPersistentDisk: { + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { photonPersistentDisk+: { fsType: fsType } }, + '#withPdID':: d.fn(help='"pdID is the ID that identifies Photon Controller persistent disk"', args=[d.arg(name='pdID', type=d.T.string)]), + withPdID(pdID): { photonPersistentDisk+: { pdID: pdID } }, + }, + '#portworxVolume':: d.obj(help='"portworxVolume represents a portworx volume attached and mounted on kubelets host machine"'), + portworxVolume: { + '#withFsType':: d.fn(help='"fSType represents the filesystem type to mount\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { portworxVolume+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { portworxVolume+: { readOnly: readOnly } }, + '#withVolumeID':: d.fn(help='"volumeID uniquely identifies a Portworx volume"', args=[d.arg(name='volumeID', type=d.T.string)]), + withVolumeID(volumeID): { portworxVolume+: { volumeID: volumeID } }, + }, + '#projected':: d.obj(help='"projected items for all in one resources secrets, configmaps, and downward API"'), + projected: { + '#sources':: d.obj(help='"sources is the list of volume projections"'), + sources: { + '#clusterTrustBundle':: d.obj(help='"ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\\nof ClusterTrustBundle objects in an auto-updating file.\\n\\n\\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\\n\\n\\nClusterTrustBundle objects can either be selected by name, or by the\\ncombination of signer name and a label selector.\\n\\n\\nKubelet performs aggressive normalization of the PEM contents written\\ninto the pod filesystem. Esoteric PEM features such as inter-block\\ncomments and block headers are stripped. Certificates are deduplicated.\\nThe ordering of certificates within the file is arbitrary, and Kubelet\\nmay change the order over time."'), + clusterTrustBundle: { + '#labelSelector':: d.obj(help='"Select all ClusterTrustBundles that match this label selector. Only has\\neffect if signerName is set. Mutually-exclusive with name. If unset,\\ninterpreted as \\"match nothing\\". If set but empty, interpreted as \\"match\\neverything\\"."'), + labelSelector: { + '#matchExpressions':: d.obj(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."'), + matchExpressions: { + '#withKey':: d.fn(help='"key is the label key that the selector applies to."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withOperator':: d.fn(help="\"operator represents a key's relationship to a set of values.\\nValid operators are In, NotIn, Exists and DoesNotExist.\"", args=[d.arg(name='operator', type=d.T.string)]), + withOperator(operator): { operator: operator }, + '#withValues':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"values is an array of string values. If the operator is In or NotIn,\\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\\nthe values array must be empty. This array is replaced during a strategic\\nmerge patch."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#withMatchExpressions':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressions(matchExpressions): { clusterTrustBundle+: { labelSelector+: { matchExpressions: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchExpressionsMixin':: d.fn(help='"matchExpressions is a list of label selector requirements. The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchExpressions', type=d.T.array)]), + withMatchExpressionsMixin(matchExpressions): { clusterTrustBundle+: { labelSelector+: { matchExpressions+: if std.isArray(v=matchExpressions) then matchExpressions else [matchExpressions] } } }, + '#withMatchLabels':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabels(matchLabels): { clusterTrustBundle+: { labelSelector+: { matchLabels: matchLabels } } }, + '#withMatchLabelsMixin':: d.fn(help='"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\\nmap is equivalent to an element of matchExpressions, whose key field is \\"key\\", the\\noperator is \\"In\\", and the values array contains only \\"value\\". The requirements are ANDed."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='matchLabels', type=d.T.object)]), + withMatchLabelsMixin(matchLabels): { clusterTrustBundle+: { labelSelector+: { matchLabels+: matchLabels } } }, + }, + '#withName':: d.fn(help='"Select a single ClusterTrustBundle by object name. Mutually-exclusive\\nwith signerName and labelSelector."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { clusterTrustBundle+: { name: name } }, + '#withOptional':: d.fn(help="\"If true, don't block pod startup if the referenced ClusterTrustBundle(s)\\naren't available. If using name, then the named ClusterTrustBundle is\\nallowed not to exist. If using signerName, then the combination of\\nsignerName and labelSelector is allowed to match zero\\nClusterTrustBundles.\"", args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { clusterTrustBundle+: { optional: optional } }, + '#withPath':: d.fn(help='"Relative path from the volume root to write the bundle."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { clusterTrustBundle+: { path: path } }, + '#withSignerName':: d.fn(help='"Select all ClusterTrustBundles that match this signer name.\\nMutually-exclusive with name. The contents of all selected\\nClusterTrustBundles will be unified and deduplicated."', args=[d.arg(name='signerName', type=d.T.string)]), + withSignerName(signerName): { clusterTrustBundle+: { signerName: signerName } }, + }, + '#configMap':: d.obj(help='"configMap information about the configMap data to project"'), + configMap: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { configMap+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nConfigMap will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the ConfigMap,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { configMap+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { configMap+: { name: name } }, + '#withOptional':: d.fn(help='"optional specify whether the ConfigMap or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { configMap+: { optional: optional } }, + }, + '#downwardAPI':: d.obj(help='"downwardAPI information about the downwardAPI data to project"'), + downwardAPI: { + '#items':: d.obj(help='"Items is a list of DownwardAPIVolume file"'), + items: { + '#fieldRef':: d.obj(help='"Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported."'), + fieldRef: { + '#withApiVersion':: d.fn(help='"Version of the schema the FieldPath is written in terms of, defaults to \\"v1\\"."', args=[d.arg(name='apiVersion', type=d.T.string)]), + withApiVersion(apiVersion): { fieldRef+: { apiVersion: apiVersion } }, + '#withFieldPath':: d.fn(help='"Path of the field to select in the specified API version."', args=[d.arg(name='fieldPath', type=d.T.string)]), + withFieldPath(fieldPath): { fieldRef+: { fieldPath: fieldPath } }, + }, + '#resourceFieldRef':: d.obj(help='"Selects a resource of the container: only resources limits and requests\\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported."'), + resourceFieldRef: { + '#withContainerName':: d.fn(help='"Container name: required for volumes, optional for env vars"', args=[d.arg(name='containerName', type=d.T.string)]), + withContainerName(containerName): { resourceFieldRef+: { containerName: containerName } }, + '#withDivisor':: d.fn(help='"Specifies the output format of the exposed resources, defaults to \\"1\\', args=[d.arg(name='divisor', type=d.T.any)]), + withDivisor(divisor): { resourceFieldRef+: { divisor: divisor } }, + '#withResource':: d.fn(help='"Required: resource to select"', args=[d.arg(name='resource', type=d.T.string)]), + withResource(resource): { resourceFieldRef+: { resource: resource } }, + }, + '#withMode':: d.fn(help='"Optional: mode bits used to set permissions on this file, must be an octal value\\nbetween 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"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 '..'\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help='"Items is a list of DownwardAPIVolume file"', args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { downwardAPI+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help='"Items is a list of DownwardAPIVolume file"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { downwardAPI+: { items+: if std.isArray(v=items) then items else [items] } }, + }, + '#secret':: d.obj(help='"secret information about the secret data to project"'), + secret: { + '#items':: d.obj(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withItems':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items if unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secret+: { name: name } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + }, + '#serviceAccountToken':: d.obj(help='"serviceAccountToken is information about the serviceAccountToken data to project"'), + serviceAccountToken: { + '#withAudience':: d.fn(help='"audience is the intended audience of the token. A recipient of a token\\nmust identify itself with an identifier specified in the audience of the\\ntoken, and otherwise should reject the token. The audience defaults to the\\nidentifier of the apiserver."', args=[d.arg(name='audience', type=d.T.string)]), + withAudience(audience): { serviceAccountToken+: { audience: audience } }, + '#withExpirationSeconds':: d.fn(help='"expirationSeconds is the requested duration of validity of the service\\naccount token. As the token approaches expiration, the kubelet volume\\nplugin will proactively rotate the service account token. The kubelet will\\nstart trying to rotate the token if the token is older than 80 percent of\\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\\nand must be at least 10 minutes."', args=[d.arg(name='expirationSeconds', type=d.T.integer)]), + withExpirationSeconds(expirationSeconds): { serviceAccountToken+: { expirationSeconds: expirationSeconds } }, + '#withPath':: d.fn(help='"path is the path relative to the mount point of the file to project the\\ntoken into."', args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { serviceAccountToken+: { path: path } }, + }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode are the mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { projected+: { defaultMode: defaultMode } }, + '#withSources':: d.fn(help='"sources is the list of volume projections"', args=[d.arg(name='sources', type=d.T.array)]), + withSources(sources): { projected+: { sources: if std.isArray(v=sources) then sources else [sources] } }, + '#withSourcesMixin':: d.fn(help='"sources is the list of volume projections"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sources', type=d.T.array)]), + withSourcesMixin(sources): { projected+: { sources+: if std.isArray(v=sources) then sources else [sources] } }, + }, + '#quobyte':: d.obj(help="\"quobyte represents a Quobyte mount on the host that shares a pod's lifetime\""), + quobyte: { + '#withGroup':: d.fn(help='"group to map volume access to\\nDefault is no group"', args=[d.arg(name='group', type=d.T.string)]), + withGroup(group): { quobyte+: { group: group } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the Quobyte volume to be mounted with read-only permissions.\\nDefaults to false."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { quobyte+: { readOnly: readOnly } }, + '#withRegistry':: d.fn(help='"registry represents a single or multiple Quobyte Registry services\\nspecified as a string as host:port pair (multiple entries are separated with commas)\\nwhich acts as the central registry for volumes"', args=[d.arg(name='registry', type=d.T.string)]), + withRegistry(registry): { quobyte+: { registry: registry } }, + '#withTenant':: d.fn(help='"tenant owning the given Quobyte volume in the Backend\\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin"', args=[d.arg(name='tenant', type=d.T.string)]), + withTenant(tenant): { quobyte+: { tenant: tenant } }, + '#withUser':: d.fn(help='"user to map volume access to\\nDefaults to serivceaccount user"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { quobyte+: { user: user } }, + '#withVolume':: d.fn(help='"volume is a string that references an already created Quobyte volume by name."', args=[d.arg(name='volume', type=d.T.string)]), + withVolume(volume): { quobyte+: { volume: volume } }, + }, + '#rbd':: d.obj(help="\"rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md\""), + rbd: { + '#secretRef':: d.obj(help='"secretRef is name of the authentication secret for RBDUser. If provided\\noverrides keyring.\\nDefault is nil.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { rbd+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type of the volume that you want to mount.\\nTip: Ensure that the filesystem type is supported by the host operating system.\\nExamples: \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\\nTODO: how do we prevent errors in the filesystem from compromising the machine"', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { rbd+: { fsType: fsType } }, + '#withImage':: d.fn(help='"image is the rados image name.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { rbd+: { image: image } }, + '#withKeyring':: d.fn(help='"keyring is the path to key ring for RBDUser.\\nDefault is /etc/ceph/keyring.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='keyring', type=d.T.string)]), + withKeyring(keyring): { rbd+: { keyring: keyring } }, + '#withMonitors':: d.fn(help='"monitors is a collection of Ceph monitors.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitors(monitors): { rbd+: { monitors: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withMonitorsMixin':: d.fn(help='"monitors is a collection of Ceph monitors.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='monitors', type=d.T.array)]), + withMonitorsMixin(monitors): { rbd+: { monitors+: if std.isArray(v=monitors) then monitors else [monitors] } }, + '#withPool':: d.fn(help='"pool is the rados pool name.\\nDefault is rbd.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='pool', type=d.T.string)]), + withPool(pool): { rbd+: { pool: pool } }, + '#withReadOnly':: d.fn(help='"readOnly here will force the ReadOnly setting in VolumeMounts.\\nDefaults to false.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { rbd+: { readOnly: readOnly } }, + '#withUser':: d.fn(help='"user is the rados user name.\\nDefault is admin.\\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"', args=[d.arg(name='user', type=d.T.string)]), + withUser(user): { rbd+: { user: user } }, + }, + '#scaleIO':: d.obj(help='"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes."'), + scaleIO: { + '#secretRef':: d.obj(help='"secretRef references to the secret for ScaleIO user and other\\nsensitive information. If this is not provided, Login operation will fail."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { scaleIO+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\".\\nDefault is \\"xfs\\"."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { scaleIO+: { fsType: fsType } }, + '#withGateway':: d.fn(help='"gateway is the host address of the ScaleIO API Gateway."', args=[d.arg(name='gateway', type=d.T.string)]), + withGateway(gateway): { scaleIO+: { gateway: gateway } }, + '#withProtectionDomain':: d.fn(help='"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage."', args=[d.arg(name='protectionDomain', type=d.T.string)]), + withProtectionDomain(protectionDomain): { scaleIO+: { protectionDomain: protectionDomain } }, + '#withReadOnly':: d.fn(help='"readOnly Defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { scaleIO+: { readOnly: readOnly } }, + '#withSslEnabled':: d.fn(help='"sslEnabled Flag enable/disable SSL communication with Gateway, default false"', args=[d.arg(name='sslEnabled', type=d.T.boolean)]), + withSslEnabled(sslEnabled): { scaleIO+: { sslEnabled: sslEnabled } }, + '#withStorageMode':: d.fn(help='"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\\nDefault is ThinProvisioned."', args=[d.arg(name='storageMode', type=d.T.string)]), + withStorageMode(storageMode): { scaleIO+: { storageMode: storageMode } }, + '#withStoragePool':: d.fn(help='"storagePool is the ScaleIO Storage Pool associated with the protection domain."', args=[d.arg(name='storagePool', type=d.T.string)]), + withStoragePool(storagePool): { scaleIO+: { storagePool: storagePool } }, + '#withSystem':: d.fn(help='"system is the name of the storage system as configured in ScaleIO."', args=[d.arg(name='system', type=d.T.string)]), + withSystem(system): { scaleIO+: { system: system } }, + '#withVolumeName':: d.fn(help='"volumeName is the name of a volume already created in the ScaleIO system\\nthat is associated with this volume source."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { scaleIO+: { volumeName: volumeName } }, + }, + '#secret':: d.obj(help='"secret represents a secret that should populate this volume.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret"'), + secret: { + '#items':: d.obj(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\""), + items: { + '#withKey':: d.fn(help='"key is the key to project."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { key: key }, + '#withMode':: d.fn(help='"mode is Optional: mode bits used to set permissions on this file.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\\nIf not specified, the volume defaultMode will be used.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='mode', type=d.T.integer)]), + withMode(mode): { mode: mode }, + '#withPath':: d.fn(help="\"path is the relative path of the file to map the key to.\\nMay not be an absolute path.\\nMay not contain the path element '..'.\\nMay not start with the string '..'.\"", args=[d.arg(name='path', type=d.T.string)]), + withPath(path): { path: path }, + }, + '#withDefaultMode':: d.fn(help='"defaultMode is Optional: mode bits used to set permissions on created files by default.\\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\\nYAML accepts both octal and decimal values, JSON requires decimal values\\nfor mode bits. Defaults to 0644.\\nDirectories within the path are not affected by this setting.\\nThis might be in conflict with other options that affect the file\\nmode, like fsGroup, and the result can be other mode bits set."', args=[d.arg(name='defaultMode', type=d.T.integer)]), + withDefaultMode(defaultMode): { secret+: { defaultMode: defaultMode } }, + '#withItems':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"", args=[d.arg(name='items', type=d.T.array)]), + withItems(items): { secret+: { items: if std.isArray(v=items) then items else [items] } }, + '#withItemsMixin':: d.fn(help="\"items If unspecified, each key-value pair in the Data field of the referenced\\nSecret will be projected into the volume as a file whose name is the\\nkey and content is the value. If specified, the listed keys will be\\nprojected into the specified paths, and unlisted keys will not be\\npresent. If a key is specified which is not present in the Secret,\\nthe volume setup will error unless it is marked optional. Paths must be\\nrelative and may not contain the '..' path or start with '..'.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='items', type=d.T.array)]), + withItemsMixin(items): { secret+: { items+: if std.isArray(v=items) then items else [items] } }, + '#withOptional':: d.fn(help='"optional field specify whether the Secret or its keys must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secret+: { optional: optional } }, + '#withSecretName':: d.fn(help="\"secretName is the name of the secret in the pod's namespace to use.\\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret\"", args=[d.arg(name='secretName', type=d.T.string)]), + withSecretName(secretName): { secret+: { secretName: secretName } }, + }, + '#storageos':: d.obj(help='"storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes."'), + storageos: { + '#secretRef':: d.obj(help='"secretRef specifies the secret to use for obtaining the StorageOS API\\ncredentials. If not specified, default values will be attempted."'), + secretRef: { + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { storageos+: { secretRef+: { name: name } } }, + }, + '#withFsType':: d.fn(help='"fsType is the filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { storageos+: { fsType: fsType } }, + '#withReadOnly':: d.fn(help='"readOnly defaults to false (read/write). ReadOnly here will force\\nthe ReadOnly setting in VolumeMounts."', args=[d.arg(name='readOnly', type=d.T.boolean)]), + withReadOnly(readOnly): { storageos+: { readOnly: readOnly } }, + '#withVolumeName':: d.fn(help='"volumeName is the human-readable name of the StorageOS volume. Volume\\nnames are only unique within a namespace."', args=[d.arg(name='volumeName', type=d.T.string)]), + withVolumeName(volumeName): { storageos+: { volumeName: volumeName } }, + '#withVolumeNamespace':: d.fn(help="\"volumeNamespace specifies the scope of the volume within StorageOS. If no\\nnamespace is specified then the Pod's namespace will be used. This allows the\\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\\nSet VolumeName to any name to override the default behaviour.\\nSet to \\\"default\\\" if you are not using namespaces within StorageOS.\\nNamespaces that do not pre-exist within StorageOS will be created.\"", args=[d.arg(name='volumeNamespace', type=d.T.string)]), + withVolumeNamespace(volumeNamespace): { storageos+: { volumeNamespace: volumeNamespace } }, + }, + '#vsphereVolume':: d.obj(help='"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine"'), + vsphereVolume: { + '#withFsType':: d.fn(help='"fsType is filesystem type to mount.\\nMust be a filesystem type supported by the host operating system.\\nEx. \\"ext4\\", \\"xfs\\", \\"ntfs\\". Implicitly inferred to be \\"ext4\\" if unspecified."', args=[d.arg(name='fsType', type=d.T.string)]), + withFsType(fsType): { vsphereVolume+: { fsType: fsType } }, + '#withStoragePolicyID':: d.fn(help='"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName."', args=[d.arg(name='storagePolicyID', type=d.T.string)]), + withStoragePolicyID(storagePolicyID): { vsphereVolume+: { storagePolicyID: storagePolicyID } }, + '#withStoragePolicyName':: d.fn(help='"storagePolicyName is the storage Policy Based Management (SPBM) profile name."', args=[d.arg(name='storagePolicyName', type=d.T.string)]), + withStoragePolicyName(storagePolicyName): { vsphereVolume+: { storagePolicyName: storagePolicyName } }, + '#withVolumePath':: d.fn(help='"volumePath is the path that identifies vSphere volume vmdk"', args=[d.arg(name='volumePath', type=d.T.string)]), + withVolumePath(volumePath): { vsphereVolume+: { volumePath: volumePath } }, + }, + '#withName':: d.fn(help='"name of the volume.\\nMust be a DNS_LABEL and unique within the pod.\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + }, + '#web':: d.obj(help='"Defines the configuration of the Prometheus web server."'), + web: { + '#httpConfig':: d.obj(help='"Defines HTTP parameters for web server."'), + httpConfig: { + '#headers':: d.obj(help='"List of headers that can be added to HTTP responses."'), + headers: { + '#withContentSecurityPolicy':: d.fn(help='"Set the Content-Security-Policy header to HTTP responses.\\nUnset if blank."', args=[d.arg(name='contentSecurityPolicy', type=d.T.string)]), + withContentSecurityPolicy(contentSecurityPolicy): { spec+: { web+: { httpConfig+: { headers+: { contentSecurityPolicy: contentSecurityPolicy } } } } }, + '#withStrictTransportSecurity':: d.fn(help='"Set the Strict-Transport-Security header to HTTP responses.\\nUnset if blank.\\nPlease make sure that you use this with care as this header might force\\nbrowsers to load Prometheus and the other applications hosted on the same\\ndomain and subdomains over HTTPS.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security"', args=[d.arg(name='strictTransportSecurity', type=d.T.string)]), + withStrictTransportSecurity(strictTransportSecurity): { spec+: { web+: { httpConfig+: { headers+: { strictTransportSecurity: strictTransportSecurity } } } } }, + '#withXContentTypeOptions':: d.fn(help='"Set the X-Content-Type-Options header to HTTP responses.\\nUnset if blank. Accepted value is nosniff.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options"', args=[d.arg(name='xContentTypeOptions', type=d.T.string)]), + withXContentTypeOptions(xContentTypeOptions): { spec+: { web+: { httpConfig+: { headers+: { xContentTypeOptions: xContentTypeOptions } } } } }, + '#withXFrameOptions':: d.fn(help='"Set the X-Frame-Options header to HTTP responses.\\nUnset if blank. Accepted values are deny and sameorigin.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options"', args=[d.arg(name='xFrameOptions', type=d.T.string)]), + withXFrameOptions(xFrameOptions): { spec+: { web+: { httpConfig+: { headers+: { xFrameOptions: xFrameOptions } } } } }, + '#withXXSSProtection':: d.fn(help='"Set the X-XSS-Protection header to all responses.\\nUnset if blank.\\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection"', args=[d.arg(name='xXSSProtection', type=d.T.string)]), + withXXSSProtection(xXSSProtection): { spec+: { web+: { httpConfig+: { headers+: { xXSSProtection: xXSSProtection } } } } }, + }, + '#withHttp2':: d.fn(help='"Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\\nWhenever the value of the field changes, a rolling update will be triggered."', args=[d.arg(name='http2', type=d.T.boolean)]), + withHttp2(http2): { spec+: { web+: { httpConfig+: { http2: http2 } } } }, + }, + '#tlsConfig':: d.obj(help='"Defines the TLS parameters for HTTPS."'), + tlsConfig: { + '#cert':: d.obj(help='"Contains the TLS certificate for the server."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#client_ca':: d.obj(help='"Contains the CA certificate for client certificate authentication to the server."'), + client_ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { client_ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { client_ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the TLS key for the server."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { web+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { web+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { web+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withCipherSuites':: d.fn(help='"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\\nGo default cipher suites are used. Available cipher suites are documented\\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"', args=[d.arg(name='cipherSuites', type=d.T.array)]), + withCipherSuites(cipherSuites): { spec+: { web+: { tlsConfig+: { cipherSuites: if std.isArray(v=cipherSuites) then cipherSuites else [cipherSuites] } } } }, + '#withCipherSuitesMixin':: d.fn(help='"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\\nGo default cipher suites are used. Available cipher suites are documented\\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='cipherSuites', type=d.T.array)]), + withCipherSuitesMixin(cipherSuites): { spec+: { web+: { tlsConfig+: { cipherSuites+: if std.isArray(v=cipherSuites) then cipherSuites else [cipherSuites] } } } }, + '#withClientAuthType':: d.fn(help='"Server policy for client authentication. Maps to ClientAuth Policies.\\nFor more detail on clientAuth options:\\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType"', args=[d.arg(name='clientAuthType', type=d.T.string)]), + withClientAuthType(clientAuthType): { spec+: { web+: { tlsConfig+: { clientAuthType: clientAuthType } } } }, + '#withCurvePreferences':: d.fn(help='"Elliptic curves that will be used in an ECDHE handshake, in preference\\norder. Available curves are documented in the go documentation:\\nhttps://golang.org/pkg/crypto/tls/#CurveID"', args=[d.arg(name='curvePreferences', type=d.T.array)]), + withCurvePreferences(curvePreferences): { spec+: { web+: { tlsConfig+: { curvePreferences: if std.isArray(v=curvePreferences) then curvePreferences else [curvePreferences] } } } }, + '#withCurvePreferencesMixin':: d.fn(help='"Elliptic curves that will be used in an ECDHE handshake, in preference\\norder. Available curves are documented in the go documentation:\\nhttps://golang.org/pkg/crypto/tls/#CurveID"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='curvePreferences', type=d.T.array)]), + withCurvePreferencesMixin(curvePreferences): { spec+: { web+: { tlsConfig+: { curvePreferences+: if std.isArray(v=curvePreferences) then curvePreferences else [curvePreferences] } } } }, + '#withMaxVersion':: d.fn(help='"Maximum TLS version that is acceptable. Defaults to TLS13."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { web+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum TLS version that is acceptable. Defaults to TLS12."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { web+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withPreferServerCipherSuites':: d.fn(help="\"Controls whether the server selects the\\nclient's most preferred cipher suite, or the server's most preferred\\ncipher suite. If true then the server's preference, as expressed in\\nthe order of elements in cipherSuites, is used.\"", args=[d.arg(name='preferServerCipherSuites', type=d.T.boolean)]), + withPreferServerCipherSuites(preferServerCipherSuites): { spec+: { web+: { tlsConfig+: { preferServerCipherSuites: preferServerCipherSuites } } } }, + }, + '#withMaxConnections':: d.fn(help="\"Defines the maximum number of simultaneous connections\\nA zero value means that Prometheus doesn't accept any incoming connection.\"", args=[d.arg(name='maxConnections', type=d.T.integer)]), + withMaxConnections(maxConnections): { spec+: { web+: { maxConnections: maxConnections } } }, + '#withPageTitle':: d.fn(help='"The prometheus web page title."', args=[d.arg(name='pageTitle', type=d.T.string)]), + withPageTitle(pageTitle): { spec+: { web+: { pageTitle: pageTitle } } }, + }, + '#withAdditionalArgs':: d.fn(help="\"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\\n\\n\\nIt is intended for e.g. activating hidden flags which are not supported by\\nthe dedicated configuration options yet. The arguments are passed as-is to the\\nPrometheus container which may cause issues if they are invalid or not supported\\nby the given Prometheus version.\\n\\n\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument, the reconciliation will\\nfail and an error will be logged.\"", args=[d.arg(name='additionalArgs', type=d.T.array)]), + withAdditionalArgs(additionalArgs): { spec+: { additionalArgs: if std.isArray(v=additionalArgs) then additionalArgs else [additionalArgs] } }, + '#withAdditionalArgsMixin':: d.fn(help="\"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\\n\\n\\nIt is intended for e.g. activating hidden flags which are not supported by\\nthe dedicated configuration options yet. The arguments are passed as-is to the\\nPrometheus container which may cause issues if they are invalid or not supported\\nby the given Prometheus version.\\n\\n\\nIn case of an argument conflict (e.g. an argument which is already set by the\\noperator itself) or when providing an invalid argument, the reconciliation will\\nfail and an error will be logged.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='additionalArgs', type=d.T.array)]), + withAdditionalArgsMixin(additionalArgs): { spec+: { additionalArgs+: if std.isArray(v=additionalArgs) then additionalArgs else [additionalArgs] } }, + '#withAutomountServiceAccountToken':: d.fn(help="\"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\\nIf the field isn't set, the operator mounts the service account token by default.\\n\\n\\n**Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery.\\nIt is possible to use strategic merge patch to project the service account token into the 'prometheus' container.\"", args=[d.arg(name='automountServiceAccountToken', type=d.T.boolean)]), + withAutomountServiceAccountToken(automountServiceAccountToken): { spec+: { automountServiceAccountToken: automountServiceAccountToken } }, + '#withBodySizeLimit':: d.fn(help="\"BodySizeLimit defines per-scrape on response body size.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.\"", args=[d.arg(name='bodySizeLimit', type=d.T.string)]), + withBodySizeLimit(bodySizeLimit): { spec+: { bodySizeLimit: bodySizeLimit } }, + '#withConfigMaps':: d.fn(help="\"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\\nobject, which shall be mounted into the Prometheus Pods.\\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-\u003cconfigmap-name\u003e`.\\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/\u003cconfigmap-name\u003e in the 'prometheus' container.\"", args=[d.arg(name='configMaps', type=d.T.array)]), + withConfigMaps(configMaps): { spec+: { configMaps: if std.isArray(v=configMaps) then configMaps else [configMaps] } }, + '#withConfigMapsMixin':: d.fn(help="\"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\\nobject, which shall be mounted into the Prometheus Pods.\\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-\u003cconfigmap-name\u003e`.\\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/\u003cconfigmap-name\u003e in the 'prometheus' container.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='configMaps', type=d.T.array)]), + withConfigMapsMixin(configMaps): { spec+: { configMaps+: if std.isArray(v=configMaps) then configMaps else [configMaps] } }, + '#withContainers':: d.fn(help='"Containers allows injecting additional containers or modifying operator\\ngenerated containers. This can be used to allow adding an authentication\\nproxy to the Pods or to change the behavior of an operator generated\\ncontainer. Containers described here modify an operator generated\\ncontainer if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of containers managed by the operator are:\\n* `prometheus`\\n* `config-reloader`\\n* `thanos-sidecar`\\n\\n\\nOverriding containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."', args=[d.arg(name='containers', type=d.T.array)]), + withContainers(containers): { spec+: { containers: if std.isArray(v=containers) then containers else [containers] } }, + '#withContainersMixin':: d.fn(help='"Containers allows injecting additional containers or modifying operator\\ngenerated containers. This can be used to allow adding an authentication\\nproxy to the Pods or to change the behavior of an operator generated\\ncontainer. Containers described here modify an operator generated\\ncontainer if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of containers managed by the operator are:\\n* `prometheus`\\n* `config-reloader`\\n* `thanos-sidecar`\\n\\n\\nOverriding containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='containers', type=d.T.array)]), + withContainersMixin(containers): { spec+: { containers+: if std.isArray(v=containers) then containers else [containers] } }, + '#withEnableFeatures':: d.fn(help='"Enable access to Prometheus feature flags. By default, no features are enabled.\\n\\n\\nEnabling features which are disabled by default is entirely outside the\\nscope of what the maintainers will support and by doing so, you accept\\nthat this behaviour may break at any time without notice.\\n\\n\\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/"', args=[d.arg(name='enableFeatures', type=d.T.array)]), + withEnableFeatures(enableFeatures): { spec+: { enableFeatures: if std.isArray(v=enableFeatures) then enableFeatures else [enableFeatures] } }, + '#withEnableFeaturesMixin':: d.fn(help='"Enable access to Prometheus feature flags. By default, no features are enabled.\\n\\n\\nEnabling features which are disabled by default is entirely outside the\\nscope of what the maintainers will support and by doing so, you accept\\nthat this behaviour may break at any time without notice.\\n\\n\\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='enableFeatures', type=d.T.array)]), + withEnableFeaturesMixin(enableFeatures): { spec+: { enableFeatures+: if std.isArray(v=enableFeatures) then enableFeatures else [enableFeatures] } }, + '#withEnableRemoteWriteReceiver':: d.fn(help='"Enable Prometheus to be used as a receiver for the Prometheus remote\\nwrite protocol.\\n\\n\\nWARNING: This is not considered an efficient way of ingesting samples.\\nUse it with caution for specific low-volume use cases.\\nIt is not suitable for replacing the ingestion via scraping and turning\\nPrometheus into a push-based metrics collection system.\\nFor more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver\\n\\n\\nIt requires Prometheus >= v2.33.0."', args=[d.arg(name='enableRemoteWriteReceiver', type=d.T.boolean)]), + withEnableRemoteWriteReceiver(enableRemoteWriteReceiver): { spec+: { enableRemoteWriteReceiver: enableRemoteWriteReceiver } }, + '#withEnforcedBodySizeLimit':: d.fn(help='"When defined, enforcedBodySizeLimit specifies a global limit on the size\\nof uncompressed response body that will be accepted by Prometheus.\\nTargets responding with a body larger than this many bytes will cause\\nthe scrape to fail.\\n\\n\\nIt requires Prometheus >= v2.28.0.\\n\\n\\nWhen both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.\\n* Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value.\\n* Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit."', args=[d.arg(name='enforcedBodySizeLimit', type=d.T.string)]), + withEnforcedBodySizeLimit(enforcedBodySizeLimit): { spec+: { enforcedBodySizeLimit: enforcedBodySizeLimit } }, + '#withEnforcedKeepDroppedTargets':: d.fn(help='"When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets\\ndropped by relabeling that will be kept in memory. The value overrides\\nany `spec.keepDroppedTargets` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is\\ngreater than zero and less than `spec.enforcedKeepDroppedTargets`.\\n\\n\\nIt requires Prometheus >= v2.47.0.\\n\\n\\nWhen both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.\\n* Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value.\\n* Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets."', args=[d.arg(name='enforcedKeepDroppedTargets', type=d.T.integer)]), + withEnforcedKeepDroppedTargets(enforcedKeepDroppedTargets): { spec+: { enforcedKeepDroppedTargets: enforcedKeepDroppedTargets } }, + '#withEnforcedLabelLimit':: d.fn(help='"When defined, enforcedLabelLimit specifies a global limit on the number\\nof labels per sample. The value overrides any `spec.labelLimit` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is\\ngreater than zero and less than `spec.enforcedLabelLimit`.\\n\\n\\nIt requires Prometheus >= v2.27.0.\\n\\n\\nWhen both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.\\n* Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value.\\n* Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit."', args=[d.arg(name='enforcedLabelLimit', type=d.T.integer)]), + withEnforcedLabelLimit(enforcedLabelLimit): { spec+: { enforcedLabelLimit: enforcedLabelLimit } }, + '#withEnforcedLabelNameLengthLimit':: d.fn(help='"When defined, enforcedLabelNameLengthLimit specifies a global limit on the length\\nof labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is\\ngreater than zero and less than `spec.enforcedLabelNameLengthLimit`.\\n\\n\\nIt requires Prometheus >= v2.27.0.\\n\\n\\nWhen both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.\\n* Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value.\\n* Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit."', args=[d.arg(name='enforcedLabelNameLengthLimit', type=d.T.integer)]), + withEnforcedLabelNameLengthLimit(enforcedLabelNameLengthLimit): { spec+: { enforcedLabelNameLengthLimit: enforcedLabelNameLengthLimit } }, + '#withEnforcedLabelValueLengthLimit':: d.fn(help='"When not null, enforcedLabelValueLengthLimit defines a global limit on the length\\nof labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is\\ngreater than zero and less than `spec.enforcedLabelValueLengthLimit`.\\n\\n\\nIt requires Prometheus >= v2.27.0.\\n\\n\\nWhen both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.\\n* Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value.\\n* Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit."', args=[d.arg(name='enforcedLabelValueLengthLimit', type=d.T.integer)]), + withEnforcedLabelValueLengthLimit(enforcedLabelValueLengthLimit): { spec+: { enforcedLabelValueLengthLimit: enforcedLabelValueLengthLimit } }, + '#withEnforcedNamespaceLabel':: d.fn(help="\"When not empty, a label will be added to:\\n\\n\\n1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects.\\n2. All metrics generated from recording rules defined in `PrometheusRule` objects.\\n3. All alerts generated from alerting rules defined in `PrometheusRule` objects.\\n4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.\\n\\n\\nThe label will not added for objects referenced in `spec.excludedFromEnforcement`.\\n\\n\\nThe label's name is this field's value.\\nThe label's value is the namespace of the `ServiceMonitor`,\\n`PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object.\"", args=[d.arg(name='enforcedNamespaceLabel', type=d.T.string)]), + withEnforcedNamespaceLabel(enforcedNamespaceLabel): { spec+: { enforcedNamespaceLabel: enforcedNamespaceLabel } }, + '#withEnforcedSampleLimit':: d.fn(help='"When defined, enforcedSampleLimit specifies a global limit on the number\\nof scraped samples that will be accepted. This overrides any\\n`spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects\\nunless `spec.sampleLimit` is greater than zero and less than\\n`spec.enforcedSampleLimit`.\\n\\n\\nIt is meant to be used by admins to keep the overall number of\\nsamples/series under a desired limit.\\n\\n\\nWhen both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.\\n* Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value.\\n* Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit."', args=[d.arg(name='enforcedSampleLimit', type=d.T.integer)]), + withEnforcedSampleLimit(enforcedSampleLimit): { spec+: { enforcedSampleLimit: enforcedSampleLimit } }, + '#withEnforcedTargetLimit':: d.fn(help='"When defined, enforcedTargetLimit specifies a global limit on the number\\nof scraped targets. The value overrides any `spec.targetLimit` set by\\nServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is\\ngreater than zero and less than `spec.enforcedTargetLimit`.\\n\\n\\nIt is meant to be used by admins to to keep the overall number of\\ntargets under a desired limit.\\n\\n\\nWhen both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply:\\n* Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).\\n If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.\\n* Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value.\\n* Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit."', args=[d.arg(name='enforcedTargetLimit', type=d.T.integer)]), + withEnforcedTargetLimit(enforcedTargetLimit): { spec+: { enforcedTargetLimit: enforcedTargetLimit } }, + '#withExcludedFromEnforcement':: d.fn(help='"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\\nto be excluded from enforcing a namespace label of origin.\\n\\n\\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true."', args=[d.arg(name='excludedFromEnforcement', type=d.T.array)]), + withExcludedFromEnforcement(excludedFromEnforcement): { spec+: { excludedFromEnforcement: if std.isArray(v=excludedFromEnforcement) then excludedFromEnforcement else [excludedFromEnforcement] } }, + '#withExcludedFromEnforcementMixin':: d.fn(help='"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\\nto be excluded from enforcing a namespace label of origin.\\n\\n\\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='excludedFromEnforcement', type=d.T.array)]), + withExcludedFromEnforcementMixin(excludedFromEnforcement): { spec+: { excludedFromEnforcement+: if std.isArray(v=excludedFromEnforcement) then excludedFromEnforcement else [excludedFromEnforcement] } }, + '#withExternalLabels':: d.fn(help='"The labels to add to any time series or alerts when communicating with\\nexternal systems (federation, remote storage, Alertmanager).\\nLabels defined by `spec.replicaExternalLabelName` and\\n`spec.prometheusExternalLabelName` take precedence over this list."', args=[d.arg(name='externalLabels', type=d.T.object)]), + withExternalLabels(externalLabels): { spec+: { externalLabels: externalLabels } }, + '#withExternalLabelsMixin':: d.fn(help='"The labels to add to any time series or alerts when communicating with\\nexternal systems (federation, remote storage, Alertmanager).\\nLabels defined by `spec.replicaExternalLabelName` and\\n`spec.prometheusExternalLabelName` take precedence over this list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='externalLabels', type=d.T.object)]), + withExternalLabelsMixin(externalLabels): { spec+: { externalLabels+: externalLabels } }, + '#withExternalUrl':: d.fn(help='"The external URL under which the Prometheus service is externally\\navailable. This is necessary to generate correct URLs (for instance if\\nPrometheus is accessible behind an Ingress resource)."', args=[d.arg(name='externalUrl', type=d.T.string)]), + withExternalUrl(externalUrl): { spec+: { externalUrl: externalUrl } }, + '#withHostAliases':: d.fn(help="\"Optional list of hosts and IPs that will be injected into the Pod's\\nhosts file if specified.\"", args=[d.arg(name='hostAliases', type=d.T.array)]), + withHostAliases(hostAliases): { spec+: { hostAliases: if std.isArray(v=hostAliases) then hostAliases else [hostAliases] } }, + '#withHostAliasesMixin':: d.fn(help="\"Optional list of hosts and IPs that will be injected into the Pod's\\nhosts file if specified.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='hostAliases', type=d.T.array)]), + withHostAliasesMixin(hostAliases): { spec+: { hostAliases+: if std.isArray(v=hostAliases) then hostAliases else [hostAliases] } }, + '#withHostNetwork':: d.fn(help="\"Use the host's network namespace if true.\\n\\n\\nMake sure to understand the security implications if you want to enable\\nit (https://kubernetes.io/docs/concepts/configuration/overview/).\\n\\n\\nWhen hostNetwork is enabled, this will set the DNS policy to\\n`ClusterFirstWithHostNet` automatically.\"", args=[d.arg(name='hostNetwork', type=d.T.boolean)]), + withHostNetwork(hostNetwork): { spec+: { hostNetwork: hostNetwork } }, + '#withIgnoreNamespaceSelectors':: d.fn(help='"When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor\\nand Probe objects will be ignored. They will only discover targets\\nwithin the namespace of the PodMonitor, ServiceMonitor and Probe\\nobject."', args=[d.arg(name='ignoreNamespaceSelectors', type=d.T.boolean)]), + withIgnoreNamespaceSelectors(ignoreNamespaceSelectors): { spec+: { ignoreNamespaceSelectors: ignoreNamespaceSelectors } }, + '#withImage':: d.fn(help='"Container image name for Prometheus. If specified, it takes precedence\\nover the `spec.baseImage`, `spec.tag` and `spec.sha` fields.\\n\\n\\nSpecifying `spec.version` is still necessary to ensure the Prometheus\\nOperator knows which version of Prometheus is being configured.\\n\\n\\nIf neither `spec.image` nor `spec.baseImage` are defined, the operator\\nwill use the latest upstream version of Prometheus available at the time\\nwhen the operator was released."', args=[d.arg(name='image', type=d.T.string)]), + withImage(image): { spec+: { image: image } }, + '#withImagePullPolicy':: d.fn(help="\"Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers.\\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.\"", args=[d.arg(name='imagePullPolicy', type=d.T.string)]), + withImagePullPolicy(imagePullPolicy): { spec+: { imagePullPolicy: imagePullPolicy } }, + '#withImagePullSecrets':: d.fn(help='"An optional list of references to Secrets in the same namespace\\nto use for pulling images from registries.\\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"', args=[d.arg(name='imagePullSecrets', type=d.T.array)]), + withImagePullSecrets(imagePullSecrets): { spec+: { imagePullSecrets: if std.isArray(v=imagePullSecrets) then imagePullSecrets else [imagePullSecrets] } }, + '#withImagePullSecretsMixin':: d.fn(help='"An optional list of references to Secrets in the same namespace\\nto use for pulling images from registries.\\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='imagePullSecrets', type=d.T.array)]), + withImagePullSecretsMixin(imagePullSecrets): { spec+: { imagePullSecrets+: if std.isArray(v=imagePullSecrets) then imagePullSecrets else [imagePullSecrets] } }, + '#withInitContainers':: d.fn(help='"InitContainers allows injecting initContainers to the Pod definition. Those\\ncan be used to e.g. fetch secrets for injection into the Prometheus\\nconfiguration from external sources. Any errors during the execution of\\nan initContainer will lead to a restart of the Pod. More info:\\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nInitContainers described here modify an operator generated init\\ncontainers if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of init container name managed by the operator are:\\n* `init-config-reloader`.\\n\\n\\nOverriding init containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainers(initContainers): { spec+: { initContainers: if std.isArray(v=initContainers) then initContainers else [initContainers] } }, + '#withInitContainersMixin':: d.fn(help='"InitContainers allows injecting initContainers to the Pod definition. Those\\ncan be used to e.g. fetch secrets for injection into the Prometheus\\nconfiguration from external sources. Any errors during the execution of\\nan initContainer will lead to a restart of the Pod. More info:\\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\\nInitContainers described here modify an operator generated init\\ncontainers if they share the same name and modifications are done via a\\nstrategic merge patch.\\n\\n\\nThe names of init container name managed by the operator are:\\n* `init-config-reloader`.\\n\\n\\nOverriding init containers is entirely outside the scope of what the\\nmaintainers will support and by doing so, you accept that this behaviour\\nmay break at any time without notice."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='initContainers', type=d.T.array)]), + withInitContainersMixin(initContainers): { spec+: { initContainers+: if std.isArray(v=initContainers) then initContainers else [initContainers] } }, + '#withKeepDroppedTargets':: d.fn(help="\"Per-scrape limit on the number of targets dropped by relabeling\\nthat will be kept in memory. 0 means no limit.\\n\\n\\nIt requires Prometheus \u003e= v2.47.0.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.\"", args=[d.arg(name='keepDroppedTargets', type=d.T.integer)]), + withKeepDroppedTargets(keepDroppedTargets): { spec+: { keepDroppedTargets: keepDroppedTargets } }, + '#withLabelLimit':: d.fn(help="\"Per-scrape limit on number of labels that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.\"", args=[d.arg(name='labelLimit', type=d.T.integer)]), + withLabelLimit(labelLimit): { spec+: { labelLimit: labelLimit } }, + '#withLabelNameLengthLimit':: d.fn(help="\"Per-scrape limit on length of labels name that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.\"", args=[d.arg(name='labelNameLengthLimit', type=d.T.integer)]), + withLabelNameLengthLimit(labelNameLengthLimit): { spec+: { labelNameLengthLimit: labelNameLengthLimit } }, + '#withLabelValueLengthLimit':: d.fn(help="\"Per-scrape limit on length of labels value that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.\"", args=[d.arg(name='labelValueLengthLimit', type=d.T.integer)]), + withLabelValueLengthLimit(labelValueLengthLimit): { spec+: { labelValueLengthLimit: labelValueLengthLimit } }, + '#withListenLocal':: d.fn(help="\"When true, the Prometheus server listens on the loopback address\\ninstead of the Pod IP's address.\"", args=[d.arg(name='listenLocal', type=d.T.boolean)]), + withListenLocal(listenLocal): { spec+: { listenLocal: listenLocal } }, + '#withLogFormat':: d.fn(help='"Log format for Log level for Prometheus and the config-reloader sidecar."', args=[d.arg(name='logFormat', type=d.T.string)]), + withLogFormat(logFormat): { spec+: { logFormat: logFormat } }, + '#withLogLevel':: d.fn(help='"Log level for Prometheus and the config-reloader sidecar."', args=[d.arg(name='logLevel', type=d.T.string)]), + withLogLevel(logLevel): { spec+: { logLevel: logLevel } }, + '#withMaximumStartupDurationSeconds':: d.fn(help="\"Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete.\\nIf set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes).\"", args=[d.arg(name='maximumStartupDurationSeconds', type=d.T.integer)]), + withMaximumStartupDurationSeconds(maximumStartupDurationSeconds): { spec+: { maximumStartupDurationSeconds: maximumStartupDurationSeconds } }, + '#withMinReadySeconds':: d.fn(help='"Minimum number of seconds for which a newly created Pod should be ready\\nwithout any of its container crashing for it to be considered available.\\nDefaults to 0 (pod will be considered available as soon as it is ready)\\n\\n\\nThis is an alpha field from kubernetes 1.22 until 1.24 which requires\\nenabling the StatefulSetMinReadySeconds feature gate."', args=[d.arg(name='minReadySeconds', type=d.T.integer)]), + withMinReadySeconds(minReadySeconds): { spec+: { minReadySeconds: minReadySeconds } }, + '#withMode':: d.fn(help='"Mode defines how the Prometheus operator deploys the PrometheusAgent pod(s).\\nFor now this field has no effect.\\n\\n\\n(Alpha) Using this field requires the `PrometheusAgentDaemonSet` feature gate to be enabled."', args=[d.arg(name='mode', type=d.T.string)]), + withMode(mode): { spec+: { mode: mode } }, + '#withNodeSelector':: d.fn(help='"Defines on which Nodes the Pods are scheduled."', args=[d.arg(name='nodeSelector', type=d.T.object)]), + withNodeSelector(nodeSelector): { spec+: { nodeSelector: nodeSelector } }, + '#withNodeSelectorMixin':: d.fn(help='"Defines on which Nodes the Pods are scheduled."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeSelector', type=d.T.object)]), + withNodeSelectorMixin(nodeSelector): { spec+: { nodeSelector+: nodeSelector } }, + '#withOverrideHonorLabels':: d.fn(help='"When true, Prometheus resolves label conflicts by renaming the labels in the scraped data\\n to “exported_” for all targets created from ServiceMonitor, PodMonitor and\\nScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies.\\nIn practice,`overrideHonorLaels:true` enforces `honorLabels:false`\\nfor all ServiceMonitor, PodMonitor and ScrapeConfig objects."', args=[d.arg(name='overrideHonorLabels', type=d.T.boolean)]), + withOverrideHonorLabels(overrideHonorLabels): { spec+: { overrideHonorLabels: overrideHonorLabels } }, + '#withOverrideHonorTimestamps':: d.fn(help='"When true, Prometheus ignores the timestamps for all the targets created\\nfrom service and pod monitors.\\nOtherwise the HonorTimestamps field of the service or pod monitor applies."', args=[d.arg(name='overrideHonorTimestamps', type=d.T.boolean)]), + withOverrideHonorTimestamps(overrideHonorTimestamps): { spec+: { overrideHonorTimestamps: overrideHonorTimestamps } }, + '#withPaused':: d.fn(help='"When a Prometheus deployment is paused, no actions except for deletion\\nwill be performed on the underlying objects."', args=[d.arg(name='paused', type=d.T.boolean)]), + withPaused(paused): { spec+: { paused: paused } }, + '#withPodTargetLabels':: d.fn(help='"PodTargetLabels are appended to the `spec.podTargetLabels` field of all\\nPodMonitor and ServiceMonitor objects."', args=[d.arg(name='podTargetLabels', type=d.T.array)]), + withPodTargetLabels(podTargetLabels): { spec+: { podTargetLabels: if std.isArray(v=podTargetLabels) then podTargetLabels else [podTargetLabels] } }, + '#withPodTargetLabelsMixin':: d.fn(help='"PodTargetLabels are appended to the `spec.podTargetLabels` field of all\\nPodMonitor and ServiceMonitor objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='podTargetLabels', type=d.T.array)]), + withPodTargetLabelsMixin(podTargetLabels): { spec+: { podTargetLabels+: if std.isArray(v=podTargetLabels) then podTargetLabels else [podTargetLabels] } }, + '#withPortName':: d.fn(help='"Port name used for the pods and governing service.\\nDefault: \\"web\\', args=[d.arg(name='portName', type=d.T.string)]), + withPortName(portName): { spec+: { portName: portName } }, + '#withPriorityClassName':: d.fn(help='"Priority class assigned to the Pods."', args=[d.arg(name='priorityClassName', type=d.T.string)]), + withPriorityClassName(priorityClassName): { spec+: { priorityClassName: priorityClassName } }, + '#withPrometheusExternalLabelName':: d.fn(help='"Name of Prometheus external label used to denote the Prometheus instance\\nname. The external label will _not_ be added when the field is set to\\nthe empty string (`\\"\\"`).\\n\\n\\nDefault: \\"prometheus\\', args=[d.arg(name='prometheusExternalLabelName', type=d.T.string)]), + withPrometheusExternalLabelName(prometheusExternalLabelName): { spec+: { prometheusExternalLabelName: prometheusExternalLabelName } }, + '#withReloadStrategy':: d.fn(help='"Defines the strategy used to reload the Prometheus configuration.\\nIf not specified, the configuration is reloaded using the /-/reload HTTP endpoint."', args=[d.arg(name='reloadStrategy', type=d.T.string)]), + withReloadStrategy(reloadStrategy): { spec+: { reloadStrategy: reloadStrategy } }, + '#withRemoteWrite':: d.fn(help='"Defines the list of remote write configurations."', args=[d.arg(name='remoteWrite', type=d.T.array)]), + withRemoteWrite(remoteWrite): { spec+: { remoteWrite: if std.isArray(v=remoteWrite) then remoteWrite else [remoteWrite] } }, + '#withRemoteWriteMixin':: d.fn(help='"Defines the list of remote write configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='remoteWrite', type=d.T.array)]), + withRemoteWriteMixin(remoteWrite): { spec+: { remoteWrite+: if std.isArray(v=remoteWrite) then remoteWrite else [remoteWrite] } }, + '#withReplicaExternalLabelName':: d.fn(help='"Name of Prometheus external label used to denote the replica name.\\nThe external label will _not_ be added when the field is set to the\\nempty string (`\\"\\"`).\\n\\n\\nDefault: \\"prometheus_replica\\', args=[d.arg(name='replicaExternalLabelName', type=d.T.string)]), + withReplicaExternalLabelName(replicaExternalLabelName): { spec+: { replicaExternalLabelName: replicaExternalLabelName } }, + '#withReplicas':: d.fn(help='"Number of replicas of each shard to deploy for a Prometheus deployment.\\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\\ncreated.\\n\\n\\nDefault: 1"', args=[d.arg(name='replicas', type=d.T.integer)]), + withReplicas(replicas): { spec+: { replicas: replicas } }, + '#withRoutePrefix':: d.fn(help='"The route prefix Prometheus registers HTTP handlers for.\\n\\n\\nThis is useful when using `spec.externalURL`, and a proxy is rewriting\\nHTTP routes of a request, and the actual ExternalURL is still true, but\\nthe server serves requests under a different route prefix. For example\\nfor use with `kubectl proxy`."', args=[d.arg(name='routePrefix', type=d.T.string)]), + withRoutePrefix(routePrefix): { spec+: { routePrefix: routePrefix } }, + '#withSampleLimit':: d.fn(help="\"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.\"", args=[d.arg(name='sampleLimit', type=d.T.integer)]), + withSampleLimit(sampleLimit): { spec+: { sampleLimit: sampleLimit } }, + '#withScrapeClasses':: d.fn(help='"List of scrape classes to expose to scraping objects such as\\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."', args=[d.arg(name='scrapeClasses', type=d.T.array)]), + withScrapeClasses(scrapeClasses): { spec+: { scrapeClasses: if std.isArray(v=scrapeClasses) then scrapeClasses else [scrapeClasses] } }, + '#withScrapeClassesMixin':: d.fn(help='"List of scrape classes to expose to scraping objects such as\\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\\n\\n\\nThis is an *experimental feature*, it may change in any upcoming release\\nin a breaking way."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scrapeClasses', type=d.T.array)]), + withScrapeClassesMixin(scrapeClasses): { spec+: { scrapeClasses+: if std.isArray(v=scrapeClasses) then scrapeClasses else [scrapeClasses] } }, + '#withScrapeInterval':: d.fn(help='"Interval between consecutive scrapes.\\n\\n\\nDefault: \\"30s\\', args=[d.arg(name='scrapeInterval', type=d.T.string)]), + withScrapeInterval(scrapeInterval): { spec+: { scrapeInterval: scrapeInterval } }, + '#withScrapeProtocols':: d.fn(help='"The protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocols(scrapeProtocols): { spec+: { scrapeProtocols: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeProtocolsMixin':: d.fn(help='"The protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocolsMixin(scrapeProtocols): { spec+: { scrapeProtocols+: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeTimeout':: d.fn(help='"Number of seconds to wait until a scrape request times out."', args=[d.arg(name='scrapeTimeout', type=d.T.string)]), + withScrapeTimeout(scrapeTimeout): { spec+: { scrapeTimeout: scrapeTimeout } }, + '#withSecrets':: d.fn(help="\"Secrets is a list of Secrets in the same namespace as the Prometheus\\nobject, which shall be mounted into the Prometheus Pods.\\nEach Secret is added to the StatefulSet definition as a volume named `secret-\u003csecret-name\u003e`.\\nThe Secrets are mounted into /etc/prometheus/secrets/\u003csecret-name\u003e in the 'prometheus' container.\"", args=[d.arg(name='secrets', type=d.T.array)]), + withSecrets(secrets): { spec+: { secrets: if std.isArray(v=secrets) then secrets else [secrets] } }, + '#withSecretsMixin':: d.fn(help="\"Secrets is a list of Secrets in the same namespace as the Prometheus\\nobject, which shall be mounted into the Prometheus Pods.\\nEach Secret is added to the StatefulSet definition as a volume named `secret-\u003csecret-name\u003e`.\\nThe Secrets are mounted into /etc/prometheus/secrets/\u003csecret-name\u003e in the 'prometheus' container.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='secrets', type=d.T.array)]), + withSecretsMixin(secrets): { spec+: { secrets+: if std.isArray(v=secrets) then secrets else [secrets] } }, + '#withServiceAccountName':: d.fn(help='"ServiceAccountName is the name of the ServiceAccount to use to run the\\nPrometheus Pods."', args=[d.arg(name='serviceAccountName', type=d.T.string)]), + withServiceAccountName(serviceAccountName): { spec+: { serviceAccountName: serviceAccountName } }, + '#withServiceDiscoveryRole':: d.fn(help='"Defines the service discovery role used to discover targets from\\n`ServiceMonitor` objects and Alertmanager endpoints.\\n\\n\\nIf set, the value should be either \\"Endpoints\\" or \\"EndpointSlice\\".\\nIf unset, the operator assumes the \\"Endpoints\\" role."', args=[d.arg(name='serviceDiscoveryRole', type=d.T.string)]), + withServiceDiscoveryRole(serviceDiscoveryRole): { spec+: { serviceDiscoveryRole: serviceDiscoveryRole } }, + '#withShards':: d.fn(help='"Number of shards to distribute targets onto. `spec.replicas`\\nmultiplied by `spec.shards` is the total number of Pods created.\\n\\n\\nNote that scaling down shards will not reshard data onto remaining\\ninstances, it must be manually moved. Increasing shards will not reshard\\ndata either but it will continue to be available from the same\\ninstances. To query globally, use Thanos sidecar and Thanos querier or\\nremote write data to a central location.\\n\\n\\nSharding is performed on the content of the `__address__` target meta-label\\nfor PodMonitors and ServiceMonitors and `__param_target__` for Probes.\\n\\n\\nDefault: 1"', args=[d.arg(name='shards', type=d.T.integer)]), + withShards(shards): { spec+: { shards: shards } }, + '#withTargetLimit':: d.fn(help="\"TargetLimit defines a limit on the number of scraped targets that will be accepted.\\nOnly valid in Prometheus versions 2.45.0 and newer.\\n\\n\\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.\"", args=[d.arg(name='targetLimit', type=d.T.integer)]), + withTargetLimit(targetLimit): { spec+: { targetLimit: targetLimit } }, + '#withTolerations':: d.fn(help="\"Defines the Pods' tolerations if specified.\"", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerations(tolerations): { spec+: { tolerations: if std.isArray(v=tolerations) then tolerations else [tolerations] } }, + '#withTolerationsMixin':: d.fn(help="\"Defines the Pods' tolerations if specified.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='tolerations', type=d.T.array)]), + withTolerationsMixin(tolerations): { spec+: { tolerations+: if std.isArray(v=tolerations) then tolerations else [tolerations] } }, + '#withTopologySpreadConstraints':: d.fn(help="\"Defines the pod's topology spread constraints if specified.\"", args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), + withTopologySpreadConstraints(topologySpreadConstraints): { spec+: { topologySpreadConstraints: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, + '#withTopologySpreadConstraintsMixin':: d.fn(help="\"Defines the pod's topology spread constraints if specified.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='topologySpreadConstraints', type=d.T.array)]), + withTopologySpreadConstraintsMixin(topologySpreadConstraints): { spec+: { topologySpreadConstraints+: if std.isArray(v=topologySpreadConstraints) then topologySpreadConstraints else [topologySpreadConstraints] } }, + '#withVersion':: d.fn(help='"Version of Prometheus being deployed. The operator uses this information\\nto generate the Prometheus StatefulSet + configuration files.\\n\\n\\nIf not specified, the operator assumes the latest upstream version of\\nPrometheus available at the time when the version of the operator was\\nreleased."', args=[d.arg(name='version', type=d.T.string)]), + withVersion(version): { spec+: { version: version } }, + '#withVolumeMounts':: d.fn(help="\"VolumeMounts allows the configuration of additional VolumeMounts.\\n\\n\\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\\ncontainer, that are generated as a result of StorageSpec objects.\"", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMounts(volumeMounts): { spec+: { volumeMounts: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } }, + '#withVolumeMountsMixin':: d.fn(help="\"VolumeMounts allows the configuration of additional VolumeMounts.\\n\\n\\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\\ncontainer, that are generated as a result of StorageSpec objects.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='volumeMounts', type=d.T.array)]), + withVolumeMountsMixin(volumeMounts): { spec+: { volumeMounts+: if std.isArray(v=volumeMounts) then volumeMounts else [volumeMounts] } }, + '#withVolumes':: d.fn(help='"Volumes allows the configuration of additional volumes on the output\\nStatefulSet definition. Volumes specified will be appended to other\\nvolumes that are generated as a result of StorageSpec objects."', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumes(volumes): { spec+: { volumes: if std.isArray(v=volumes) then volumes else [volumes] } }, + '#withVolumesMixin':: d.fn(help='"Volumes allows the configuration of additional volumes on the output\\nStatefulSet definition. Volumes specified will be appended to other\\nvolumes that are generated as a result of StorageSpec objects."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='volumes', type=d.T.array)]), + withVolumesMixin(volumes): { spec+: { volumes+: if std.isArray(v=volumes) then volumes else [volumes] } }, + '#withWalCompression':: d.fn(help='"Configures compression of the write-ahead log (WAL) using Snappy.\\n\\n\\nWAL compression is enabled by default for Prometheus >= 2.20.0\\n\\n\\nRequires Prometheus v2.11.0 and above."', args=[d.arg(name='walCompression', type=d.T.boolean)]), + withWalCompression(walCompression): { spec+: { walCompression: walCompression } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/_gen/monitoring/v1alpha1/scrapeConfig.libsonnet b/0.14/_gen/monitoring/v1alpha1/scrapeConfig.libsonnet new file mode 100644 index 0000000..83bd538 --- /dev/null +++ b/0.14/_gen/monitoring/v1alpha1/scrapeConfig.libsonnet @@ -0,0 +1,3829 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='scrapeConfig', url='', help='"ScrapeConfig defines a namespaced Prometheus scrape_config to be aggregated across\\nmultiple namespaces into the Prometheus configuration."'), + '#metadata':: d.obj(help='"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."'), + metadata: { + '#withAnnotations':: d.fn(help='"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"', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotations(annotations): { metadata+: { annotations: annotations } }, + '#withAnnotationsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='annotations', type=d.T.object)]), + withAnnotationsMixin(annotations): { metadata+: { annotations+: annotations } }, + '#withClusterName':: d.fn(help='"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."', args=[d.arg(name='clusterName', type=d.T.string)]), + withClusterName(clusterName): { metadata+: { clusterName: clusterName } }, + '#withCreationTimestamp':: d.fn(help='"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."', args=[d.arg(name='creationTimestamp', type=d.T.string)]), + withCreationTimestamp(creationTimestamp): { metadata+: { creationTimestamp: creationTimestamp } }, + '#withDeletionGracePeriodSeconds':: d.fn(help='"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."', args=[d.arg(name='deletionGracePeriodSeconds', type=d.T.integer)]), + withDeletionGracePeriodSeconds(deletionGracePeriodSeconds): { metadata+: { deletionGracePeriodSeconds: deletionGracePeriodSeconds } }, + '#withDeletionTimestamp':: d.fn(help='"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."', args=[d.arg(name='deletionTimestamp', type=d.T.string)]), + withDeletionTimestamp(deletionTimestamp): { metadata+: { deletionTimestamp: deletionTimestamp } }, + '#withFinalizers':: d.fn(help='"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."', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizers(finalizers): { metadata+: { finalizers: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withFinalizersMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='finalizers', type=d.T.array)]), + withFinalizersMixin(finalizers): { metadata+: { finalizers+: if std.isArray(v=finalizers) then finalizers else [finalizers] } }, + '#withGenerateName':: d.fn(help='"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"', args=[d.arg(name='generateName', type=d.T.string)]), + withGenerateName(generateName): { metadata+: { generateName: generateName } }, + '#withGeneration':: d.fn(help='"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."', args=[d.arg(name='generation', type=d.T.integer)]), + withGeneration(generation): { metadata+: { generation: generation } }, + '#withLabels':: d.fn(help='"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"', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { metadata+: { labels: labels } }, + '#withLabelsMixin':: d.fn(help='"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"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { metadata+: { labels+: labels } }, + '#withName':: d.fn(help='"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"', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { metadata+: { name: name } }, + '#withNamespace':: d.fn(help='"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"', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { metadata+: { namespace: namespace } }, + '#withOwnerReferences':: d.fn(help='"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."', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferences(ownerReferences): { metadata+: { ownerReferences: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withOwnerReferencesMixin':: d.fn(help='"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."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ownerReferences', type=d.T.array)]), + withOwnerReferencesMixin(ownerReferences): { metadata+: { ownerReferences+: if std.isArray(v=ownerReferences) then ownerReferences else [ownerReferences] } }, + '#withResourceVersion':: d.fn(help='"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"', args=[d.arg(name='resourceVersion', type=d.T.string)]), + withResourceVersion(resourceVersion): { metadata+: { resourceVersion: resourceVersion } }, + '#withSelfLink':: d.fn(help='"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."', args=[d.arg(name='selfLink', type=d.T.string)]), + withSelfLink(selfLink): { metadata+: { selfLink: selfLink } }, + '#withUid':: d.fn(help='"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"', args=[d.arg(name='uid', type=d.T.string)]), + withUid(uid): { metadata+: { uid: uid } }, + }, + '#new':: d.fn(help='new returns an instance of ScrapeConfig', args=[d.arg(name='name', type=d.T.string)]), + new(name): { + apiVersion: 'monitoring.coreos.com/v1alpha1', + kind: 'ScrapeConfig', + } + self.metadata.withName(name=name), + '#spec':: d.obj(help='"ScrapeConfigSpec is a specification of the desired configuration for a scrape configuration."'), + spec: { + '#authorization':: d.obj(help='"Authorization header to use on every scrape request."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { authorization+: { credentials+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { authorization+: { credentials+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { authorization+: { credentials+: { optional: optional } } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { spec+: { authorization+: { type: type } } }, + }, + '#azureSDConfigs':: d.obj(help='"AzureSDConfigs defines a list of Azure service discovery configurations."'), + azureSDConfigs: { + '#clientSecret':: d.obj(help='"Optional client secret. Only required with the OAuth authentication method."'), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { clientSecret+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { clientSecret+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { clientSecret+: { optional: optional } }, + }, + '#withAuthenticationMethod':: d.fn(help='"# The authentication method, either `OAuth` or `ManagedIdentity` or `SDK`.\\nSee https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview\\nSDK authentication method uses environment variables by default.\\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication"', args=[d.arg(name='authenticationMethod', type=d.T.string)]), + withAuthenticationMethod(authenticationMethod): { authenticationMethod: authenticationMethod }, + '#withClientID':: d.fn(help='"Optional client ID. Only required with the OAuth authentication method."', args=[d.arg(name='clientID', type=d.T.string)]), + withClientID(clientID): { clientID: clientID }, + '#withEnvironment':: d.fn(help='"The Azure environment."', args=[d.arg(name='environment', type=d.T.string)]), + withEnvironment(environment): { environment: environment }, + '#withPort':: d.fn(help='"The port to scrape metrics from. If using the public IP address, this must\\ninstead be specified in the relabeling rule."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withRefreshInterval':: d.fn(help='"RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withResourceGroup':: d.fn(help='"Optional resource group name. Limits discovery to this resource group."', args=[d.arg(name='resourceGroup', type=d.T.string)]), + withResourceGroup(resourceGroup): { resourceGroup: resourceGroup }, + '#withSubscriptionID':: d.fn(help='"The subscription ID. Always required."', args=[d.arg(name='subscriptionID', type=d.T.string)]), + withSubscriptionID(subscriptionID): { subscriptionID: subscriptionID }, + '#withTenantID':: d.fn(help='"Optional tenant ID. Only required with the OAuth authentication method."', args=[d.arg(name='tenantID', type=d.T.string)]), + withTenantID(tenantID): { tenantID: tenantID }, + }, + '#basicAuth':: d.obj(help='"BasicAuth information to use on every scrape request."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { basicAuth+: { password+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { basicAuth+: { password+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { basicAuth+: { password+: { optional: optional } } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { basicAuth+: { username+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { basicAuth+: { username+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { basicAuth+: { username+: { optional: optional } } } }, + }, + }, + '#consulSDConfigs':: d.obj(help='"ConsulSDConfigs defines a list of Consul service discovery configurations."'), + consulSDConfigs: { + '#authorization':: d.obj(help='"Authorization header configuration to authenticate against the Consul Server."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth information to authenticate against the Consul Server.\\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints"'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS Config"'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#tokenRef':: d.obj(help='"Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent."'), + tokenRef: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tokenRef+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tokenRef+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tokenRef+: { optional: optional } }, + }, + '#withAllowStale':: d.fn(help='"Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.\\nIf unset, Prometheus uses its default value."', args=[d.arg(name='allowStale', type=d.T.boolean)]), + withAllowStale(allowStale): { allowStale: allowStale }, + '#withDatacenter':: d.fn(help='"Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter."', args=[d.arg(name='datacenter', type=d.T.string)]), + withDatacenter(datacenter): { datacenter: datacenter }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2.\\nIf unset, Prometheus uses its default value."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects.\\nIf unset, Prometheus uses its default value."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNamespace':: d.fn(help='"Namespaces are only supported in Consul Enterprise."', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withNodeMeta':: d.fn(help='"Node metadata key/value pairs to filter nodes for a given service."', args=[d.arg(name='nodeMeta', type=d.T.object)]), + withNodeMeta(nodeMeta): { nodeMeta: nodeMeta }, + '#withNodeMetaMixin':: d.fn(help='"Node metadata key/value pairs to filter nodes for a given service."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nodeMeta', type=d.T.object)]), + withNodeMetaMixin(nodeMeta): { nodeMeta+: nodeMeta }, + '#withPartition':: d.fn(help='"Admin Partitions are only supported in Consul Enterprise."', args=[d.arg(name='partition', type=d.T.string)]), + withPartition(partition): { partition: partition }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"The time after which the provided names are refreshed.\\nOn large setup it might be a good idea to increase this value because the catalog will change all the time.\\nIf unset, Prometheus uses its default value."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withScheme':: d.fn(help='"HTTP Scheme default \\"http\\', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { scheme: scheme }, + '#withServer':: d.fn(help='"A valid string consisting of a hostname or IP followed by an optional port number."', args=[d.arg(name='server', type=d.T.string)]), + withServer(server): { server: server }, + '#withServices':: d.fn(help='"A list of services for which targets are retrieved. If omitted, all services are scraped."', args=[d.arg(name='services', type=d.T.array)]), + withServices(services): { services: if std.isArray(v=services) then services else [services] }, + '#withServicesMixin':: d.fn(help='"A list of services for which targets are retrieved. If omitted, all services are scraped."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='services', type=d.T.array)]), + withServicesMixin(services): { services+: if std.isArray(v=services) then services else [services] }, + '#withTagSeparator':: d.fn(help='"The string by which Consul tags are joined into the tag label.\\nIf unset, Prometheus uses its default value."', args=[d.arg(name='tagSeparator', type=d.T.string)]), + withTagSeparator(tagSeparator): { tagSeparator: tagSeparator }, + '#withTags':: d.fn(help='"An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list."', args=[d.arg(name='tags', type=d.T.array)]), + withTags(tags): { tags: if std.isArray(v=tags) then tags else [tags] }, + '#withTagsMixin':: d.fn(help='"An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tags', type=d.T.array)]), + withTagsMixin(tags): { tags+: if std.isArray(v=tags) then tags else [tags] }, + }, + '#digitalOceanSDConfigs':: d.obj(help='"DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations."'), + digitalOceanSDConfigs: { + '#authorization':: d.obj(help='"Authorization header configuration to authenticate against the DigitalOcean API.\\nCannot be set at the same time as `oauth2`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration.\\nCannot be set at the same time as `authorization`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration applying to the target HTTP endpoint."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withPort':: d.fn(help='"The port to scrape metrics from."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"Refresh interval to re-read the instance list."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + }, + '#dnsSDConfigs':: d.obj(help='"DNSSDConfigs defines a list of DNS service discovery configurations."'), + dnsSDConfigs: { + '#withNames':: d.fn(help='"A list of DNS domain names to be queried."', args=[d.arg(name='names', type=d.T.array)]), + withNames(names): { names: if std.isArray(v=names) then names else [names] }, + '#withNamesMixin':: d.fn(help='"A list of DNS domain names to be queried."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='names', type=d.T.array)]), + withNamesMixin(names): { names+: if std.isArray(v=names) then names else [names] }, + '#withPort':: d.fn(help='"The port number used if the query type is not SRV\\nIgnored for SRV records"', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withRefreshInterval':: d.fn(help='"RefreshInterval configures the time after which the provided names are refreshed.\\nIf not set, Prometheus uses its default value."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withType':: d.fn(help='"The type of DNS query to perform. One of SRV, A, AAAA, MX or NS.\\nIf not set, Prometheus uses its default value.\\n\\n\\nWhen set to NS, it requires Prometheus >= v2.49.0.\\nWhen set to MX, it requires Prometheus >= v2.38.0"', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { type: type }, + }, + '#dockerSDConfigs':: d.obj(help='"DockerSDConfigs defines a list of Docker service discovery configurations."'), + dockerSDConfigs: { + '#authorization':: d.obj(help='"Authorization header configuration to authenticate against the Docker API.\\nCannot be set at the same time as `oauth2`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth information to use on every scrape request."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#filters':: d.obj(help='"Optional filters to limit the discovery process to a subset of the available resources."'), + filters: { + '#withName':: d.fn(help='"Name of the Filter."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValues':: d.fn(help='"Value to filter on."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"Value to filter on."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration.\\nCannot be set at the same time as `authorization`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration applying to the target HTTP endpoint."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFilters':: d.fn(help='"Optional filters to limit the discovery process to a subset of the available resources."', args=[d.arg(name='filters', type=d.T.array)]), + withFilters(filters): { filters: if std.isArray(v=filters) then filters else [filters] }, + '#withFiltersMixin':: d.fn(help='"Optional filters to limit the discovery process to a subset of the available resources."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='filters', type=d.T.array)]), + withFiltersMixin(filters): { filters+: if std.isArray(v=filters) then filters else [filters] }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withHost':: d.fn(help='"Address of the docker daemon"', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { host: host }, + '#withHostNetworkingHost':: d.fn(help='"The host to use if the container is in host networking mode."', args=[d.arg(name='hostNetworkingHost', type=d.T.string)]), + withHostNetworkingHost(hostNetworkingHost): { hostNetworkingHost: hostNetworkingHost }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withPort':: d.fn(help='"The port to scrape metrics from."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"Time after which the container is refreshed."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + }, + '#dockerSwarmSDConfigs':: d.obj(help='"DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations."'), + dockerSwarmSDConfigs: { + '#authorization':: d.obj(help='"Authorization header configuration to authenticate against the target HTTP endpoint."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"Optional HTTP basic authentication information."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#filters':: d.obj(help='"Optional filters to limit the discovery process to a subset of available\\nresources.\\nThe available filters are listed in the upstream documentation:\\nServices: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList\\nTasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList\\nNodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList"'), + filters: { + '#withName':: d.fn(help='"Name of the Filter."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValues':: d.fn(help='"Value to filter on."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"Value to filter on."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration.\\nCannot be set at the same time as `authorization`, or `basicAuth`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use on every scrape request"'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFilters':: d.fn(help='"Optional filters to limit the discovery process to a subset of available\\nresources.\\nThe available filters are listed in the upstream documentation:\\nServices: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList\\nTasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList\\nNodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList"', args=[d.arg(name='filters', type=d.T.array)]), + withFilters(filters): { filters: if std.isArray(v=filters) then filters else [filters] }, + '#withFiltersMixin':: d.fn(help='"Optional filters to limit the discovery process to a subset of available\\nresources.\\nThe available filters are listed in the upstream documentation:\\nServices: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList\\nTasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList\\nNodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='filters', type=d.T.array)]), + withFiltersMixin(filters): { filters+: if std.isArray(v=filters) then filters else [filters] }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withHost':: d.fn(help='"Address of the Docker daemon"', args=[d.arg(name='host', type=d.T.string)]), + withHost(host): { host: host }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withPort':: d.fn(help="\"The port to scrape metrics from, when `role` is nodes, and for discovered\\ntasks and services that don't have published ports.\"", args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"The time after which the service discovery data is refreshed."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withRole':: d.fn(help='"Role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { role: role }, + }, + '#ec2SDConfigs':: d.obj(help='"EC2SDConfigs defines a list of EC2 service discovery configurations."'), + ec2SDConfigs: { + '#accessKey':: d.obj(help='"AccessKey is the AWS API key."'), + accessKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { accessKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { accessKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { accessKey+: { optional: optional } }, + }, + '#filters':: d.obj(help='"Filters can be used optionally to filter the instance list by other criteria.\\nAvailable filter criteria can be found here:\\nhttps://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\\nFilter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html"'), + filters: { + '#withName':: d.fn(help='"Name of the Filter."', args=[d.arg(name='name', type=d.T.string)]), + withName(name): { name: name }, + '#withValues':: d.fn(help='"Value to filter on."', args=[d.arg(name='values', type=d.T.array)]), + withValues(values): { values: if std.isArray(v=values) then values else [values] }, + '#withValuesMixin':: d.fn(help='"Value to filter on."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='values', type=d.T.array)]), + withValuesMixin(values): { values+: if std.isArray(v=values) then values else [values] }, + }, + '#secretKey':: d.obj(help='"SecretKey is the AWS API secret."'), + secretKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { secretKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretKey+: { optional: optional } }, + }, + '#withFilters':: d.fn(help='"Filters can be used optionally to filter the instance list by other criteria.\\nAvailable filter criteria can be found here:\\nhttps://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\\nFilter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html"', args=[d.arg(name='filters', type=d.T.array)]), + withFilters(filters): { filters: if std.isArray(v=filters) then filters else [filters] }, + '#withFiltersMixin':: d.fn(help='"Filters can be used optionally to filter the instance list by other criteria.\\nAvailable filter criteria can be found here:\\nhttps://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\\nFilter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='filters', type=d.T.array)]), + withFiltersMixin(filters): { filters+: if std.isArray(v=filters) then filters else [filters] }, + '#withPort':: d.fn(help='"The port to scrape metrics from. If using the public IP address, this must\\ninstead be specified in the relabeling rule."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withRefreshInterval':: d.fn(help='"RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withRegion':: d.fn(help='"The AWS region"', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { region: region }, + '#withRoleARN':: d.fn(help='"AWS Role ARN, an alternative to using AWS API keys."', args=[d.arg(name='roleARN', type=d.T.string)]), + withRoleARN(roleARN): { roleARN: roleARN }, + }, + '#eurekaSDConfigs':: d.obj(help='"EurekaSDConfigs defines a list of Eureka service discovery configurations."'), + eurekaSDConfigs: { + '#authorization':: d.obj(help='"Authorization header to use on every scrape request."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth information to use on every scrape request."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration.\\nCannot be set at the same time as `authorization` or `basic_auth`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration applying to the target HTTP endpoint."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"Refresh interval to re-read the instance list."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withServer':: d.fn(help='"The URL to connect to the Eureka server."', args=[d.arg(name='server', type=d.T.string)]), + withServer(server): { server: server }, + }, + '#fileSDConfigs':: d.obj(help='"FileSDConfigs defines a list of file service discovery configurations."'), + fileSDConfigs: { + '#withFiles':: d.fn(help='"List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the\\nprometheus-operator project makes no guarantees about the working directory where the configuration file is\\nstored.\\nFiles must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets."', args=[d.arg(name='files', type=d.T.array)]), + withFiles(files): { files: if std.isArray(v=files) then files else [files] }, + '#withFilesMixin':: d.fn(help='"List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the\\nprometheus-operator project makes no guarantees about the working directory where the configuration file is\\nstored.\\nFiles must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='files', type=d.T.array)]), + withFilesMixin(files): { files+: if std.isArray(v=files) then files else [files] }, + '#withRefreshInterval':: d.fn(help='"RefreshInterval configures the refresh interval at which Prometheus will reload the content of the files."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + }, + '#gceSDConfigs':: d.obj(help='"GCESDConfigs defines a list of GCE service discovery configurations."'), + gceSDConfigs: { + '#withFilter':: d.fn(help='"Filter can be used optionally to filter the instance list by other criteria\\nSyntax of this filter is described in the filter query parameter section:\\nhttps://cloud.google.com/compute/docs/reference/latest/instances/list"', args=[d.arg(name='filter', type=d.T.string)]), + withFilter(filter): { filter: filter }, + '#withPort':: d.fn(help='"The port to scrape metrics from. If using the public IP address, this must\\ninstead be specified in the relabeling rule."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProject':: d.fn(help='"The Google Cloud Project ID"', args=[d.arg(name='project', type=d.T.string)]), + withProject(project): { project: project }, + '#withRefreshInterval':: d.fn(help='"RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withTagSeparator':: d.fn(help='"The tag separator is used to separate the tags on concatenation"', args=[d.arg(name='tagSeparator', type=d.T.string)]), + withTagSeparator(tagSeparator): { tagSeparator: tagSeparator }, + '#withZone':: d.fn(help='"The zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs."', args=[d.arg(name='zone', type=d.T.string)]), + withZone(zone): { zone: zone }, + }, + '#hetznerSDConfigs':: d.obj(help='"HetznerSDConfigs defines a list of Hetzner service discovery configurations."'), + hetznerSDConfigs: { + '#authorization':: d.obj(help='"Authorization header configuration, required when role is hcloud.\\nRole robot does not support bearer token authentication."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth information to use on every scrape request, required when role is robot.\\nRole hcloud does not support basic auth."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration.\\nCannot be used at the same time as `basic_auth` or `authorization`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use on every scrape request."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withPort':: d.fn(help='"The port to scrape metrics from."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"The time after which the servers are refreshed."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withRole':: d.fn(help='"The Hetzner role of entities that should be discovered."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { role: role }, + }, + '#httpSDConfigs':: d.obj(help='"HTTPSDConfigs defines a list of HTTP service discovery configurations."'), + httpSDConfigs: { + '#authorization':: d.obj(help='"Authorization header configuration to authenticate against the target HTTP endpoint."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth information to authenticate against the target HTTP endpoint.\\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints"'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration applying to the target HTTP endpoint."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"RefreshInterval configures the refresh interval at which Prometheus will re-query the\\nendpoint to update the target list."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withUrl':: d.fn(help='"URL from which the targets are fetched."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { url: url }, + }, + '#kubernetesSDConfigs':: d.obj(help='"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations."'), + kubernetesSDConfigs: { + '#attachMetadata':: d.obj(help='"Optional metadata to attach to discovered targets.\\nIt requires Prometheus >= v2.35.0 when using the `Pod` role and\\nPrometheus >= v2.37.0 for `Endpoints` and `Endpointslice` roles."'), + attachMetadata: { + '#withNode':: d.fn(help='"Attaches node metadata to discovered targets.\\nWhen set to true, Prometheus must have the `get` permission on the\\n`Nodes` objects.\\nOnly valid for Pod, Endpoint and Endpointslice roles."', args=[d.arg(name='node', type=d.T.boolean)]), + withNode(node): { attachMetadata+: { node: node } }, + }, + '#authorization':: d.obj(help='"Authorization header to use on every scrape request.\\nCannot be set at the same time as `basicAuth`, or `oauth2`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth information to use on every scrape request.\\nCannot be set at the same time as `authorization`, or `oauth2`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#namespaces':: d.obj(help='"Optional namespace discovery. If omitted, Prometheus discovers targets across all namespaces."'), + namespaces: { + '#withNames':: d.fn(help="\"List of namespaces where to watch for resources.\\nIf empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces.\"", args=[d.arg(name='names', type=d.T.array)]), + withNames(names): { namespaces+: { names: if std.isArray(v=names) then names else [names] } }, + '#withNamesMixin':: d.fn(help="\"List of namespaces where to watch for resources.\\nIf empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces.\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='names', type=d.T.array)]), + withNamesMixin(names): { namespaces+: { names+: if std.isArray(v=names) then names else [names] } }, + '#withOwnNamespace':: d.fn(help='"Includes the namespace in which the Prometheus pod runs to the list of watched namespaces."', args=[d.arg(name='ownNamespace', type=d.T.boolean)]), + withOwnNamespace(ownNamespace): { namespaces+: { ownNamespace: ownNamespace } }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration.\\nCannot be set at the same time as `authorization`, or `basicAuth`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#selectors':: d.obj(help='"Selector to select objects.\\nIt requires Prometheus >= v2.17.0"'), + selectors: { + '#withField':: d.fn(help='"An optional field selector to limit the service discovery to resources which have fields with specific values.\\ne.g: `metadata.name=foobar`"', args=[d.arg(name='field', type=d.T.string)]), + withField(field): { field: field }, + '#withLabel':: d.fn(help='"An optional label selector to limit the service discovery to resources with specific labels and label values.\\ne.g: `node.kubernetes.io/instance-type=master`"', args=[d.arg(name='label', type=d.T.string)]), + withLabel(label): { label: label }, + '#withRole':: d.fn(help='"Role specifies the type of Kubernetes resource to limit the service discovery to.\\nAccepted values are: Node, Pod, Endpoints, EndpointSlice, Service, Ingress."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { role: role }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to connect to the Kubernetes API."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withApiServer':: d.fn(help="\"The API server address consisting of a hostname or IP address followed\\nby an optional port number.\\nIf left empty, Prometheus is assumed to run inside\\nof the cluster. It will discover API servers automatically and use the pod's\\nCA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.\"", args=[d.arg(name='apiServer', type=d.T.string)]), + withApiServer(apiServer): { apiServer: apiServer }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRole':: d.fn(help='"Role of the Kubernetes entities that should be discovered.\\nRole `Endpointslice` requires Prometheus >= v2.21.0"', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { role: role }, + '#withSelectors':: d.fn(help='"Selector to select objects.\\nIt requires Prometheus >= v2.17.0"', args=[d.arg(name='selectors', type=d.T.array)]), + withSelectors(selectors): { selectors: if std.isArray(v=selectors) then selectors else [selectors] }, + '#withSelectorsMixin':: d.fn(help='"Selector to select objects.\\nIt requires Prometheus >= v2.17.0"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='selectors', type=d.T.array)]), + withSelectorsMixin(selectors): { selectors+: if std.isArray(v=selectors) then selectors else [selectors] }, + }, + '#kumaSDConfigs':: d.obj(help='"KumaSDConfigs defines a list of Kuma service discovery configurations."'), + kumaSDConfigs: { + '#authorization':: d.obj(help='"Authorization header to use on every scrape request."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth information to use on every scrape request."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration.\\nCannot be set at the same time as `authorization`, or `basicAuth`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use on every scrape request"'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withClientID':: d.fn(help='"Client id is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend."', args=[d.arg(name='clientID', type=d.T.string)]), + withClientID(clientID): { clientID: clientID }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFetchTimeout':: d.fn(help='"The time after which the monitoring assignments are refreshed."', args=[d.arg(name='fetchTimeout', type=d.T.string)]), + withFetchTimeout(fetchTimeout): { fetchTimeout: fetchTimeout }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"The time to wait between polling update requests."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withServer':: d.fn(help="\"Address of the Kuma Control Plane's MADS xDS server.\"", args=[d.arg(name='server', type=d.T.string)]), + withServer(server): { server: server }, + }, + '#lightSailSDConfigs':: d.obj(help='"LightsailSDConfigs defines a list of Lightsail service discovery configurations."'), + lightSailSDConfigs: { + '#accessKey':: d.obj(help='"AccessKey is the AWS API key."'), + accessKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { accessKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { accessKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { accessKey+: { optional: optional } }, + }, + '#authorization':: d.obj(help='"Optional `authorization` HTTP header configuration.\\nCannot be set at the same time as `basicAuth`, or `oauth2`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"Optional HTTP basic authentication information.\\nCannot be set at the same time as `authorization`, or `oauth2`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#oauth2':: d.obj(help='"Optional OAuth2.0 configuration.\\nCannot be set at the same time as `basicAuth`, or `authorization`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#secretKey':: d.obj(help='"SecretKey is the AWS API secret."'), + secretKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { secretKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretKey+: { optional: optional } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to connect to the Puppet DB."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withEnableHTTP2':: d.fn(help='"Configure whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withEndpoint':: d.fn(help='"Custom endpoint to be used."', args=[d.arg(name='endpoint', type=d.T.string)]), + withEndpoint(endpoint): { endpoint: endpoint }, + '#withFollowRedirects':: d.fn(help='"Configure whether the HTTP requests should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withPort':: d.fn(help='"Port to scrape the metrics from.\\nIf using the public IP address, this must instead be specified in the relabeling rule."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"Refresh interval to re-read the list of instances."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withRegion':: d.fn(help='"The AWS region."', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { region: region }, + '#withRoleARN':: d.fn(help='"AWS Role ARN, an alternative to using AWS API keys."', args=[d.arg(name='roleARN', type=d.T.string)]), + withRoleARN(roleARN): { roleARN: roleARN }, + }, + '#linodeSDConfigs':: d.obj(help='"LinodeSDConfigs defines a list of Linode service discovery configurations."'), + linodeSDConfigs: { + '#authorization':: d.obj(help='"Authorization header configuration."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration.\\nCannot be used at the same time as `authorization`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration applying to the target HTTP endpoint."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withPort':: d.fn(help='"Default port to scrape metrics from."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"Time after which the linode instances are refreshed."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withRegion':: d.fn(help='"Optional region to filter on."', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { region: region }, + '#withTagSeparator':: d.fn(help='"The string by which Linode Instance tags are joined into the tag label."', args=[d.arg(name='tagSeparator', type=d.T.string)]), + withTagSeparator(tagSeparator): { tagSeparator: tagSeparator }, + }, + '#metricRelabelings':: d.obj(help='"MetricRelabelConfigs to apply to samples before ingestion."'), + metricRelabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#nomadSDConfigs':: d.obj(help='"NomadSDConfigs defines a list of Nomad service discovery configurations."'), + nomadSDConfigs: { + '#authorization':: d.obj(help='"Authorization header to use on every scrape request."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"BasicAuth information to use on every scrape request."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#oauth2':: d.obj(help='"Optional OAuth 2.0 configuration.\\nCannot be set at the same time as `authorization` or `basic_auth`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration applying to the target HTTP endpoint."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withAllowStale':: d.fn(help='"The information to access the Nomad API. It is to be defined\\nas the Nomad documentation requires."', args=[d.arg(name='allowStale', type=d.T.boolean)]), + withAllowStale(allowStale): { allowStale: allowStale }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNamespace':: d.fn(help='', args=[d.arg(name='namespace', type=d.T.string)]), + withNamespace(namespace): { namespace: namespace }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"Duration is a valid time duration that can be parsed by Prometheus model.ParseDuration() function.\\nSupported units: y, w, d, h, m, s, ms\\nExamples: `30s`, `1m`, `1h20m15s`, `15d`"', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withRegion':: d.fn(help='', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { region: region }, + '#withServer':: d.fn(help='', args=[d.arg(name='server', type=d.T.string)]), + withServer(server): { server: server }, + '#withTagSeparator':: d.fn(help='', args=[d.arg(name='tagSeparator', type=d.T.string)]), + withTagSeparator(tagSeparator): { tagSeparator: tagSeparator }, + }, + '#oauth2':: d.obj(help='"OAuth2 client credentials used to fetch a token for the targets."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { clientId+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { clientId+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { clientId+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { clientId+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { clientId+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { clientId+: { secret+: { optional: optional } } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { clientSecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { clientSecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { clientSecret+: { optional: optional } } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { oauth2+: { tlsConfig+: { minVersion: minVersion } } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { oauth2+: { tlsConfig+: { serverName: serverName } } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { spec+: { oauth2+: { endpointParams: endpointParams } } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { spec+: { oauth2+: { endpointParams+: endpointParams } } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { spec+: { oauth2+: { noProxy: noProxy } } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { spec+: { oauth2+: { proxyConnectHeader: proxyConnectHeader } } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { spec+: { oauth2+: { proxyConnectHeader+: proxyConnectHeader } } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { spec+: { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { spec+: { oauth2+: { proxyUrl: proxyUrl } } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { spec+: { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { spec+: { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { spec+: { oauth2+: { tokenUrl: tokenUrl } } }, + }, + '#openstackSDConfigs':: d.obj(help='"OpenStackSDConfigs defines a list of OpenStack service discovery configurations."'), + openstackSDConfigs: { + '#applicationCredentialSecret':: d.obj(help='"The applicationCredentialSecret field is required if using an application\\ncredential to authenticate."'), + applicationCredentialSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { applicationCredentialSecret+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { applicationCredentialSecret+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { applicationCredentialSecret+: { optional: optional } }, + }, + '#password':: d.obj(help="\"Password for the Identity V2 and V3 APIs. Consult with your provider's\\ncontrol panel to discover your account's preferred method of authentication.\""), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { password+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { password+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { password+: { optional: optional } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration applying to the target HTTP endpoint."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withAllTenants':: d.fn(help="\"Whether the service discovery should list all instances for all projects.\\nIt is only relevant for the 'instance' role and usually requires admin permissions.\"", args=[d.arg(name='allTenants', type=d.T.boolean)]), + withAllTenants(allTenants): { allTenants: allTenants }, + '#withApplicationCredentialId':: d.fn(help='"ApplicationCredentialID"', args=[d.arg(name='applicationCredentialId', type=d.T.string)]), + withApplicationCredentialId(applicationCredentialId): { applicationCredentialId: applicationCredentialId }, + '#withApplicationCredentialName':: d.fn(help='"The ApplicationCredentialID or ApplicationCredentialName fields are\\nrequired if using an application credential to authenticate. Some providers\\nallow you to create an application credential to authenticate rather than a\\npassword."', args=[d.arg(name='applicationCredentialName', type=d.T.string)]), + withApplicationCredentialName(applicationCredentialName): { applicationCredentialName: applicationCredentialName }, + '#withAvailability':: d.fn(help='"Availability of the endpoint to connect to."', args=[d.arg(name='availability', type=d.T.string)]), + withAvailability(availability): { availability: availability }, + '#withDomainID':: d.fn(help='"DomainID"', args=[d.arg(name='domainID', type=d.T.string)]), + withDomainID(domainID): { domainID: domainID }, + '#withDomainName':: d.fn(help='"At most one of domainId and domainName must be provided if using username\\nwith Identity V3. Otherwise, either are optional."', args=[d.arg(name='domainName', type=d.T.string)]), + withDomainName(domainName): { domainName: domainName }, + '#withIdentityEndpoint':: d.fn(help='"IdentityEndpoint specifies the HTTP endpoint that is required to work with\\nthe Identity API of the appropriate version."', args=[d.arg(name='identityEndpoint', type=d.T.string)]), + withIdentityEndpoint(identityEndpoint): { identityEndpoint: identityEndpoint }, + '#withPort':: d.fn(help='"The port to scrape metrics from. If using the public IP address, this must\\ninstead be specified in the relabeling rule."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProjectID':: d.fn(help='" ProjectID"', args=[d.arg(name='projectID', type=d.T.string)]), + withProjectID(projectID): { projectID: projectID }, + '#withProjectName':: d.fn(help="\"The ProjectId and ProjectName fields are optional for the Identity V2 API.\\nSome providers allow you to specify a ProjectName instead of the ProjectId.\\nSome require both. Your provider's authentication policies will determine\\nhow these fields influence authentication.\"", args=[d.arg(name='projectName', type=d.T.string)]), + withProjectName(projectName): { projectName: projectName }, + '#withRefreshInterval':: d.fn(help='"Refresh interval to re-read the instance list."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withRegion':: d.fn(help='"The OpenStack Region."', args=[d.arg(name='region', type=d.T.string)]), + withRegion(region): { region: region }, + '#withRole':: d.fn(help='"The OpenStack role of entities that should be discovered."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { role: role }, + '#withUserid':: d.fn(help='"UserID"', args=[d.arg(name='userid', type=d.T.string)]), + withUserid(userid): { userid: userid }, + '#withUsername':: d.fn(help="\"Username is required if using Identity V2 API. Consult with your provider's\\ncontrol panel to discover your account's username.\\nIn Identity V3, either userid or a combination of username\\nand domainId or domainName are needed\"", args=[d.arg(name='username', type=d.T.string)]), + withUsername(username): { username: username }, + }, + '#ovhcloudSDConfigs':: d.obj(help='"OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations."'), + ovhcloudSDConfigs: { + '#applicationSecret':: d.obj(help='"SecretKeySelector selects a key of a Secret."'), + applicationSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { applicationSecret+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { applicationSecret+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { applicationSecret+: { optional: optional } }, + }, + '#consumerKey':: d.obj(help='"SecretKeySelector selects a key of a Secret."'), + consumerKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { consumerKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { consumerKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { consumerKey+: { optional: optional } }, + }, + '#withApplicationKey':: d.fn(help='"Access key to use. https://api.ovh.com."', args=[d.arg(name='applicationKey', type=d.T.string)]), + withApplicationKey(applicationKey): { applicationKey: applicationKey }, + '#withEndpoint':: d.fn(help='"Custom endpoint to be used."', args=[d.arg(name='endpoint', type=d.T.string)]), + withEndpoint(endpoint): { endpoint: endpoint }, + '#withRefreshInterval':: d.fn(help='"Refresh interval to re-read the resources list."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withService':: d.fn(help='"Service of the targets to retrieve. Must be `VPS` or `DedicatedServer`."', args=[d.arg(name='service', type=d.T.string)]), + withService(service): { service: service }, + }, + '#puppetDBSDConfigs':: d.obj(help='"PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations."'), + puppetDBSDConfigs: { + '#authorization':: d.obj(help='"Optional `authorization` HTTP header configuration.\\nCannot be set at the same time as `basicAuth`, or `oauth2`."'), + authorization: { + '#credentials':: d.obj(help='"Selects a key of a Secret in the namespace that contains the credentials for authentication."'), + credentials: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { authorization+: { credentials+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { authorization+: { credentials+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { authorization+: { credentials+: { optional: optional } } }, + }, + '#withType':: d.fn(help='"Defines the authentication type. The value is case-insensitive.\\n\\n\\n\\"Basic\\" is not a supported value.\\n\\n\\nDefault: \\"Bearer\\', args=[d.arg(name='type', type=d.T.string)]), + withType(type): { authorization+: { type: type } }, + }, + '#basicAuth':: d.obj(help='"Optional HTTP basic authentication information.\\nCannot be set at the same time as `authorization`, or `oauth2`."'), + basicAuth: { + '#password':: d.obj(help='"`password` specifies a key of a Secret containing the password for\\nauthentication."'), + password: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { password+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { password+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { password+: { optional: optional } } }, + }, + '#username':: d.obj(help='"`username` specifies a key of a Secret containing the username for\\nauthentication."'), + username: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { basicAuth+: { username+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { basicAuth+: { username+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { basicAuth+: { username+: { optional: optional } } }, + }, + }, + '#oauth2':: d.obj(help='"Optional OAuth2.0 configuration.\\nCannot be set at the same time as `basicAuth`, or `authorization`."'), + oauth2: { + '#clientId':: d.obj(help="\"`clientId` specifies a key of a Secret or ConfigMap containing the\\nOAuth2 client's ID.\""), + clientId: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientId+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientId+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientId+: { secret+: { optional: optional } } } }, + }, + }, + '#clientSecret':: d.obj(help="\"`clientSecret` specifies a key of a Secret containing the OAuth2\\nclient's secret.\""), + clientSecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { clientSecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { clientSecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { clientSecret+: { optional: optional } } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use when connecting to the OAuth2 server.\\nIt requires Prometheus >= v2.43.0."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { oauth2+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { oauth2+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { oauth2+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { oauth2+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { oauth2+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { oauth2+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { oauth2+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withEndpointParams':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParams(endpointParams): { oauth2+: { endpointParams: endpointParams } }, + '#withEndpointParamsMixin':: d.fn(help='"`endpointParams` configures the HTTP parameters to append to the token\\nURL."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='endpointParams', type=d.T.object)]), + withEndpointParamsMixin(endpointParams): { oauth2+: { endpointParams+: endpointParams } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { oauth2+: { noProxy: noProxy } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { oauth2+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { oauth2+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { oauth2+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { oauth2+: { proxyUrl: proxyUrl } }, + '#withScopes':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."', args=[d.arg(name='scopes', type=d.T.array)]), + withScopes(scopes): { oauth2+: { scopes: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withScopesMixin':: d.fn(help='"`scopes` defines the OAuth2 scopes used for the token request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scopes', type=d.T.array)]), + withScopesMixin(scopes): { oauth2+: { scopes+: if std.isArray(v=scopes) then scopes else [scopes] } }, + '#withTokenUrl':: d.fn(help='"`tokenURL` configures the URL to fetch the token from."', args=[d.arg(name='tokenUrl', type=d.T.string)]), + withTokenUrl(tokenUrl): { oauth2+: { tokenUrl: tokenUrl } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to connect to the Puppet DB."'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withEnableHTTP2':: d.fn(help='"Configure whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether the HTTP requests should follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withIncludeParameters':: d.fn(help="\"Whether to include the parameters as meta labels.\\nNote: Enabling this exposes parameters in the Prometheus UI and API. Make sure\\nthat you don't have secrets exposed as parameters if you enable this.\"", args=[d.arg(name='includeParameters', type=d.T.boolean)]), + withIncludeParameters(includeParameters): { includeParameters: includeParameters }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withPort':: d.fn(help='"Port to scrape the metrics from."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withQuery':: d.fn(help='"Puppet Query Language (PQL) query. Only resources are supported.\\nhttps://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html"', args=[d.arg(name='query', type=d.T.string)]), + withQuery(query): { query: query }, + '#withRefreshInterval':: d.fn(help='"Refresh interval to re-read the list of resources."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withUrl':: d.fn(help='"The URL of the PuppetDB root query endpoint."', args=[d.arg(name='url', type=d.T.string)]), + withUrl(url): { url: url }, + }, + '#relabelings':: d.obj(help="\"RelabelConfigs defines how to rewrite the target's labels before scraping.\\nPrometheus Operator automatically adds relabelings for a few standard Kubernetes fields.\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\""), + relabelings: { + '#withAction':: d.fn(help='"Action to perform based on the regex matching.\\n\\n\\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\\n\\n\\nDefault: \\"Replace\\', args=[d.arg(name='action', type=d.T.string)]), + withAction(action): { action: action }, + '#withModulus':: d.fn(help='"Modulus to take of the hash of the source label values.\\n\\n\\nOnly applicable when the action is `HashMod`."', args=[d.arg(name='modulus', type=d.T.integer)]), + withModulus(modulus): { modulus: modulus }, + '#withRegex':: d.fn(help='"Regular expression against which the extracted value is matched."', args=[d.arg(name='regex', type=d.T.string)]), + withRegex(regex): { regex: regex }, + '#withReplacement':: d.fn(help='"Replacement value against which a Replace action is performed if the\\nregular expression matches.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='replacement', type=d.T.string)]), + withReplacement(replacement): { replacement: replacement }, + '#withSeparator':: d.fn(help='"Separator is the string between concatenated SourceLabels."', args=[d.arg(name='separator', type=d.T.string)]), + withSeparator(separator): { separator: separator }, + '#withSourceLabels':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabels(sourceLabels): { sourceLabels: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withSourceLabelsMixin':: d.fn(help='"The source labels select values from existing labels. Their content is\\nconcatenated using the configured Separator and matched against the\\nconfigured regular expression."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='sourceLabels', type=d.T.array)]), + withSourceLabelsMixin(sourceLabels): { sourceLabels+: if std.isArray(v=sourceLabels) then sourceLabels else [sourceLabels] }, + '#withTargetLabel':: d.fn(help='"Label to which the resulting string is written in a replacement.\\n\\n\\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\\n`KeepEqual` and `DropEqual` actions.\\n\\n\\nRegex capture groups are available."', args=[d.arg(name='targetLabel', type=d.T.string)]), + withTargetLabel(targetLabel): { targetLabel: targetLabel }, + }, + '#scalewaySDConfigs':: d.obj(help='"ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations."'), + scalewaySDConfigs: { + '#secretKey':: d.obj(help='"Secret key to use when listing targets."'), + secretKey: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { secretKey+: { key: key } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { secretKey+: { name: name } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { secretKey+: { optional: optional } }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use on every scrape request"'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { ca+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { ca+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { ca+: { secret+: { optional: optional } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { configMap+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { configMap+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { configMap+: { optional: optional } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { cert+: { secret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { cert+: { secret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { cert+: { secret+: { optional: optional } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { tlsConfig+: { keySecret+: { key: key } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { tlsConfig+: { keySecret+: { name: name } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { tlsConfig+: { keySecret+: { optional: optional } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { tlsConfig+: { maxVersion: maxVersion } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { tlsConfig+: { minVersion: minVersion } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { tlsConfig+: { serverName: serverName } }, + }, + '#withAccessKey':: d.fn(help='"Access key to use. https://console.scaleway.com/project/credentials"', args=[d.arg(name='accessKey', type=d.T.string)]), + withAccessKey(accessKey): { accessKey: accessKey }, + '#withApiURL':: d.fn(help='"API URL to use when doing the server listing requests."', args=[d.arg(name='apiURL', type=d.T.string)]), + withApiURL(apiURL): { apiURL: apiURL }, + '#withEnableHTTP2':: d.fn(help='"Whether to enable HTTP2."', args=[d.arg(name='enableHTTP2', type=d.T.boolean)]), + withEnableHTTP2(enableHTTP2): { enableHTTP2: enableHTTP2 }, + '#withFollowRedirects':: d.fn(help='"Configure whether HTTP requests follow HTTP 3xx redirects."', args=[d.arg(name='followRedirects', type=d.T.boolean)]), + withFollowRedirects(followRedirects): { followRedirects: followRedirects }, + '#withNameFilter':: d.fn(help='"NameFilter specify a name filter (works as a LIKE) to apply on the server listing request."', args=[d.arg(name='nameFilter', type=d.T.string)]), + withNameFilter(nameFilter): { nameFilter: nameFilter }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { noProxy: noProxy }, + '#withPort':: d.fn(help='"The port to scrape metrics from."', args=[d.arg(name='port', type=d.T.integer)]), + withPort(port): { port: port }, + '#withProjectID':: d.fn(help='"Project ID of the targets."', args=[d.arg(name='projectID', type=d.T.string)]), + withProjectID(projectID): { projectID: projectID }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { proxyConnectHeader: proxyConnectHeader }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { proxyConnectHeader+: proxyConnectHeader }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { proxyFromEnvironment: proxyFromEnvironment }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { proxyUrl: proxyUrl }, + '#withRefreshInterval':: d.fn(help='"Refresh interval to re-read the list of instances."', args=[d.arg(name='refreshInterval', type=d.T.string)]), + withRefreshInterval(refreshInterval): { refreshInterval: refreshInterval }, + '#withRole':: d.fn(help='"Service of the targets to retrieve. Must be `Instance` or `Baremetal`."', args=[d.arg(name='role', type=d.T.string)]), + withRole(role): { role: role }, + '#withTagsFilter':: d.fn(help='"TagsFilter specify a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request."', args=[d.arg(name='tagsFilter', type=d.T.array)]), + withTagsFilter(tagsFilter): { tagsFilter: if std.isArray(v=tagsFilter) then tagsFilter else [tagsFilter] }, + '#withTagsFilterMixin':: d.fn(help='"TagsFilter specify a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='tagsFilter', type=d.T.array)]), + withTagsFilterMixin(tagsFilter): { tagsFilter+: if std.isArray(v=tagsFilter) then tagsFilter else [tagsFilter] }, + '#withZone':: d.fn(help='"Zone is the availability zone of your targets (e.g. fr-par-1)."', args=[d.arg(name='zone', type=d.T.string)]), + withZone(zone): { zone: zone }, + }, + '#staticConfigs':: d.obj(help='"StaticConfigs defines a list of static targets with a common label set."'), + staticConfigs: { + '#withLabels':: d.fn(help='"Labels assigned to all metrics scraped from the targets."', args=[d.arg(name='labels', type=d.T.object)]), + withLabels(labels): { labels: labels }, + '#withLabelsMixin':: d.fn(help='"Labels assigned to all metrics scraped from the targets."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='labels', type=d.T.object)]), + withLabelsMixin(labels): { labels+: labels }, + '#withTargets':: d.fn(help='"List of targets for this static configuration."', args=[d.arg(name='targets', type=d.T.array)]), + withTargets(targets): { targets: if std.isArray(v=targets) then targets else [targets] }, + '#withTargetsMixin':: d.fn(help='"List of targets for this static configuration."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='targets', type=d.T.array)]), + withTargetsMixin(targets): { targets+: if std.isArray(v=targets) then targets else [targets] }, + }, + '#tlsConfig':: d.obj(help='"TLS configuration to use on every scrape request"'), + tlsConfig: { + '#ca':: d.obj(help='"Certificate authority used when verifying server certificates."'), + ca: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { ca+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { ca+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { ca+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { ca+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { ca+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { ca+: { secret+: { optional: optional } } } } }, + }, + }, + '#cert':: d.obj(help='"Client certificate to present when doing client-authentication."'), + cert: { + '#configMap':: d.obj(help='"ConfigMap containing data to use for the targets."'), + configMap: { + '#withKey':: d.fn(help='"The key to select."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { cert+: { configMap+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { cert+: { configMap+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the ConfigMap or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { cert+: { configMap+: { optional: optional } } } } }, + }, + '#secret':: d.obj(help='"Secret containing data to use for the targets."'), + secret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { cert+: { secret+: { key: key } } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { cert+: { secret+: { name: name } } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { cert+: { secret+: { optional: optional } } } } }, + }, + }, + '#keySecret':: d.obj(help='"Secret containing the client key file for the targets."'), + keySecret: { + '#withKey':: d.fn(help='"The key of the secret to select from. Must be a valid secret key."', args=[d.arg(name='key', type=d.T.string)]), + withKey(key): { spec+: { tlsConfig+: { keySecret+: { key: key } } } }, + '#withName':: d.fn(help="\"Name of the referent.\\nThis field is effectively required, but due to backwards compatibility is\\nallowed to be empty. Instances of this type with an empty value here are\\nalmost certainly wrong.\\nTODO: Add other useful fields. apiVersion, kind, uid?\\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.\"", args=[d.arg(name='name', type=d.T.string)]), + withName(name): { spec+: { tlsConfig+: { keySecret+: { name: name } } } }, + '#withOptional':: d.fn(help='"Specify whether the Secret or its key must be defined"', args=[d.arg(name='optional', type=d.T.boolean)]), + withOptional(optional): { spec+: { tlsConfig+: { keySecret+: { optional: optional } } } }, + }, + '#withInsecureSkipVerify':: d.fn(help='"Disable target certificate validation."', args=[d.arg(name='insecureSkipVerify', type=d.T.boolean)]), + withInsecureSkipVerify(insecureSkipVerify): { spec+: { tlsConfig+: { insecureSkipVerify: insecureSkipVerify } } }, + '#withMaxVersion':: d.fn(help='"Maximum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.41.0."', args=[d.arg(name='maxVersion', type=d.T.string)]), + withMaxVersion(maxVersion): { spec+: { tlsConfig+: { maxVersion: maxVersion } } }, + '#withMinVersion':: d.fn(help='"Minimum acceptable TLS version.\\n\\n\\nIt requires Prometheus >= v2.35.0."', args=[d.arg(name='minVersion', type=d.T.string)]), + withMinVersion(minVersion): { spec+: { tlsConfig+: { minVersion: minVersion } } }, + '#withServerName':: d.fn(help='"Used to verify the hostname for the targets."', args=[d.arg(name='serverName', type=d.T.string)]), + withServerName(serverName): { spec+: { tlsConfig+: { serverName: serverName } } }, + }, + '#withAzureSDConfigs':: d.fn(help='"AzureSDConfigs defines a list of Azure service discovery configurations."', args=[d.arg(name='azureSDConfigs', type=d.T.array)]), + withAzureSDConfigs(azureSDConfigs): { spec+: { azureSDConfigs: if std.isArray(v=azureSDConfigs) then azureSDConfigs else [azureSDConfigs] } }, + '#withAzureSDConfigsMixin':: d.fn(help='"AzureSDConfigs defines a list of Azure service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='azureSDConfigs', type=d.T.array)]), + withAzureSDConfigsMixin(azureSDConfigs): { spec+: { azureSDConfigs+: if std.isArray(v=azureSDConfigs) then azureSDConfigs else [azureSDConfigs] } }, + '#withConsulSDConfigs':: d.fn(help='"ConsulSDConfigs defines a list of Consul service discovery configurations."', args=[d.arg(name='consulSDConfigs', type=d.T.array)]), + withConsulSDConfigs(consulSDConfigs): { spec+: { consulSDConfigs: if std.isArray(v=consulSDConfigs) then consulSDConfigs else [consulSDConfigs] } }, + '#withConsulSDConfigsMixin':: d.fn(help='"ConsulSDConfigs defines a list of Consul service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='consulSDConfigs', type=d.T.array)]), + withConsulSDConfigsMixin(consulSDConfigs): { spec+: { consulSDConfigs+: if std.isArray(v=consulSDConfigs) then consulSDConfigs else [consulSDConfigs] } }, + '#withDigitalOceanSDConfigs':: d.fn(help='"DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations."', args=[d.arg(name='digitalOceanSDConfigs', type=d.T.array)]), + withDigitalOceanSDConfigs(digitalOceanSDConfigs): { spec+: { digitalOceanSDConfigs: if std.isArray(v=digitalOceanSDConfigs) then digitalOceanSDConfigs else [digitalOceanSDConfigs] } }, + '#withDigitalOceanSDConfigsMixin':: d.fn(help='"DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='digitalOceanSDConfigs', type=d.T.array)]), + withDigitalOceanSDConfigsMixin(digitalOceanSDConfigs): { spec+: { digitalOceanSDConfigs+: if std.isArray(v=digitalOceanSDConfigs) then digitalOceanSDConfigs else [digitalOceanSDConfigs] } }, + '#withDnsSDConfigs':: d.fn(help='"DNSSDConfigs defines a list of DNS service discovery configurations."', args=[d.arg(name='dnsSDConfigs', type=d.T.array)]), + withDnsSDConfigs(dnsSDConfigs): { spec+: { dnsSDConfigs: if std.isArray(v=dnsSDConfigs) then dnsSDConfigs else [dnsSDConfigs] } }, + '#withDnsSDConfigsMixin':: d.fn(help='"DNSSDConfigs defines a list of DNS service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='dnsSDConfigs', type=d.T.array)]), + withDnsSDConfigsMixin(dnsSDConfigs): { spec+: { dnsSDConfigs+: if std.isArray(v=dnsSDConfigs) then dnsSDConfigs else [dnsSDConfigs] } }, + '#withDockerSDConfigs':: d.fn(help='"DockerSDConfigs defines a list of Docker service discovery configurations."', args=[d.arg(name='dockerSDConfigs', type=d.T.array)]), + withDockerSDConfigs(dockerSDConfigs): { spec+: { dockerSDConfigs: if std.isArray(v=dockerSDConfigs) then dockerSDConfigs else [dockerSDConfigs] } }, + '#withDockerSDConfigsMixin':: d.fn(help='"DockerSDConfigs defines a list of Docker service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='dockerSDConfigs', type=d.T.array)]), + withDockerSDConfigsMixin(dockerSDConfigs): { spec+: { dockerSDConfigs+: if std.isArray(v=dockerSDConfigs) then dockerSDConfigs else [dockerSDConfigs] } }, + '#withDockerSwarmSDConfigs':: d.fn(help='"DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations."', args=[d.arg(name='dockerSwarmSDConfigs', type=d.T.array)]), + withDockerSwarmSDConfigs(dockerSwarmSDConfigs): { spec+: { dockerSwarmSDConfigs: if std.isArray(v=dockerSwarmSDConfigs) then dockerSwarmSDConfigs else [dockerSwarmSDConfigs] } }, + '#withDockerSwarmSDConfigsMixin':: d.fn(help='"DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='dockerSwarmSDConfigs', type=d.T.array)]), + withDockerSwarmSDConfigsMixin(dockerSwarmSDConfigs): { spec+: { dockerSwarmSDConfigs+: if std.isArray(v=dockerSwarmSDConfigs) then dockerSwarmSDConfigs else [dockerSwarmSDConfigs] } }, + '#withEc2SDConfigs':: d.fn(help='"EC2SDConfigs defines a list of EC2 service discovery configurations."', args=[d.arg(name='ec2SDConfigs', type=d.T.array)]), + withEc2SDConfigs(ec2SDConfigs): { spec+: { ec2SDConfigs: if std.isArray(v=ec2SDConfigs) then ec2SDConfigs else [ec2SDConfigs] } }, + '#withEc2SDConfigsMixin':: d.fn(help='"EC2SDConfigs defines a list of EC2 service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ec2SDConfigs', type=d.T.array)]), + withEc2SDConfigsMixin(ec2SDConfigs): { spec+: { ec2SDConfigs+: if std.isArray(v=ec2SDConfigs) then ec2SDConfigs else [ec2SDConfigs] } }, + '#withEnableCompression':: d.fn(help='"When false, Prometheus will request uncompressed response from the scraped target.\\n\\n\\nIt requires Prometheus >= v2.49.0.\\n\\n\\nIf unset, Prometheus uses true by default."', args=[d.arg(name='enableCompression', type=d.T.boolean)]), + withEnableCompression(enableCompression): { spec+: { enableCompression: enableCompression } }, + '#withEurekaSDConfigs':: d.fn(help='"EurekaSDConfigs defines a list of Eureka service discovery configurations."', args=[d.arg(name='eurekaSDConfigs', type=d.T.array)]), + withEurekaSDConfigs(eurekaSDConfigs): { spec+: { eurekaSDConfigs: if std.isArray(v=eurekaSDConfigs) then eurekaSDConfigs else [eurekaSDConfigs] } }, + '#withEurekaSDConfigsMixin':: d.fn(help='"EurekaSDConfigs defines a list of Eureka service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='eurekaSDConfigs', type=d.T.array)]), + withEurekaSDConfigsMixin(eurekaSDConfigs): { spec+: { eurekaSDConfigs+: if std.isArray(v=eurekaSDConfigs) then eurekaSDConfigs else [eurekaSDConfigs] } }, + '#withFileSDConfigs':: d.fn(help='"FileSDConfigs defines a list of file service discovery configurations."', args=[d.arg(name='fileSDConfigs', type=d.T.array)]), + withFileSDConfigs(fileSDConfigs): { spec+: { fileSDConfigs: if std.isArray(v=fileSDConfigs) then fileSDConfigs else [fileSDConfigs] } }, + '#withFileSDConfigsMixin':: d.fn(help='"FileSDConfigs defines a list of file service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='fileSDConfigs', type=d.T.array)]), + withFileSDConfigsMixin(fileSDConfigs): { spec+: { fileSDConfigs+: if std.isArray(v=fileSDConfigs) then fileSDConfigs else [fileSDConfigs] } }, + '#withGceSDConfigs':: d.fn(help='"GCESDConfigs defines a list of GCE service discovery configurations."', args=[d.arg(name='gceSDConfigs', type=d.T.array)]), + withGceSDConfigs(gceSDConfigs): { spec+: { gceSDConfigs: if std.isArray(v=gceSDConfigs) then gceSDConfigs else [gceSDConfigs] } }, + '#withGceSDConfigsMixin':: d.fn(help='"GCESDConfigs defines a list of GCE service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='gceSDConfigs', type=d.T.array)]), + withGceSDConfigsMixin(gceSDConfigs): { spec+: { gceSDConfigs+: if std.isArray(v=gceSDConfigs) then gceSDConfigs else [gceSDConfigs] } }, + '#withHetznerSDConfigs':: d.fn(help='"HetznerSDConfigs defines a list of Hetzner service discovery configurations."', args=[d.arg(name='hetznerSDConfigs', type=d.T.array)]), + withHetznerSDConfigs(hetznerSDConfigs): { spec+: { hetznerSDConfigs: if std.isArray(v=hetznerSDConfigs) then hetznerSDConfigs else [hetznerSDConfigs] } }, + '#withHetznerSDConfigsMixin':: d.fn(help='"HetznerSDConfigs defines a list of Hetzner service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='hetznerSDConfigs', type=d.T.array)]), + withHetznerSDConfigsMixin(hetznerSDConfigs): { spec+: { hetznerSDConfigs+: if std.isArray(v=hetznerSDConfigs) then hetznerSDConfigs else [hetznerSDConfigs] } }, + '#withHonorLabels':: d.fn(help="\"HonorLabels chooses the metric's labels on collisions with target labels.\"", args=[d.arg(name='honorLabels', type=d.T.boolean)]), + withHonorLabels(honorLabels): { spec+: { honorLabels: honorLabels } }, + '#withHonorTimestamps':: d.fn(help='"HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data."', args=[d.arg(name='honorTimestamps', type=d.T.boolean)]), + withHonorTimestamps(honorTimestamps): { spec+: { honorTimestamps: honorTimestamps } }, + '#withHttpSDConfigs':: d.fn(help='"HTTPSDConfigs defines a list of HTTP service discovery configurations."', args=[d.arg(name='httpSDConfigs', type=d.T.array)]), + withHttpSDConfigs(httpSDConfigs): { spec+: { httpSDConfigs: if std.isArray(v=httpSDConfigs) then httpSDConfigs else [httpSDConfigs] } }, + '#withHttpSDConfigsMixin':: d.fn(help='"HTTPSDConfigs defines a list of HTTP service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='httpSDConfigs', type=d.T.array)]), + withHttpSDConfigsMixin(httpSDConfigs): { spec+: { httpSDConfigs+: if std.isArray(v=httpSDConfigs) then httpSDConfigs else [httpSDConfigs] } }, + '#withJobName':: d.fn(help='"The value of the `job` label assigned to the scraped metrics by default.\\n\\n\\nThe `job_name` field in the rendered scrape configuration is always controlled by the\\noperator to prevent duplicate job names, which Prometheus does not allow. Instead the\\n`job` label is set by means of relabeling configs."', args=[d.arg(name='jobName', type=d.T.string)]), + withJobName(jobName): { spec+: { jobName: jobName } }, + '#withKeepDroppedTargets':: d.fn(help='"Per-scrape limit on the number of targets dropped by relabeling\\nthat will be kept in memory. 0 means no limit.\\n\\n\\nIt requires Prometheus >= v2.47.0."', args=[d.arg(name='keepDroppedTargets', type=d.T.integer)]), + withKeepDroppedTargets(keepDroppedTargets): { spec+: { keepDroppedTargets: keepDroppedTargets } }, + '#withKubernetesSDConfigs':: d.fn(help='"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations."', args=[d.arg(name='kubernetesSDConfigs', type=d.T.array)]), + withKubernetesSDConfigs(kubernetesSDConfigs): { spec+: { kubernetesSDConfigs: if std.isArray(v=kubernetesSDConfigs) then kubernetesSDConfigs else [kubernetesSDConfigs] } }, + '#withKubernetesSDConfigsMixin':: d.fn(help='"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='kubernetesSDConfigs', type=d.T.array)]), + withKubernetesSDConfigsMixin(kubernetesSDConfigs): { spec+: { kubernetesSDConfigs+: if std.isArray(v=kubernetesSDConfigs) then kubernetesSDConfigs else [kubernetesSDConfigs] } }, + '#withKumaSDConfigs':: d.fn(help='"KumaSDConfigs defines a list of Kuma service discovery configurations."', args=[d.arg(name='kumaSDConfigs', type=d.T.array)]), + withKumaSDConfigs(kumaSDConfigs): { spec+: { kumaSDConfigs: if std.isArray(v=kumaSDConfigs) then kumaSDConfigs else [kumaSDConfigs] } }, + '#withKumaSDConfigsMixin':: d.fn(help='"KumaSDConfigs defines a list of Kuma service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='kumaSDConfigs', type=d.T.array)]), + withKumaSDConfigsMixin(kumaSDConfigs): { spec+: { kumaSDConfigs+: if std.isArray(v=kumaSDConfigs) then kumaSDConfigs else [kumaSDConfigs] } }, + '#withLabelLimit':: d.fn(help='"Per-scrape limit on number of labels that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.27.0 and newer."', args=[d.arg(name='labelLimit', type=d.T.integer)]), + withLabelLimit(labelLimit): { spec+: { labelLimit: labelLimit } }, + '#withLabelNameLengthLimit':: d.fn(help='"Per-scrape limit on length of labels name that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.27.0 and newer."', args=[d.arg(name='labelNameLengthLimit', type=d.T.integer)]), + withLabelNameLengthLimit(labelNameLengthLimit): { spec+: { labelNameLengthLimit: labelNameLengthLimit } }, + '#withLabelValueLengthLimit':: d.fn(help='"Per-scrape limit on length of labels value that will be accepted for a sample.\\nOnly valid in Prometheus versions 2.27.0 and newer."', args=[d.arg(name='labelValueLengthLimit', type=d.T.integer)]), + withLabelValueLengthLimit(labelValueLengthLimit): { spec+: { labelValueLengthLimit: labelValueLengthLimit } }, + '#withLightSailSDConfigs':: d.fn(help='"LightsailSDConfigs defines a list of Lightsail service discovery configurations."', args=[d.arg(name='lightSailSDConfigs', type=d.T.array)]), + withLightSailSDConfigs(lightSailSDConfigs): { spec+: { lightSailSDConfigs: if std.isArray(v=lightSailSDConfigs) then lightSailSDConfigs else [lightSailSDConfigs] } }, + '#withLightSailSDConfigsMixin':: d.fn(help='"LightsailSDConfigs defines a list of Lightsail service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='lightSailSDConfigs', type=d.T.array)]), + withLightSailSDConfigsMixin(lightSailSDConfigs): { spec+: { lightSailSDConfigs+: if std.isArray(v=lightSailSDConfigs) then lightSailSDConfigs else [lightSailSDConfigs] } }, + '#withLinodeSDConfigs':: d.fn(help='"LinodeSDConfigs defines a list of Linode service discovery configurations."', args=[d.arg(name='linodeSDConfigs', type=d.T.array)]), + withLinodeSDConfigs(linodeSDConfigs): { spec+: { linodeSDConfigs: if std.isArray(v=linodeSDConfigs) then linodeSDConfigs else [linodeSDConfigs] } }, + '#withLinodeSDConfigsMixin':: d.fn(help='"LinodeSDConfigs defines a list of Linode service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='linodeSDConfigs', type=d.T.array)]), + withLinodeSDConfigsMixin(linodeSDConfigs): { spec+: { linodeSDConfigs+: if std.isArray(v=linodeSDConfigs) then linodeSDConfigs else [linodeSDConfigs] } }, + '#withMetricRelabelings':: d.fn(help='"MetricRelabelConfigs to apply to samples before ingestion."', args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelings(metricRelabelings): { spec+: { metricRelabelings: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] } }, + '#withMetricRelabelingsMixin':: d.fn(help='"MetricRelabelConfigs to apply to samples before ingestion."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='metricRelabelings', type=d.T.array)]), + withMetricRelabelingsMixin(metricRelabelings): { spec+: { metricRelabelings+: if std.isArray(v=metricRelabelings) then metricRelabelings else [metricRelabelings] } }, + '#withMetricsPath':: d.fn(help='"MetricsPath HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics)."', args=[d.arg(name='metricsPath', type=d.T.string)]), + withMetricsPath(metricsPath): { spec+: { metricsPath: metricsPath } }, + '#withNoProxy':: d.fn(help='"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\\nthat should be excluded from proxying. IP and domain names can\\ncontain port numbers.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='noProxy', type=d.T.string)]), + withNoProxy(noProxy): { spec+: { noProxy: noProxy } }, + '#withNomadSDConfigs':: d.fn(help='"NomadSDConfigs defines a list of Nomad service discovery configurations."', args=[d.arg(name='nomadSDConfigs', type=d.T.array)]), + withNomadSDConfigs(nomadSDConfigs): { spec+: { nomadSDConfigs: if std.isArray(v=nomadSDConfigs) then nomadSDConfigs else [nomadSDConfigs] } }, + '#withNomadSDConfigsMixin':: d.fn(help='"NomadSDConfigs defines a list of Nomad service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='nomadSDConfigs', type=d.T.array)]), + withNomadSDConfigsMixin(nomadSDConfigs): { spec+: { nomadSDConfigs+: if std.isArray(v=nomadSDConfigs) then nomadSDConfigs else [nomadSDConfigs] } }, + '#withOpenstackSDConfigs':: d.fn(help='"OpenStackSDConfigs defines a list of OpenStack service discovery configurations."', args=[d.arg(name='openstackSDConfigs', type=d.T.array)]), + withOpenstackSDConfigs(openstackSDConfigs): { spec+: { openstackSDConfigs: if std.isArray(v=openstackSDConfigs) then openstackSDConfigs else [openstackSDConfigs] } }, + '#withOpenstackSDConfigsMixin':: d.fn(help='"OpenStackSDConfigs defines a list of OpenStack service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='openstackSDConfigs', type=d.T.array)]), + withOpenstackSDConfigsMixin(openstackSDConfigs): { spec+: { openstackSDConfigs+: if std.isArray(v=openstackSDConfigs) then openstackSDConfigs else [openstackSDConfigs] } }, + '#withOvhcloudSDConfigs':: d.fn(help='"OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations."', args=[d.arg(name='ovhcloudSDConfigs', type=d.T.array)]), + withOvhcloudSDConfigs(ovhcloudSDConfigs): { spec+: { ovhcloudSDConfigs: if std.isArray(v=ovhcloudSDConfigs) then ovhcloudSDConfigs else [ovhcloudSDConfigs] } }, + '#withOvhcloudSDConfigsMixin':: d.fn(help='"OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='ovhcloudSDConfigs', type=d.T.array)]), + withOvhcloudSDConfigsMixin(ovhcloudSDConfigs): { spec+: { ovhcloudSDConfigs+: if std.isArray(v=ovhcloudSDConfigs) then ovhcloudSDConfigs else [ovhcloudSDConfigs] } }, + '#withParams':: d.fn(help='"Optional HTTP URL parameters"', args=[d.arg(name='params', type=d.T.object)]), + withParams(params): { spec+: { params: params } }, + '#withParamsMixin':: d.fn(help='"Optional HTTP URL parameters"\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='params', type=d.T.object)]), + withParamsMixin(params): { spec+: { params+: params } }, + '#withProxyConnectHeader':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeader(proxyConnectHeader): { spec+: { proxyConnectHeader: proxyConnectHeader } }, + '#withProxyConnectHeaderMixin':: d.fn(help='"ProxyConnectHeader optionally specifies headers to send to\\nproxies during CONNECT requests.\\n\\n\\nIt requires Prometheus >= v2.43.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='proxyConnectHeader', type=d.T.object)]), + withProxyConnectHeaderMixin(proxyConnectHeader): { spec+: { proxyConnectHeader+: proxyConnectHeader } }, + '#withProxyFromEnvironment':: d.fn(help='"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyFromEnvironment', type=d.T.boolean)]), + withProxyFromEnvironment(proxyFromEnvironment): { spec+: { proxyFromEnvironment: proxyFromEnvironment } }, + '#withProxyUrl':: d.fn(help='"`proxyURL` defines the HTTP proxy server to use.\\n\\n\\nIt requires Prometheus >= v2.43.0."', args=[d.arg(name='proxyUrl', type=d.T.string)]), + withProxyUrl(proxyUrl): { spec+: { proxyUrl: proxyUrl } }, + '#withPuppetDBSDConfigs':: d.fn(help='"PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations."', args=[d.arg(name='puppetDBSDConfigs', type=d.T.array)]), + withPuppetDBSDConfigs(puppetDBSDConfigs): { spec+: { puppetDBSDConfigs: if std.isArray(v=puppetDBSDConfigs) then puppetDBSDConfigs else [puppetDBSDConfigs] } }, + '#withPuppetDBSDConfigsMixin':: d.fn(help='"PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='puppetDBSDConfigs', type=d.T.array)]), + withPuppetDBSDConfigsMixin(puppetDBSDConfigs): { spec+: { puppetDBSDConfigs+: if std.isArray(v=puppetDBSDConfigs) then puppetDBSDConfigs else [puppetDBSDConfigs] } }, + '#withRelabelings':: d.fn(help="\"RelabelConfigs defines how to rewrite the target's labels before scraping.\\nPrometheus Operator automatically adds relabelings for a few standard Kubernetes fields.\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\"", args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelings(relabelings): { spec+: { relabelings: if std.isArray(v=relabelings) then relabelings else [relabelings] } }, + '#withRelabelingsMixin':: d.fn(help="\"RelabelConfigs defines how to rewrite the target's labels before scraping.\\nPrometheus Operator automatically adds relabelings for a few standard Kubernetes fields.\\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config\"\n\n**Note:** This function appends passed data to existing values", args=[d.arg(name='relabelings', type=d.T.array)]), + withRelabelingsMixin(relabelings): { spec+: { relabelings+: if std.isArray(v=relabelings) then relabelings else [relabelings] } }, + '#withSampleLimit':: d.fn(help='"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted."', args=[d.arg(name='sampleLimit', type=d.T.integer)]), + withSampleLimit(sampleLimit): { spec+: { sampleLimit: sampleLimit } }, + '#withScalewaySDConfigs':: d.fn(help='"ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations."', args=[d.arg(name='scalewaySDConfigs', type=d.T.array)]), + withScalewaySDConfigs(scalewaySDConfigs): { spec+: { scalewaySDConfigs: if std.isArray(v=scalewaySDConfigs) then scalewaySDConfigs else [scalewaySDConfigs] } }, + '#withScalewaySDConfigsMixin':: d.fn(help='"ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scalewaySDConfigs', type=d.T.array)]), + withScalewaySDConfigsMixin(scalewaySDConfigs): { spec+: { scalewaySDConfigs+: if std.isArray(v=scalewaySDConfigs) then scalewaySDConfigs else [scalewaySDConfigs] } }, + '#withScheme':: d.fn(help='"Configures the protocol scheme used for requests.\\nIf empty, Prometheus uses HTTP by default."', args=[d.arg(name='scheme', type=d.T.string)]), + withScheme(scheme): { spec+: { scheme: scheme } }, + '#withScrapeClass':: d.fn(help='"The scrape class to apply."', args=[d.arg(name='scrapeClass', type=d.T.string)]), + withScrapeClass(scrapeClass): { spec+: { scrapeClass: scrapeClass } }, + '#withScrapeInterval':: d.fn(help='"ScrapeInterval is the interval between consecutive scrapes."', args=[d.arg(name='scrapeInterval', type=d.T.string)]), + withScrapeInterval(scrapeInterval): { spec+: { scrapeInterval: scrapeInterval } }, + '#withScrapeProtocols':: d.fn(help='"The protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocols(scrapeProtocols): { spec+: { scrapeProtocols: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeProtocolsMixin':: d.fn(help='"The protocols to negotiate during a scrape. It tells clients the\\nprotocols supported by Prometheus in order of preference (from most to least preferred).\\n\\n\\nIf unset, Prometheus uses its default value.\\n\\n\\nIt requires Prometheus >= v2.49.0."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='scrapeProtocols', type=d.T.array)]), + withScrapeProtocolsMixin(scrapeProtocols): { spec+: { scrapeProtocols+: if std.isArray(v=scrapeProtocols) then scrapeProtocols else [scrapeProtocols] } }, + '#withScrapeTimeout':: d.fn(help='"ScrapeTimeout is the number of seconds to wait until a scrape request times out."', args=[d.arg(name='scrapeTimeout', type=d.T.string)]), + withScrapeTimeout(scrapeTimeout): { spec+: { scrapeTimeout: scrapeTimeout } }, + '#withStaticConfigs':: d.fn(help='"StaticConfigs defines a list of static targets with a common label set."', args=[d.arg(name='staticConfigs', type=d.T.array)]), + withStaticConfigs(staticConfigs): { spec+: { staticConfigs: if std.isArray(v=staticConfigs) then staticConfigs else [staticConfigs] } }, + '#withStaticConfigsMixin':: d.fn(help='"StaticConfigs defines a list of static targets with a common label set."\n\n**Note:** This function appends passed data to existing values', args=[d.arg(name='staticConfigs', type=d.T.array)]), + withStaticConfigsMixin(staticConfigs): { spec+: { staticConfigs+: if std.isArray(v=staticConfigs) then staticConfigs else [staticConfigs] } }, + '#withTargetLimit':: d.fn(help='"TargetLimit defines a limit on the number of scraped targets that will be accepted."', args=[d.arg(name='targetLimit', type=d.T.integer)]), + withTargetLimit(targetLimit): { spec+: { targetLimit: targetLimit } }, + '#withTrackTimestampsStaleness':: d.fn(help='"TrackTimestampsStaleness whether Prometheus tracks staleness of\\nthe metrics that have an explicit timestamp present in scraped data.\\nHas no effect if `honorTimestamps` is false.\\nIt requires Prometheus >= v2.48.0."', args=[d.arg(name='trackTimestampsStaleness', type=d.T.boolean)]), + withTrackTimestampsStaleness(trackTimestampsStaleness): { spec+: { trackTimestampsStaleness: trackTimestampsStaleness } }, + }, + '#mixin': 'ignore', + mixin: self, +} diff --git a/0.14/gen.libsonnet b/0.14/gen.libsonnet new file mode 100644 index 0000000..f27b91c --- /dev/null +++ b/0.14/gen.libsonnet @@ -0,0 +1,5 @@ +{ + local d = (import 'doc-util/main.libsonnet'), + '#':: d.pkg(name='kube_prometheus', url='github.com/jsonnet-libs/kube-prometheus-libsonnet/0.14/main.libsonnet', help=''), + monitoring:: (import '_gen/monitoring/main.libsonnet'), +} diff --git a/0.14/main.libsonnet b/0.14/main.libsonnet new file mode 100644 index 0000000..1991f15 --- /dev/null +++ b/0.14/main.libsonnet @@ -0,0 +1 @@ +(import 'gen.libsonnet') + (import '_custom/endpoint.libsonnet') + (import '_custom/pod_metrics_endpoint.libsonnet') + (import '_custom/relabel_config.libsonnet') diff --git a/docs/0.14/README.md b/docs/0.14/README.md new file mode 100644 index 0000000..28db590 --- /dev/null +++ b/docs/0.14/README.md @@ -0,0 +1,13 @@ +--- +permalink: /0.14/ +--- + +# kube_prometheus + +```jsonnet +local kube_prometheus = import "github.com/jsonnet-libs/kube-prometheus-libsonnet/0.14/main.libsonnet" +``` + + + +* [monitoring](monitoring/index.md) \ No newline at end of file diff --git a/docs/0.14/monitoring/index.md b/docs/0.14/monitoring/index.md new file mode 100644 index 0000000..265e35d --- /dev/null +++ b/docs/0.14/monitoring/index.md @@ -0,0 +1,10 @@ +--- +permalink: /0.14/monitoring/ +--- + +# monitoring + + + +* [v1](v1/index.md) +* [v1alpha1](v1alpha1/index.md) \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/alertmanager.md b/docs/0.14/monitoring/v1/alertmanager.md new file mode 100644 index 0000000..913f795 --- /dev/null +++ b/docs/0.14/monitoring/v1/alertmanager.md @@ -0,0 +1,11262 @@ +--- +permalink: /0.14/monitoring/v1/alertmanager/ +--- + +# monitoring.v1.alertmanager + +"The `Alertmanager` custom resource definition (CRD) defines a desired [Alertmanager](https://prometheus.io/docs/alerting) setup to run in a Kubernetes cluster. It allows to specify many options such as the number of replicas, persistent storage and many more.\n\n\nFor each `Alertmanager` resource, the Operator deploys a `StatefulSet` in the same namespace. When there are two or more configured replicas, the Operator runs the Alertmanager instances in high-availability mode.\n\n\nThe resource defines via label and namespace selectors which `AlertmanagerConfig` objects should be associated to the deployed Alertmanager instances." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withAdditionalPeers(additionalPeers)`](#fn-specwithadditionalpeers) + * [`fn withAdditionalPeersMixin(additionalPeers)`](#fn-specwithadditionalpeersmixin) + * [`fn withAutomountServiceAccountToken(automountServiceAccountToken)`](#fn-specwithautomountserviceaccounttoken) + * [`fn withBaseImage(baseImage)`](#fn-specwithbaseimage) + * [`fn withClusterAdvertiseAddress(clusterAdvertiseAddress)`](#fn-specwithclusteradvertiseaddress) + * [`fn withClusterGossipInterval(clusterGossipInterval)`](#fn-specwithclustergossipinterval) + * [`fn withClusterLabel(clusterLabel)`](#fn-specwithclusterlabel) + * [`fn withClusterPeerTimeout(clusterPeerTimeout)`](#fn-specwithclusterpeertimeout) + * [`fn withClusterPushpullInterval(clusterPushpullInterval)`](#fn-specwithclusterpushpullinterval) + * [`fn withConfigMaps(configMaps)`](#fn-specwithconfigmaps) + * [`fn withConfigMapsMixin(configMaps)`](#fn-specwithconfigmapsmixin) + * [`fn withConfigSecret(configSecret)`](#fn-specwithconfigsecret) + * [`fn withContainers(containers)`](#fn-specwithcontainers) + * [`fn withContainersMixin(containers)`](#fn-specwithcontainersmixin) + * [`fn withEnableFeatures(enableFeatures)`](#fn-specwithenablefeatures) + * [`fn withEnableFeaturesMixin(enableFeatures)`](#fn-specwithenablefeaturesmixin) + * [`fn withExternalUrl(externalUrl)`](#fn-specwithexternalurl) + * [`fn withForceEnableClusterMode(forceEnableClusterMode)`](#fn-specwithforceenableclustermode) + * [`fn withHostAliases(hostAliases)`](#fn-specwithhostaliases) + * [`fn withHostAliasesMixin(hostAliases)`](#fn-specwithhostaliasesmixin) + * [`fn withImage(image)`](#fn-specwithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-specwithimagepullpolicy) + * [`fn withImagePullSecrets(imagePullSecrets)`](#fn-specwithimagepullsecrets) + * [`fn withImagePullSecretsMixin(imagePullSecrets)`](#fn-specwithimagepullsecretsmixin) + * [`fn withInitContainers(initContainers)`](#fn-specwithinitcontainers) + * [`fn withInitContainersMixin(initContainers)`](#fn-specwithinitcontainersmixin) + * [`fn withListenLocal(listenLocal)`](#fn-specwithlistenlocal) + * [`fn withLogFormat(logFormat)`](#fn-specwithlogformat) + * [`fn withLogLevel(logLevel)`](#fn-specwithloglevel) + * [`fn withMinReadySeconds(minReadySeconds)`](#fn-specwithminreadyseconds) + * [`fn withNodeSelector(nodeSelector)`](#fn-specwithnodeselector) + * [`fn withNodeSelectorMixin(nodeSelector)`](#fn-specwithnodeselectormixin) + * [`fn withPaused(paused)`](#fn-specwithpaused) + * [`fn withPortName(portName)`](#fn-specwithportname) + * [`fn withPriorityClassName(priorityClassName)`](#fn-specwithpriorityclassname) + * [`fn withReplicas(replicas)`](#fn-specwithreplicas) + * [`fn withRetention(retention)`](#fn-specwithretention) + * [`fn withRoutePrefix(routePrefix)`](#fn-specwithrouteprefix) + * [`fn withSecrets(secrets)`](#fn-specwithsecrets) + * [`fn withSecretsMixin(secrets)`](#fn-specwithsecretsmixin) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withSha(sha)`](#fn-specwithsha) + * [`fn withTag(tag)`](#fn-specwithtag) + * [`fn withTolerations(tolerations)`](#fn-specwithtolerations) + * [`fn withTolerationsMixin(tolerations)`](#fn-specwithtolerationsmixin) + * [`fn withTopologySpreadConstraints(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraints) + * [`fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraintsmixin) + * [`fn withVersion(version)`](#fn-specwithversion) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specwithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specwithvolumemountsmixin) + * [`fn withVolumes(volumes)`](#fn-specwithvolumes) + * [`fn withVolumesMixin(volumes)`](#fn-specwithvolumesmixin) + * [`obj spec.affinity`](#obj-specaffinity) + * [`obj spec.affinity.nodeAffinity`](#obj-specaffinitynodeaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfieldsmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressions) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfields) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withNodeSelectorTerms(nodeSelectorTerms)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectorterms) + * [`fn withNodeSelectorTermsMixin(nodeSelectorTerms)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectortermsmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfieldsmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfields) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvaluesmixin) + * [`obj spec.affinity.podAffinity`](#obj-specaffinitypodaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity`](#obj-specaffinitypodantiaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.alertmanagerConfigMatcherStrategy`](#obj-specalertmanagerconfigmatcherstrategy) + * [`fn withType(type)`](#fn-specalertmanagerconfigmatcherstrategywithtype) + * [`obj spec.alertmanagerConfigNamespaceSelector`](#obj-specalertmanagerconfignamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specalertmanagerconfignamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specalertmanagerconfignamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specalertmanagerconfignamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specalertmanagerconfignamespaceselectorwithmatchlabelsmixin) + * [`obj spec.alertmanagerConfigNamespaceSelector.matchExpressions`](#obj-specalertmanagerconfignamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specalertmanagerconfignamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specalertmanagerconfignamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specalertmanagerconfignamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specalertmanagerconfignamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.alertmanagerConfigSelector`](#obj-specalertmanagerconfigselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specalertmanagerconfigselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specalertmanagerconfigselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specalertmanagerconfigselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specalertmanagerconfigselectorwithmatchlabelsmixin) + * [`obj spec.alertmanagerConfigSelector.matchExpressions`](#obj-specalertmanagerconfigselectormatchexpressions) + * [`fn withKey(key)`](#fn-specalertmanagerconfigselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specalertmanagerconfigselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specalertmanagerconfigselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specalertmanagerconfigselectormatchexpressionswithvaluesmixin) + * [`obj spec.alertmanagerConfiguration`](#obj-specalertmanagerconfiguration) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationwithname) + * [`fn withTemplates(templates)`](#fn-specalertmanagerconfigurationwithtemplates) + * [`fn withTemplatesMixin(templates)`](#fn-specalertmanagerconfigurationwithtemplatesmixin) + * [`obj spec.alertmanagerConfiguration.global`](#obj-specalertmanagerconfigurationglobal) + * [`fn withPagerdutyUrl(pagerdutyUrl)`](#fn-specalertmanagerconfigurationglobalwithpagerdutyurl) + * [`fn withResolveTimeout(resolveTimeout)`](#fn-specalertmanagerconfigurationglobalwithresolvetimeout) + * [`obj spec.alertmanagerConfiguration.global.httpConfig`](#obj-specalertmanagerconfigurationglobalhttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specalertmanagerconfigurationglobalhttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specalertmanagerconfigurationglobalhttpconfigwithproxyurl) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.authorization`](#obj-specalertmanagerconfigurationglobalhttpconfigauthorization) + * [`fn withType(type)`](#fn-specalertmanagerconfigurationglobalhttpconfigauthorizationwithtype) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.authorization.credentials`](#obj-specalertmanagerconfigurationglobalhttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigauthorizationcredentialswithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.basicAuth`](#obj-specalertmanagerconfigurationglobalhttpconfigbasicauth) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.basicAuth.password`](#obj-specalertmanagerconfigurationglobalhttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigbasicauthpasswordwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.basicAuth.username`](#obj-specalertmanagerconfigurationglobalhttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigbasicauthusernamewithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret`](#obj-specalertmanagerconfigurationglobalhttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigbearertokensecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2withtokenurl) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2clientid) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2clientsecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigwithservername) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigca) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcert) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig`](#obj-specalertmanagerconfigurationglobalhttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigwithservername) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca`](#obj-specalertmanagerconfigurationglobalhttpconfigtlsconfigca) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap`](#obj-specalertmanagerconfigurationglobalhttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret`](#obj-specalertmanagerconfigurationglobalhttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert`](#obj-specalertmanagerconfigurationglobalhttpconfigtlsconfigcert) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap`](#obj-specalertmanagerconfigurationglobalhttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret`](#obj-specalertmanagerconfigurationglobalhttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret`](#obj-specalertmanagerconfigurationglobalhttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalhttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.opsGenieApiKey`](#obj-specalertmanagerconfigurationglobalopsgenieapikey) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalopsgenieapikeywithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalopsgenieapikeywithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalopsgenieapikeywithoptional) + * [`obj spec.alertmanagerConfiguration.global.opsGenieApiUrl`](#obj-specalertmanagerconfigurationglobalopsgenieapiurl) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalopsgenieapiurlwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalopsgenieapiurlwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalopsgenieapiurlwithoptional) + * [`obj spec.alertmanagerConfiguration.global.slackApiUrl`](#obj-specalertmanagerconfigurationglobalslackapiurl) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalslackapiurlwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalslackapiurlwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalslackapiurlwithoptional) + * [`obj spec.alertmanagerConfiguration.global.smtp`](#obj-specalertmanagerconfigurationglobalsmtp) + * [`fn withAuthIdentity(authIdentity)`](#fn-specalertmanagerconfigurationglobalsmtpwithauthidentity) + * [`fn withAuthUsername(authUsername)`](#fn-specalertmanagerconfigurationglobalsmtpwithauthusername) + * [`fn withFrom(from)`](#fn-specalertmanagerconfigurationglobalsmtpwithfrom) + * [`fn withHello(hello)`](#fn-specalertmanagerconfigurationglobalsmtpwithhello) + * [`fn withRequireTLS(requireTLS)`](#fn-specalertmanagerconfigurationglobalsmtpwithrequiretls) + * [`obj spec.alertmanagerConfiguration.global.smtp.authPassword`](#obj-specalertmanagerconfigurationglobalsmtpauthpassword) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalsmtpauthpasswordwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalsmtpauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalsmtpauthpasswordwithoptional) + * [`obj spec.alertmanagerConfiguration.global.smtp.authSecret`](#obj-specalertmanagerconfigurationglobalsmtpauthsecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationglobalsmtpauthsecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationglobalsmtpauthsecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationglobalsmtpauthsecretwithoptional) + * [`obj spec.alertmanagerConfiguration.global.smtp.smartHost`](#obj-specalertmanagerconfigurationglobalsmtpsmarthost) + * [`fn withHost(host)`](#fn-specalertmanagerconfigurationglobalsmtpsmarthostwithhost) + * [`fn withPort(port)`](#fn-specalertmanagerconfigurationglobalsmtpsmarthostwithport) + * [`obj spec.alertmanagerConfiguration.templates`](#obj-specalertmanagerconfigurationtemplates) + * [`obj spec.alertmanagerConfiguration.templates.configMap`](#obj-specalertmanagerconfigurationtemplatesconfigmap) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationtemplatesconfigmapwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationtemplatesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationtemplatesconfigmapwithoptional) + * [`obj spec.alertmanagerConfiguration.templates.secret`](#obj-specalertmanagerconfigurationtemplatessecret) + * [`fn withKey(key)`](#fn-specalertmanagerconfigurationtemplatessecretwithkey) + * [`fn withName(name)`](#fn-specalertmanagerconfigurationtemplatessecretwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagerconfigurationtemplatessecretwithoptional) + * [`obj spec.containers`](#obj-speccontainers) + * [`fn withArgs(args)`](#fn-speccontainerswithargs) + * [`fn withArgsMixin(args)`](#fn-speccontainerswithargsmixin) + * [`fn withCommand(command)`](#fn-speccontainerswithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerswithcommandmixin) + * [`fn withEnv(env)`](#fn-speccontainerswithenv) + * [`fn withEnvFrom(envFrom)`](#fn-speccontainerswithenvfrom) + * [`fn withEnvFromMixin(envFrom)`](#fn-speccontainerswithenvfrommixin) + * [`fn withEnvMixin(env)`](#fn-speccontainerswithenvmixin) + * [`fn withImage(image)`](#fn-speccontainerswithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-speccontainerswithimagepullpolicy) + * [`fn withName(name)`](#fn-speccontainerswithname) + * [`fn withPorts(ports)`](#fn-speccontainerswithports) + * [`fn withPortsMixin(ports)`](#fn-speccontainerswithportsmixin) + * [`fn withResizePolicy(resizePolicy)`](#fn-speccontainerswithresizepolicy) + * [`fn withResizePolicyMixin(resizePolicy)`](#fn-speccontainerswithresizepolicymixin) + * [`fn withRestartPolicy(restartPolicy)`](#fn-speccontainerswithrestartpolicy) + * [`fn withStdin(stdin)`](#fn-speccontainerswithstdin) + * [`fn withStdinOnce(stdinOnce)`](#fn-speccontainerswithstdinonce) + * [`fn withTerminationMessagePath(terminationMessagePath)`](#fn-speccontainerswithterminationmessagepath) + * [`fn withTerminationMessagePolicy(terminationMessagePolicy)`](#fn-speccontainerswithterminationmessagepolicy) + * [`fn withTty(tty)`](#fn-speccontainerswithtty) + * [`fn withVolumeDevices(volumeDevices)`](#fn-speccontainerswithvolumedevices) + * [`fn withVolumeDevicesMixin(volumeDevices)`](#fn-speccontainerswithvolumedevicesmixin) + * [`fn withVolumeMounts(volumeMounts)`](#fn-speccontainerswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-speccontainerswithvolumemountsmixin) + * [`fn withWorkingDir(workingDir)`](#fn-speccontainerswithworkingdir) + * [`obj spec.containers.env`](#obj-speccontainersenv) + * [`fn withName(name)`](#fn-speccontainersenvwithname) + * [`fn withValue(value)`](#fn-speccontainersenvwithvalue) + * [`obj spec.containers.env.valueFrom`](#obj-speccontainersenvvaluefrom) + * [`obj spec.containers.env.valueFrom.configMapKeyRef`](#obj-speccontainersenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.containers.env.valueFrom.fieldRef`](#obj-speccontainersenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-speccontainersenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-speccontainersenvvaluefromfieldrefwithfieldpath) + * [`obj spec.containers.env.valueFrom.resourceFieldRef`](#obj-speccontainersenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-speccontainersenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-speccontainersenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-speccontainersenvvaluefromresourcefieldrefwithresource) + * [`obj spec.containers.env.valueFrom.secretKeyRef`](#obj-speccontainersenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-speccontainersenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-speccontainersenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.containers.envFrom`](#obj-speccontainersenvfrom) + * [`fn withPrefix(prefix)`](#fn-speccontainersenvfromwithprefix) + * [`obj spec.containers.envFrom.configMapRef`](#obj-speccontainersenvfromconfigmapref) + * [`fn withName(name)`](#fn-speccontainersenvfromconfigmaprefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvfromconfigmaprefwithoptional) + * [`obj spec.containers.envFrom.secretRef`](#obj-speccontainersenvfromsecretref) + * [`fn withName(name)`](#fn-speccontainersenvfromsecretrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvfromsecretrefwithoptional) + * [`obj spec.containers.lifecycle`](#obj-speccontainerslifecycle) + * [`obj spec.containers.lifecycle.postStart`](#obj-speccontainerslifecyclepoststart) + * [`obj spec.containers.lifecycle.postStart.exec`](#obj-speccontainerslifecyclepoststartexec) + * [`fn withCommand(command)`](#fn-speccontainerslifecyclepoststartexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslifecyclepoststartexecwithcommandmixin) + * [`obj spec.containers.lifecycle.postStart.httpGet`](#obj-speccontainerslifecyclepoststarthttpget) + * [`fn withHost(host)`](#fn-speccontainerslifecyclepoststarthttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslifecyclepoststarthttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslifecyclepoststarthttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslifecyclepoststarthttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslifecyclepoststarthttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslifecyclepoststarthttpgetwithscheme) + * [`obj spec.containers.lifecycle.postStart.httpGet.httpHeaders`](#obj-speccontainerslifecyclepoststarthttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslifecyclepoststarthttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslifecyclepoststarthttpgethttpheaderswithvalue) + * [`obj spec.containers.lifecycle.postStart.sleep`](#obj-speccontainerslifecyclepoststartsleep) + * [`fn withSeconds(seconds)`](#fn-speccontainerslifecyclepoststartsleepwithseconds) + * [`obj spec.containers.lifecycle.postStart.tcpSocket`](#obj-speccontainerslifecyclepoststarttcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslifecyclepoststarttcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslifecyclepoststarttcpsocketwithport) + * [`obj spec.containers.lifecycle.preStop`](#obj-speccontainerslifecycleprestop) + * [`obj spec.containers.lifecycle.preStop.exec`](#obj-speccontainerslifecycleprestopexec) + * [`fn withCommand(command)`](#fn-speccontainerslifecycleprestopexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslifecycleprestopexecwithcommandmixin) + * [`obj spec.containers.lifecycle.preStop.httpGet`](#obj-speccontainerslifecycleprestophttpget) + * [`fn withHost(host)`](#fn-speccontainerslifecycleprestophttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslifecycleprestophttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslifecycleprestophttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslifecycleprestophttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslifecycleprestophttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslifecycleprestophttpgetwithscheme) + * [`obj spec.containers.lifecycle.preStop.httpGet.httpHeaders`](#obj-speccontainerslifecycleprestophttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslifecycleprestophttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslifecycleprestophttpgethttpheaderswithvalue) + * [`obj spec.containers.lifecycle.preStop.sleep`](#obj-speccontainerslifecycleprestopsleep) + * [`fn withSeconds(seconds)`](#fn-speccontainerslifecycleprestopsleepwithseconds) + * [`obj spec.containers.lifecycle.preStop.tcpSocket`](#obj-speccontainerslifecycleprestoptcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslifecycleprestoptcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslifecycleprestoptcpsocketwithport) + * [`obj spec.containers.livenessProbe`](#obj-speccontainerslivenessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainerslivenessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainerslivenessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainerslivenessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainerslivenessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainerslivenessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainerslivenessprobewithtimeoutseconds) + * [`obj spec.containers.livenessProbe.exec`](#obj-speccontainerslivenessprobeexec) + * [`fn withCommand(command)`](#fn-speccontainerslivenessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslivenessprobeexecwithcommandmixin) + * [`obj spec.containers.livenessProbe.grpc`](#obj-speccontainerslivenessprobegrpc) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainerslivenessprobegrpcwithservice) + * [`obj spec.containers.livenessProbe.httpGet`](#obj-speccontainerslivenessprobehttpget) + * [`fn withHost(host)`](#fn-speccontainerslivenessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslivenessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslivenessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslivenessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslivenessprobehttpgetwithscheme) + * [`obj spec.containers.livenessProbe.httpGet.httpHeaders`](#obj-speccontainerslivenessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslivenessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslivenessprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.livenessProbe.tcpSocket`](#obj-speccontainerslivenessprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslivenessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobetcpsocketwithport) + * [`obj spec.containers.ports`](#obj-speccontainersports) + * [`fn withContainerPort(containerPort)`](#fn-speccontainersportswithcontainerport) + * [`fn withHostIP(hostIP)`](#fn-speccontainersportswithhostip) + * [`fn withHostPort(hostPort)`](#fn-speccontainersportswithhostport) + * [`fn withName(name)`](#fn-speccontainersportswithname) + * [`fn withProtocol(protocol)`](#fn-speccontainersportswithprotocol) + * [`obj spec.containers.readinessProbe`](#obj-speccontainersreadinessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainersreadinessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainersreadinessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainersreadinessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainersreadinessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainersreadinessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainersreadinessprobewithtimeoutseconds) + * [`obj spec.containers.readinessProbe.exec`](#obj-speccontainersreadinessprobeexec) + * [`fn withCommand(command)`](#fn-speccontainersreadinessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainersreadinessprobeexecwithcommandmixin) + * [`obj spec.containers.readinessProbe.grpc`](#obj-speccontainersreadinessprobegrpc) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainersreadinessprobegrpcwithservice) + * [`obj spec.containers.readinessProbe.httpGet`](#obj-speccontainersreadinessprobehttpget) + * [`fn withHost(host)`](#fn-speccontainersreadinessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainersreadinessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainersreadinessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainersreadinessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainersreadinessprobehttpgetwithscheme) + * [`obj spec.containers.readinessProbe.httpGet.httpHeaders`](#obj-speccontainersreadinessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainersreadinessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainersreadinessprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.readinessProbe.tcpSocket`](#obj-speccontainersreadinessprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainersreadinessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobetcpsocketwithport) + * [`obj spec.containers.resizePolicy`](#obj-speccontainersresizepolicy) + * [`fn withResourceName(resourceName)`](#fn-speccontainersresizepolicywithresourcename) + * [`fn withRestartPolicy(restartPolicy)`](#fn-speccontainersresizepolicywithrestartpolicy) + * [`obj spec.containers.resources`](#obj-speccontainersresources) + * [`fn withClaims(claims)`](#fn-speccontainersresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-speccontainersresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-speccontainersresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-speccontainersresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-speccontainersresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-speccontainersresourceswithrequestsmixin) + * [`obj spec.containers.resources.claims`](#obj-speccontainersresourcesclaims) + * [`fn withName(name)`](#fn-speccontainersresourcesclaimswithname) + * [`obj spec.containers.securityContext`](#obj-speccontainerssecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-speccontainerssecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-speccontainerssecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-speccontainerssecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-speccontainerssecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-speccontainerssecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-speccontainerssecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-speccontainerssecuritycontextwithrunasuser) + * [`obj spec.containers.securityContext.appArmorProfile`](#obj-speccontainerssecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-speccontainerssecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextapparmorprofilewithtype) + * [`obj spec.containers.securityContext.capabilities`](#obj-speccontainerssecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-speccontainerssecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-speccontainerssecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-speccontainerssecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-speccontainerssecuritycontextcapabilitieswithdropmixin) + * [`obj spec.containers.securityContext.seLinuxOptions`](#obj-speccontainerssecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-speccontainerssecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-speccontainerssecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-speccontainerssecuritycontextselinuxoptionswithuser) + * [`obj spec.containers.securityContext.seccompProfile`](#obj-speccontainerssecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-speccontainerssecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextseccompprofilewithtype) + * [`obj spec.containers.securityContext.windowsOptions`](#obj-speccontainerssecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-speccontainerssecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-speccontainerssecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-speccontainerssecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-speccontainerssecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.containers.startupProbe`](#obj-speccontainersstartupprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainersstartupprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainersstartupprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainersstartupprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainersstartupprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainersstartupprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainersstartupprobewithtimeoutseconds) + * [`obj spec.containers.startupProbe.exec`](#obj-speccontainersstartupprobeexec) + * [`fn withCommand(command)`](#fn-speccontainersstartupprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainersstartupprobeexecwithcommandmixin) + * [`obj spec.containers.startupProbe.grpc`](#obj-speccontainersstartupprobegrpc) + * [`fn withPort(port)`](#fn-speccontainersstartupprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainersstartupprobegrpcwithservice) + * [`obj spec.containers.startupProbe.httpGet`](#obj-speccontainersstartupprobehttpget) + * [`fn withHost(host)`](#fn-speccontainersstartupprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainersstartupprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainersstartupprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainersstartupprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainersstartupprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainersstartupprobehttpgetwithscheme) + * [`obj spec.containers.startupProbe.httpGet.httpHeaders`](#obj-speccontainersstartupprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainersstartupprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainersstartupprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.startupProbe.tcpSocket`](#obj-speccontainersstartupprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainersstartupprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainersstartupprobetcpsocketwithport) + * [`obj spec.containers.volumeDevices`](#obj-speccontainersvolumedevices) + * [`fn withDevicePath(devicePath)`](#fn-speccontainersvolumedeviceswithdevicepath) + * [`fn withName(name)`](#fn-speccontainersvolumedeviceswithname) + * [`obj spec.containers.volumeMounts`](#obj-speccontainersvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-speccontainersvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-speccontainersvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-speccontainersvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-speccontainersvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-speccontainersvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-speccontainersvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-speccontainersvolumemountswithsubpathexpr) + * [`obj spec.hostAliases`](#obj-spechostaliases) + * [`fn withHostnames(hostnames)`](#fn-spechostaliaseswithhostnames) + * [`fn withHostnamesMixin(hostnames)`](#fn-spechostaliaseswithhostnamesmixin) + * [`fn withIp(ip)`](#fn-spechostaliaseswithip) + * [`obj spec.imagePullSecrets`](#obj-specimagepullsecrets) + * [`fn withName(name)`](#fn-specimagepullsecretswithname) + * [`obj spec.initContainers`](#obj-specinitcontainers) + * [`fn withArgs(args)`](#fn-specinitcontainerswithargs) + * [`fn withArgsMixin(args)`](#fn-specinitcontainerswithargsmixin) + * [`fn withCommand(command)`](#fn-specinitcontainerswithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerswithcommandmixin) + * [`fn withEnv(env)`](#fn-specinitcontainerswithenv) + * [`fn withEnvFrom(envFrom)`](#fn-specinitcontainerswithenvfrom) + * [`fn withEnvFromMixin(envFrom)`](#fn-specinitcontainerswithenvfrommixin) + * [`fn withEnvMixin(env)`](#fn-specinitcontainerswithenvmixin) + * [`fn withImage(image)`](#fn-specinitcontainerswithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-specinitcontainerswithimagepullpolicy) + * [`fn withName(name)`](#fn-specinitcontainerswithname) + * [`fn withPorts(ports)`](#fn-specinitcontainerswithports) + * [`fn withPortsMixin(ports)`](#fn-specinitcontainerswithportsmixin) + * [`fn withResizePolicy(resizePolicy)`](#fn-specinitcontainerswithresizepolicy) + * [`fn withResizePolicyMixin(resizePolicy)`](#fn-specinitcontainerswithresizepolicymixin) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specinitcontainerswithrestartpolicy) + * [`fn withStdin(stdin)`](#fn-specinitcontainerswithstdin) + * [`fn withStdinOnce(stdinOnce)`](#fn-specinitcontainerswithstdinonce) + * [`fn withTerminationMessagePath(terminationMessagePath)`](#fn-specinitcontainerswithterminationmessagepath) + * [`fn withTerminationMessagePolicy(terminationMessagePolicy)`](#fn-specinitcontainerswithterminationmessagepolicy) + * [`fn withTty(tty)`](#fn-specinitcontainerswithtty) + * [`fn withVolumeDevices(volumeDevices)`](#fn-specinitcontainerswithvolumedevices) + * [`fn withVolumeDevicesMixin(volumeDevices)`](#fn-specinitcontainerswithvolumedevicesmixin) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specinitcontainerswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specinitcontainerswithvolumemountsmixin) + * [`fn withWorkingDir(workingDir)`](#fn-specinitcontainerswithworkingdir) + * [`obj spec.initContainers.env`](#obj-specinitcontainersenv) + * [`fn withName(name)`](#fn-specinitcontainersenvwithname) + * [`fn withValue(value)`](#fn-specinitcontainersenvwithvalue) + * [`obj spec.initContainers.env.valueFrom`](#obj-specinitcontainersenvvaluefrom) + * [`obj spec.initContainers.env.valueFrom.configMapKeyRef`](#obj-specinitcontainersenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.initContainers.env.valueFrom.fieldRef`](#obj-specinitcontainersenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specinitcontainersenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specinitcontainersenvvaluefromfieldrefwithfieldpath) + * [`obj spec.initContainers.env.valueFrom.resourceFieldRef`](#obj-specinitcontainersenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithresource) + * [`obj spec.initContainers.env.valueFrom.secretKeyRef`](#obj-specinitcontainersenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.initContainers.envFrom`](#obj-specinitcontainersenvfrom) + * [`fn withPrefix(prefix)`](#fn-specinitcontainersenvfromwithprefix) + * [`obj spec.initContainers.envFrom.configMapRef`](#obj-specinitcontainersenvfromconfigmapref) + * [`fn withName(name)`](#fn-specinitcontainersenvfromconfigmaprefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvfromconfigmaprefwithoptional) + * [`obj spec.initContainers.envFrom.secretRef`](#obj-specinitcontainersenvfromsecretref) + * [`fn withName(name)`](#fn-specinitcontainersenvfromsecretrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvfromsecretrefwithoptional) + * [`obj spec.initContainers.lifecycle`](#obj-specinitcontainerslifecycle) + * [`obj spec.initContainers.lifecycle.postStart`](#obj-specinitcontainerslifecyclepoststart) + * [`obj spec.initContainers.lifecycle.postStart.exec`](#obj-specinitcontainerslifecyclepoststartexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslifecyclepoststartexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslifecyclepoststartexecwithcommandmixin) + * [`obj spec.initContainers.lifecycle.postStart.httpGet`](#obj-specinitcontainerslifecyclepoststarthttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithscheme) + * [`obj spec.initContainers.lifecycle.postStart.httpGet.httpHeaders`](#obj-specinitcontainerslifecyclepoststarthttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslifecyclepoststarthttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslifecyclepoststarthttpgethttpheaderswithvalue) + * [`obj spec.initContainers.lifecycle.postStart.sleep`](#obj-specinitcontainerslifecyclepoststartsleep) + * [`fn withSeconds(seconds)`](#fn-specinitcontainerslifecyclepoststartsleepwithseconds) + * [`obj spec.initContainers.lifecycle.postStart.tcpSocket`](#obj-specinitcontainerslifecyclepoststarttcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslifecyclepoststarttcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslifecyclepoststarttcpsocketwithport) + * [`obj spec.initContainers.lifecycle.preStop`](#obj-specinitcontainerslifecycleprestop) + * [`obj spec.initContainers.lifecycle.preStop.exec`](#obj-specinitcontainerslifecycleprestopexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslifecycleprestopexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslifecycleprestopexecwithcommandmixin) + * [`obj spec.initContainers.lifecycle.preStop.httpGet`](#obj-specinitcontainerslifecycleprestophttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslifecycleprestophttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslifecycleprestophttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslifecycleprestophttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslifecycleprestophttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslifecycleprestophttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslifecycleprestophttpgetwithscheme) + * [`obj spec.initContainers.lifecycle.preStop.httpGet.httpHeaders`](#obj-specinitcontainerslifecycleprestophttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslifecycleprestophttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslifecycleprestophttpgethttpheaderswithvalue) + * [`obj spec.initContainers.lifecycle.preStop.sleep`](#obj-specinitcontainerslifecycleprestopsleep) + * [`fn withSeconds(seconds)`](#fn-specinitcontainerslifecycleprestopsleepwithseconds) + * [`obj spec.initContainers.lifecycle.preStop.tcpSocket`](#obj-specinitcontainerslifecycleprestoptcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslifecycleprestoptcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslifecycleprestoptcpsocketwithport) + * [`obj spec.initContainers.livenessProbe`](#obj-specinitcontainerslivenessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainerslivenessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainerslivenessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainerslivenessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainerslivenessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainerslivenessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainerslivenessprobewithtimeoutseconds) + * [`obj spec.initContainers.livenessProbe.exec`](#obj-specinitcontainerslivenessprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslivenessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslivenessprobeexecwithcommandmixin) + * [`obj spec.initContainers.livenessProbe.grpc`](#obj-specinitcontainerslivenessprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainerslivenessprobegrpcwithservice) + * [`obj spec.initContainers.livenessProbe.httpGet`](#obj-specinitcontainerslivenessprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslivenessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslivenessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslivenessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslivenessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslivenessprobehttpgetwithscheme) + * [`obj spec.initContainers.livenessProbe.httpGet.httpHeaders`](#obj-specinitcontainerslivenessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslivenessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslivenessprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.livenessProbe.tcpSocket`](#obj-specinitcontainerslivenessprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslivenessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobetcpsocketwithport) + * [`obj spec.initContainers.ports`](#obj-specinitcontainersports) + * [`fn withContainerPort(containerPort)`](#fn-specinitcontainersportswithcontainerport) + * [`fn withHostIP(hostIP)`](#fn-specinitcontainersportswithhostip) + * [`fn withHostPort(hostPort)`](#fn-specinitcontainersportswithhostport) + * [`fn withName(name)`](#fn-specinitcontainersportswithname) + * [`fn withProtocol(protocol)`](#fn-specinitcontainersportswithprotocol) + * [`obj spec.initContainers.readinessProbe`](#obj-specinitcontainersreadinessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainersreadinessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainersreadinessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainersreadinessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainersreadinessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainersreadinessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainersreadinessprobewithtimeoutseconds) + * [`obj spec.initContainers.readinessProbe.exec`](#obj-specinitcontainersreadinessprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainersreadinessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainersreadinessprobeexecwithcommandmixin) + * [`obj spec.initContainers.readinessProbe.grpc`](#obj-specinitcontainersreadinessprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainersreadinessprobegrpcwithservice) + * [`obj spec.initContainers.readinessProbe.httpGet`](#obj-specinitcontainersreadinessprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainersreadinessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainersreadinessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainersreadinessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainersreadinessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainersreadinessprobehttpgetwithscheme) + * [`obj spec.initContainers.readinessProbe.httpGet.httpHeaders`](#obj-specinitcontainersreadinessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainersreadinessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainersreadinessprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.readinessProbe.tcpSocket`](#obj-specinitcontainersreadinessprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainersreadinessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobetcpsocketwithport) + * [`obj spec.initContainers.resizePolicy`](#obj-specinitcontainersresizepolicy) + * [`fn withResourceName(resourceName)`](#fn-specinitcontainersresizepolicywithresourcename) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specinitcontainersresizepolicywithrestartpolicy) + * [`obj spec.initContainers.resources`](#obj-specinitcontainersresources) + * [`fn withClaims(claims)`](#fn-specinitcontainersresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specinitcontainersresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specinitcontainersresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specinitcontainersresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specinitcontainersresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specinitcontainersresourceswithrequestsmixin) + * [`obj spec.initContainers.resources.claims`](#obj-specinitcontainersresourcesclaims) + * [`fn withName(name)`](#fn-specinitcontainersresourcesclaimswithname) + * [`obj spec.initContainers.securityContext`](#obj-specinitcontainerssecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-specinitcontainerssecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-specinitcontainerssecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-specinitcontainerssecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-specinitcontainerssecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specinitcontainerssecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specinitcontainerssecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specinitcontainerssecuritycontextwithrunasuser) + * [`obj spec.initContainers.securityContext.appArmorProfile`](#obj-specinitcontainerssecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specinitcontainerssecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextapparmorprofilewithtype) + * [`obj spec.initContainers.securityContext.capabilities`](#obj-specinitcontainerssecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-specinitcontainerssecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-specinitcontainerssecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-specinitcontainerssecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-specinitcontainerssecuritycontextcapabilitieswithdropmixin) + * [`obj spec.initContainers.securityContext.seLinuxOptions`](#obj-specinitcontainerssecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithuser) + * [`obj spec.initContainers.securityContext.seccompProfile`](#obj-specinitcontainerssecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specinitcontainerssecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextseccompprofilewithtype) + * [`obj spec.initContainers.securityContext.windowsOptions`](#obj-specinitcontainerssecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.initContainers.startupProbe`](#obj-specinitcontainersstartupprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainersstartupprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainersstartupprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainersstartupprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainersstartupprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainersstartupprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainersstartupprobewithtimeoutseconds) + * [`obj spec.initContainers.startupProbe.exec`](#obj-specinitcontainersstartupprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainersstartupprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainersstartupprobeexecwithcommandmixin) + * [`obj spec.initContainers.startupProbe.grpc`](#obj-specinitcontainersstartupprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainersstartupprobegrpcwithservice) + * [`obj spec.initContainers.startupProbe.httpGet`](#obj-specinitcontainersstartupprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainersstartupprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainersstartupprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainersstartupprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainersstartupprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainersstartupprobehttpgetwithscheme) + * [`obj spec.initContainers.startupProbe.httpGet.httpHeaders`](#obj-specinitcontainersstartupprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainersstartupprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainersstartupprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.startupProbe.tcpSocket`](#obj-specinitcontainersstartupprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainersstartupprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobetcpsocketwithport) + * [`obj spec.initContainers.volumeDevices`](#obj-specinitcontainersvolumedevices) + * [`fn withDevicePath(devicePath)`](#fn-specinitcontainersvolumedeviceswithdevicepath) + * [`fn withName(name)`](#fn-specinitcontainersvolumedeviceswithname) + * [`obj spec.initContainers.volumeMounts`](#obj-specinitcontainersvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specinitcontainersvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specinitcontainersvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specinitcontainersvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specinitcontainersvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-specinitcontainersvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-specinitcontainersvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specinitcontainersvolumemountswithsubpathexpr) + * [`obj spec.podMetadata`](#obj-specpodmetadata) + * [`fn withAnnotations(annotations)`](#fn-specpodmetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specpodmetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specpodmetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specpodmetadatawithlabelsmixin) + * [`fn withName(name)`](#fn-specpodmetadatawithname) + * [`obj spec.resources`](#obj-specresources) + * [`fn withClaims(claims)`](#fn-specresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specresourceswithrequestsmixin) + * [`obj spec.resources.claims`](#obj-specresourcesclaims) + * [`fn withName(name)`](#fn-specresourcesclaimswithname) + * [`obj spec.securityContext`](#obj-specsecuritycontext) + * [`fn withFsGroup(fsGroup)`](#fn-specsecuritycontextwithfsgroup) + * [`fn withFsGroupChangePolicy(fsGroupChangePolicy)`](#fn-specsecuritycontextwithfsgroupchangepolicy) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specsecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specsecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specsecuritycontextwithrunasuser) + * [`fn withSupplementalGroups(supplementalGroups)`](#fn-specsecuritycontextwithsupplementalgroups) + * [`fn withSupplementalGroupsMixin(supplementalGroups)`](#fn-specsecuritycontextwithsupplementalgroupsmixin) + * [`fn withSysctls(sysctls)`](#fn-specsecuritycontextwithsysctls) + * [`fn withSysctlsMixin(sysctls)`](#fn-specsecuritycontextwithsysctlsmixin) + * [`obj spec.securityContext.appArmorProfile`](#obj-specsecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specsecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specsecuritycontextapparmorprofilewithtype) + * [`obj spec.securityContext.seLinuxOptions`](#obj-specsecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specsecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specsecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specsecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specsecuritycontextselinuxoptionswithuser) + * [`obj spec.securityContext.seccompProfile`](#obj-specsecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specsecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specsecuritycontextseccompprofilewithtype) + * [`obj spec.securityContext.sysctls`](#obj-specsecuritycontextsysctls) + * [`fn withName(name)`](#fn-specsecuritycontextsysctlswithname) + * [`fn withValue(value)`](#fn-specsecuritycontextsysctlswithvalue) + * [`obj spec.securityContext.windowsOptions`](#obj-specsecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specsecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specsecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specsecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specsecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.storage`](#obj-specstorage) + * [`fn withDisableMountSubPath(disableMountSubPath)`](#fn-specstoragewithdisablemountsubpath) + * [`obj spec.storage.emptyDir`](#obj-specstorageemptydir) + * [`fn withMedium(medium)`](#fn-specstorageemptydirwithmedium) + * [`fn withSizeLimit(sizeLimit)`](#fn-specstorageemptydirwithsizelimit) + * [`obj spec.storage.ephemeral`](#obj-specstorageephemeral) + * [`obj spec.storage.ephemeral.volumeClaimTemplate`](#obj-specstorageephemeralvolumeclaimtemplate) + * [`fn withMetadata(metadata)`](#fn-specstorageephemeralvolumeclaimtemplatewithmetadata) + * [`fn withMetadataMixin(metadata)`](#fn-specstorageephemeralvolumeclaimtemplatewithmetadatamixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec`](#obj-specstorageephemeralvolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumename) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource`](#obj-specstorageephemeralvolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef`](#obj-specstorageephemeralvolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.resources`](#obj-specstorageephemeralvolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector`](#obj-specstorageephemeralvolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.storage.volumeClaimTemplate`](#obj-specstoragevolumeclaimtemplate) + * [`fn withApiVersion(apiVersion)`](#fn-specstoragevolumeclaimtemplatewithapiversion) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatewithkind) + * [`obj spec.storage.volumeClaimTemplate.metadata`](#obj-specstoragevolumeclaimtemplatemetadata) + * [`fn withAnnotations(annotations)`](#fn-specstoragevolumeclaimtemplatemetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specstoragevolumeclaimtemplatemetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specstoragevolumeclaimtemplatemetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specstoragevolumeclaimtemplatemetadatawithlabelsmixin) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatemetadatawithname) + * [`obj spec.storage.volumeClaimTemplate.spec`](#obj-specstoragevolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specstoragevolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specstoragevolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specstoragevolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specstoragevolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specstoragevolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specstoragevolumeclaimtemplatespecwithvolumename) + * [`obj spec.storage.volumeClaimTemplate.spec.dataSource`](#obj-specstoragevolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.storage.volumeClaimTemplate.spec.dataSourceRef`](#obj-specstoragevolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.storage.volumeClaimTemplate.spec.resources`](#obj-specstoragevolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specstoragevolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specstoragevolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specstoragevolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specstoragevolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.storage.volumeClaimTemplate.spec.selector`](#obj-specstoragevolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.storage.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specstoragevolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.tolerations`](#obj-spectolerations) + * [`fn withEffect(effect)`](#fn-spectolerationswitheffect) + * [`fn withKey(key)`](#fn-spectolerationswithkey) + * [`fn withOperator(operator)`](#fn-spectolerationswithoperator) + * [`fn withTolerationSeconds(tolerationSeconds)`](#fn-spectolerationswithtolerationseconds) + * [`fn withValue(value)`](#fn-spectolerationswithvalue) + * [`obj spec.topologySpreadConstraints`](#obj-spectopologyspreadconstraints) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeysmixin) + * [`fn withMaxSkew(maxSkew)`](#fn-spectopologyspreadconstraintswithmaxskew) + * [`fn withMinDomains(minDomains)`](#fn-spectopologyspreadconstraintswithmindomains) + * [`fn withNodeAffinityPolicy(nodeAffinityPolicy)`](#fn-spectopologyspreadconstraintswithnodeaffinitypolicy) + * [`fn withNodeTaintsPolicy(nodeTaintsPolicy)`](#fn-spectopologyspreadconstraintswithnodetaintspolicy) + * [`fn withTopologyKey(topologyKey)`](#fn-spectopologyspreadconstraintswithtopologykey) + * [`fn withWhenUnsatisfiable(whenUnsatisfiable)`](#fn-spectopologyspreadconstraintswithwhenunsatisfiable) + * [`obj spec.topologySpreadConstraints.labelSelector`](#obj-spectopologyspreadconstraintslabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchlabelsmixin) + * [`obj spec.topologySpreadConstraints.labelSelector.matchExpressions`](#obj-spectopologyspreadconstraintslabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.volumeMounts`](#obj-specvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-specvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-specvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specvolumemountswithsubpathexpr) + * [`obj spec.volumes`](#obj-specvolumes) + * [`fn withName(name)`](#fn-specvolumeswithname) + * [`obj spec.volumes.awsElasticBlockStore`](#obj-specvolumesawselasticblockstore) + * [`fn withFsType(fsType)`](#fn-specvolumesawselasticblockstorewithfstype) + * [`fn withPartition(partition)`](#fn-specvolumesawselasticblockstorewithpartition) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesawselasticblockstorewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumesawselasticblockstorewithvolumeid) + * [`obj spec.volumes.azureDisk`](#obj-specvolumesazuredisk) + * [`fn withCachingMode(cachingMode)`](#fn-specvolumesazurediskwithcachingmode) + * [`fn withDiskName(diskName)`](#fn-specvolumesazurediskwithdiskname) + * [`fn withDiskURI(diskURI)`](#fn-specvolumesazurediskwithdiskuri) + * [`fn withFsType(fsType)`](#fn-specvolumesazurediskwithfstype) + * [`fn withKind(kind)`](#fn-specvolumesazurediskwithkind) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesazurediskwithreadonly) + * [`obj spec.volumes.azureFile`](#obj-specvolumesazurefile) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesazurefilewithreadonly) + * [`fn withSecretName(secretName)`](#fn-specvolumesazurefilewithsecretname) + * [`fn withShareName(shareName)`](#fn-specvolumesazurefilewithsharename) + * [`obj spec.volumes.cephfs`](#obj-specvolumescephfs) + * [`fn withMonitors(monitors)`](#fn-specvolumescephfswithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specvolumescephfswithmonitorsmixin) + * [`fn withPath(path)`](#fn-specvolumescephfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescephfswithreadonly) + * [`fn withSecretFile(secretFile)`](#fn-specvolumescephfswithsecretfile) + * [`fn withUser(user)`](#fn-specvolumescephfswithuser) + * [`obj spec.volumes.cephfs.secretRef`](#obj-specvolumescephfssecretref) + * [`fn withName(name)`](#fn-specvolumescephfssecretrefwithname) + * [`obj spec.volumes.cinder`](#obj-specvolumescinder) + * [`fn withFsType(fsType)`](#fn-specvolumescinderwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescinderwithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumescinderwithvolumeid) + * [`obj spec.volumes.cinder.secretRef`](#obj-specvolumescindersecretref) + * [`fn withName(name)`](#fn-specvolumescindersecretrefwithname) + * [`obj spec.volumes.configMap`](#obj-specvolumesconfigmap) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesconfigmapwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specvolumesconfigmapwithoptional) + * [`obj spec.volumes.configMap.items`](#obj-specvolumesconfigmapitems) + * [`fn withKey(key)`](#fn-specvolumesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesconfigmapitemswithpath) + * [`obj spec.volumes.csi`](#obj-specvolumescsi) + * [`fn withDriver(driver)`](#fn-specvolumescsiwithdriver) + * [`fn withFsType(fsType)`](#fn-specvolumescsiwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescsiwithreadonly) + * [`fn withVolumeAttributes(volumeAttributes)`](#fn-specvolumescsiwithvolumeattributes) + * [`fn withVolumeAttributesMixin(volumeAttributes)`](#fn-specvolumescsiwithvolumeattributesmixin) + * [`obj spec.volumes.csi.nodePublishSecretRef`](#obj-specvolumescsinodepublishsecretref) + * [`fn withName(name)`](#fn-specvolumescsinodepublishsecretrefwithname) + * [`obj spec.volumes.downwardAPI`](#obj-specvolumesdownwardapi) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesdownwardapiwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesdownwardapiwithitemsmixin) + * [`obj spec.volumes.downwardAPI.items`](#obj-specvolumesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specvolumesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesdownwardapiitemswithpath) + * [`obj spec.volumes.downwardAPI.items.fieldRef`](#obj-specvolumesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specvolumesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specvolumesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.volumes.downwardAPI.items.resourceFieldRef`](#obj-specvolumesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.volumes.emptyDir`](#obj-specvolumesemptydir) + * [`fn withMedium(medium)`](#fn-specvolumesemptydirwithmedium) + * [`fn withSizeLimit(sizeLimit)`](#fn-specvolumesemptydirwithsizelimit) + * [`obj spec.volumes.ephemeral`](#obj-specvolumesephemeral) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate`](#obj-specvolumesephemeralvolumeclaimtemplate) + * [`fn withMetadata(metadata)`](#fn-specvolumesephemeralvolumeclaimtemplatewithmetadata) + * [`fn withMetadataMixin(metadata)`](#fn-specvolumesephemeralvolumeclaimtemplatewithmetadatamixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec`](#obj-specvolumesephemeralvolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumename) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource`](#obj-specvolumesephemeralvolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef`](#obj-specvolumesephemeralvolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.resources`](#obj-specvolumesephemeralvolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector`](#obj-specvolumesephemeralvolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.volumes.fc`](#obj-specvolumesfc) + * [`fn withFsType(fsType)`](#fn-specvolumesfcwithfstype) + * [`fn withLun(lun)`](#fn-specvolumesfcwithlun) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesfcwithreadonly) + * [`fn withTargetWWNs(targetWWNs)`](#fn-specvolumesfcwithtargetwwns) + * [`fn withTargetWWNsMixin(targetWWNs)`](#fn-specvolumesfcwithtargetwwnsmixin) + * [`fn withWwids(wwids)`](#fn-specvolumesfcwithwwids) + * [`fn withWwidsMixin(wwids)`](#fn-specvolumesfcwithwwidsmixin) + * [`obj spec.volumes.flexVolume`](#obj-specvolumesflexvolume) + * [`fn withDriver(driver)`](#fn-specvolumesflexvolumewithdriver) + * [`fn withFsType(fsType)`](#fn-specvolumesflexvolumewithfstype) + * [`fn withOptions(options)`](#fn-specvolumesflexvolumewithoptions) + * [`fn withOptionsMixin(options)`](#fn-specvolumesflexvolumewithoptionsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesflexvolumewithreadonly) + * [`obj spec.volumes.flexVolume.secretRef`](#obj-specvolumesflexvolumesecretref) + * [`fn withName(name)`](#fn-specvolumesflexvolumesecretrefwithname) + * [`obj spec.volumes.flocker`](#obj-specvolumesflocker) + * [`fn withDatasetName(datasetName)`](#fn-specvolumesflockerwithdatasetname) + * [`fn withDatasetUUID(datasetUUID)`](#fn-specvolumesflockerwithdatasetuuid) + * [`obj spec.volumes.gcePersistentDisk`](#obj-specvolumesgcepersistentdisk) + * [`fn withFsType(fsType)`](#fn-specvolumesgcepersistentdiskwithfstype) + * [`fn withPartition(partition)`](#fn-specvolumesgcepersistentdiskwithpartition) + * [`fn withPdName(pdName)`](#fn-specvolumesgcepersistentdiskwithpdname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesgcepersistentdiskwithreadonly) + * [`obj spec.volumes.gitRepo`](#obj-specvolumesgitrepo) + * [`fn withDirectory(directory)`](#fn-specvolumesgitrepowithdirectory) + * [`fn withRepository(repository)`](#fn-specvolumesgitrepowithrepository) + * [`fn withRevision(revision)`](#fn-specvolumesgitrepowithrevision) + * [`obj spec.volumes.glusterfs`](#obj-specvolumesglusterfs) + * [`fn withEndpoints(endpoints)`](#fn-specvolumesglusterfswithendpoints) + * [`fn withPath(path)`](#fn-specvolumesglusterfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesglusterfswithreadonly) + * [`obj spec.volumes.hostPath`](#obj-specvolumeshostpath) + * [`fn withPath(path)`](#fn-specvolumeshostpathwithpath) + * [`fn withType(type)`](#fn-specvolumeshostpathwithtype) + * [`obj spec.volumes.iscsi`](#obj-specvolumesiscsi) + * [`fn withChapAuthDiscovery(chapAuthDiscovery)`](#fn-specvolumesiscsiwithchapauthdiscovery) + * [`fn withChapAuthSession(chapAuthSession)`](#fn-specvolumesiscsiwithchapauthsession) + * [`fn withFsType(fsType)`](#fn-specvolumesiscsiwithfstype) + * [`fn withInitiatorName(initiatorName)`](#fn-specvolumesiscsiwithinitiatorname) + * [`fn withIqn(iqn)`](#fn-specvolumesiscsiwithiqn) + * [`fn withIscsiInterface(iscsiInterface)`](#fn-specvolumesiscsiwithiscsiinterface) + * [`fn withLun(lun)`](#fn-specvolumesiscsiwithlun) + * [`fn withPortals(portals)`](#fn-specvolumesiscsiwithportals) + * [`fn withPortalsMixin(portals)`](#fn-specvolumesiscsiwithportalsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesiscsiwithreadonly) + * [`fn withTargetPortal(targetPortal)`](#fn-specvolumesiscsiwithtargetportal) + * [`obj spec.volumes.iscsi.secretRef`](#obj-specvolumesiscsisecretref) + * [`fn withName(name)`](#fn-specvolumesiscsisecretrefwithname) + * [`obj spec.volumes.nfs`](#obj-specvolumesnfs) + * [`fn withPath(path)`](#fn-specvolumesnfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesnfswithreadonly) + * [`fn withServer(server)`](#fn-specvolumesnfswithserver) + * [`obj spec.volumes.persistentVolumeClaim`](#obj-specvolumespersistentvolumeclaim) + * [`fn withClaimName(claimName)`](#fn-specvolumespersistentvolumeclaimwithclaimname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumespersistentvolumeclaimwithreadonly) + * [`obj spec.volumes.photonPersistentDisk`](#obj-specvolumesphotonpersistentdisk) + * [`fn withFsType(fsType)`](#fn-specvolumesphotonpersistentdiskwithfstype) + * [`fn withPdID(pdID)`](#fn-specvolumesphotonpersistentdiskwithpdid) + * [`obj spec.volumes.portworxVolume`](#obj-specvolumesportworxvolume) + * [`fn withFsType(fsType)`](#fn-specvolumesportworxvolumewithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesportworxvolumewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumesportworxvolumewithvolumeid) + * [`obj spec.volumes.projected`](#obj-specvolumesprojected) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesprojectedwithdefaultmode) + * [`fn withSources(sources)`](#fn-specvolumesprojectedwithsources) + * [`fn withSourcesMixin(sources)`](#fn-specvolumesprojectedwithsourcesmixin) + * [`obj spec.volumes.projected.sources`](#obj-specvolumesprojectedsources) + * [`obj spec.volumes.projected.sources.clusterTrustBundle`](#obj-specvolumesprojectedsourcesclustertrustbundle) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithoptional) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithpath) + * [`fn withSignerName(signerName)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithsignername) + * [`obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector`](#obj-specvolumesprojectedsourcesclustertrustbundlelabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchlabelsmixin) + * [`obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions`](#obj-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.volumes.projected.sources.configMap`](#obj-specvolumesprojectedsourcesconfigmap) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcesconfigmapwithoptional) + * [`obj spec.volumes.projected.sources.configMap.items`](#obj-specvolumesprojectedsourcesconfigmapitems) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesconfigmapitemswithpath) + * [`obj spec.volumes.projected.sources.downwardAPI`](#obj-specvolumesprojectedsourcesdownwardapi) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcesdownwardapiwithitemsmixin) + * [`obj spec.volumes.projected.sources.downwardAPI.items`](#obj-specvolumesprojectedsourcesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesdownwardapiitemswithpath) + * [`obj spec.volumes.projected.sources.downwardAPI.items.fieldRef`](#obj-specvolumesprojectedsourcesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specvolumesprojectedsourcesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specvolumesprojectedsourcesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef`](#obj-specvolumesprojectedsourcesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.volumes.projected.sources.secret`](#obj-specvolumesprojectedsourcessecret) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcessecretwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcessecretwithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcessecretwithoptional) + * [`obj spec.volumes.projected.sources.secret.items`](#obj-specvolumesprojectedsourcessecretitems) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcessecretitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcessecretitemswithpath) + * [`obj spec.volumes.projected.sources.serviceAccountToken`](#obj-specvolumesprojectedsourcesserviceaccounttoken) + * [`fn withAudience(audience)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithaudience) + * [`fn withExpirationSeconds(expirationSeconds)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithexpirationseconds) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithpath) + * [`obj spec.volumes.quobyte`](#obj-specvolumesquobyte) + * [`fn withGroup(group)`](#fn-specvolumesquobytewithgroup) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesquobytewithreadonly) + * [`fn withRegistry(registry)`](#fn-specvolumesquobytewithregistry) + * [`fn withTenant(tenant)`](#fn-specvolumesquobytewithtenant) + * [`fn withUser(user)`](#fn-specvolumesquobytewithuser) + * [`fn withVolume(volume)`](#fn-specvolumesquobytewithvolume) + * [`obj spec.volumes.rbd`](#obj-specvolumesrbd) + * [`fn withFsType(fsType)`](#fn-specvolumesrbdwithfstype) + * [`fn withImage(image)`](#fn-specvolumesrbdwithimage) + * [`fn withKeyring(keyring)`](#fn-specvolumesrbdwithkeyring) + * [`fn withMonitors(monitors)`](#fn-specvolumesrbdwithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specvolumesrbdwithmonitorsmixin) + * [`fn withPool(pool)`](#fn-specvolumesrbdwithpool) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesrbdwithreadonly) + * [`fn withUser(user)`](#fn-specvolumesrbdwithuser) + * [`obj spec.volumes.rbd.secretRef`](#obj-specvolumesrbdsecretref) + * [`fn withName(name)`](#fn-specvolumesrbdsecretrefwithname) + * [`obj spec.volumes.scaleIO`](#obj-specvolumesscaleio) + * [`fn withFsType(fsType)`](#fn-specvolumesscaleiowithfstype) + * [`fn withGateway(gateway)`](#fn-specvolumesscaleiowithgateway) + * [`fn withProtectionDomain(protectionDomain)`](#fn-specvolumesscaleiowithprotectiondomain) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesscaleiowithreadonly) + * [`fn withSslEnabled(sslEnabled)`](#fn-specvolumesscaleiowithsslenabled) + * [`fn withStorageMode(storageMode)`](#fn-specvolumesscaleiowithstoragemode) + * [`fn withStoragePool(storagePool)`](#fn-specvolumesscaleiowithstoragepool) + * [`fn withSystem(system)`](#fn-specvolumesscaleiowithsystem) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesscaleiowithvolumename) + * [`obj spec.volumes.scaleIO.secretRef`](#obj-specvolumesscaleiosecretref) + * [`fn withName(name)`](#fn-specvolumesscaleiosecretrefwithname) + * [`obj spec.volumes.secret`](#obj-specvolumessecret) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumessecretwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumessecretwithitemsmixin) + * [`fn withOptional(optional)`](#fn-specvolumessecretwithoptional) + * [`fn withSecretName(secretName)`](#fn-specvolumessecretwithsecretname) + * [`obj spec.volumes.secret.items`](#obj-specvolumessecretitems) + * [`fn withKey(key)`](#fn-specvolumessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumessecretitemswithmode) + * [`fn withPath(path)`](#fn-specvolumessecretitemswithpath) + * [`obj spec.volumes.storageos`](#obj-specvolumesstorageos) + * [`fn withFsType(fsType)`](#fn-specvolumesstorageoswithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesstorageoswithreadonly) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesstorageoswithvolumename) + * [`fn withVolumeNamespace(volumeNamespace)`](#fn-specvolumesstorageoswithvolumenamespace) + * [`obj spec.volumes.storageos.secretRef`](#obj-specvolumesstorageossecretref) + * [`fn withName(name)`](#fn-specvolumesstorageossecretrefwithname) + * [`obj spec.volumes.vsphereVolume`](#obj-specvolumesvspherevolume) + * [`fn withFsType(fsType)`](#fn-specvolumesvspherevolumewithfstype) + * [`fn withStoragePolicyID(storagePolicyID)`](#fn-specvolumesvspherevolumewithstoragepolicyid) + * [`fn withStoragePolicyName(storagePolicyName)`](#fn-specvolumesvspherevolumewithstoragepolicyname) + * [`fn withVolumePath(volumePath)`](#fn-specvolumesvspherevolumewithvolumepath) + * [`obj spec.web`](#obj-specweb) + * [`fn withGetConcurrency(getConcurrency)`](#fn-specwebwithgetconcurrency) + * [`fn withTimeout(timeout)`](#fn-specwebwithtimeout) + * [`obj spec.web.httpConfig`](#obj-specwebhttpconfig) + * [`fn withHttp2(http2)`](#fn-specwebhttpconfigwithhttp2) + * [`obj spec.web.httpConfig.headers`](#obj-specwebhttpconfigheaders) + * [`fn withContentSecurityPolicy(contentSecurityPolicy)`](#fn-specwebhttpconfigheaderswithcontentsecuritypolicy) + * [`fn withStrictTransportSecurity(strictTransportSecurity)`](#fn-specwebhttpconfigheaderswithstricttransportsecurity) + * [`fn withXContentTypeOptions(xContentTypeOptions)`](#fn-specwebhttpconfigheaderswithxcontenttypeoptions) + * [`fn withXFrameOptions(xFrameOptions)`](#fn-specwebhttpconfigheaderswithxframeoptions) + * [`fn withXXSSProtection(xXSSProtection)`](#fn-specwebhttpconfigheaderswithxxssprotection) + * [`obj spec.web.tlsConfig`](#obj-specwebtlsconfig) + * [`fn withCipherSuites(cipherSuites)`](#fn-specwebtlsconfigwithciphersuites) + * [`fn withCipherSuitesMixin(cipherSuites)`](#fn-specwebtlsconfigwithciphersuitesmixin) + * [`fn withClientAuthType(clientAuthType)`](#fn-specwebtlsconfigwithclientauthtype) + * [`fn withCurvePreferences(curvePreferences)`](#fn-specwebtlsconfigwithcurvepreferences) + * [`fn withCurvePreferencesMixin(curvePreferences)`](#fn-specwebtlsconfigwithcurvepreferencesmixin) + * [`fn withMaxVersion(maxVersion)`](#fn-specwebtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specwebtlsconfigwithminversion) + * [`fn withPreferServerCipherSuites(preferServerCipherSuites)`](#fn-specwebtlsconfigwithpreferserverciphersuites) + * [`obj spec.web.tlsConfig.cert`](#obj-specwebtlsconfigcert) + * [`obj spec.web.tlsConfig.cert.configMap`](#obj-specwebtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specwebtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigcertconfigmapwithoptional) + * [`obj spec.web.tlsConfig.cert.secret`](#obj-specwebtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigcertsecretwithoptional) + * [`obj spec.web.tlsConfig.client_ca`](#obj-specwebtlsconfigclient_ca) + * [`obj spec.web.tlsConfig.client_ca.configMap`](#obj-specwebtlsconfigclient_caconfigmap) + * [`fn withKey(key)`](#fn-specwebtlsconfigclient_caconfigmapwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigclient_caconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigclient_caconfigmapwithoptional) + * [`obj spec.web.tlsConfig.client_ca.secret`](#obj-specwebtlsconfigclient_casecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigclient_casecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigclient_casecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigclient_casecretwithoptional) + * [`obj spec.web.tlsConfig.keySecret`](#obj-specwebtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigkeysecretwithoptional) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Alertmanager + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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 Alertmanager cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" + +### fn spec.withAdditionalPeers + +```ts +withAdditionalPeers(additionalPeers) +``` + +"AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster." + +### fn spec.withAdditionalPeersMixin + +```ts +withAdditionalPeersMixin(additionalPeers) +``` + +"AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster." + +**Note:** This function appends passed data to existing values + +### fn spec.withAutomountServiceAccountToken + +```ts +withAutomountServiceAccountToken(automountServiceAccountToken) +``` + +"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\nIf the service account has `automountServiceAccountToken: true`, set the field to `false` to opt out of automounting API credentials." + +### fn spec.withBaseImage + +```ts +withBaseImage(baseImage) +``` + +"Base image that is used to deploy pods, without tag.\nDeprecated: use 'image' instead." + +### fn spec.withClusterAdvertiseAddress + +```ts +withClusterAdvertiseAddress(clusterAdvertiseAddress) +``` + +"ClusterAdvertiseAddress is the explicit address to advertise in cluster.\nNeeds to be provided for non RFC1918 [1] (public) addresses.\n[1] RFC1918: https://tools.ietf.org/html/rfc1918" + +### fn spec.withClusterGossipInterval + +```ts +withClusterGossipInterval(clusterGossipInterval) +``` + +"Interval between gossip attempts." + +### fn spec.withClusterLabel + +```ts +withClusterLabel(clusterLabel) +``` + +"Defines the identifier that uniquely identifies the Alertmanager cluster.\nYou should only set it when the Alertmanager cluster includes Alertmanager instances which are external to this Alertmanager resource. In practice, the addresses of the external instances are provided via the `.spec.additionalPeers` field." + +### fn spec.withClusterPeerTimeout + +```ts +withClusterPeerTimeout(clusterPeerTimeout) +``` + +"Timeout for cluster peering." + +### fn spec.withClusterPushpullInterval + +```ts +withClusterPushpullInterval(clusterPushpullInterval) +``` + +"Interval between pushpull attempts." + +### fn spec.withConfigMaps + +```ts +withConfigMaps(configMaps) +``` + +"ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager\nobject, which shall be mounted into the Alertmanager Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into `/etc/alertmanager/configmaps/` in the 'alertmanager' container." + +### fn spec.withConfigMapsMixin + +```ts +withConfigMapsMixin(configMaps) +``` + +"ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager\nobject, which shall be mounted into the Alertmanager Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into `/etc/alertmanager/configmaps/` in the 'alertmanager' container." + +**Note:** This function appends passed data to existing values + +### fn spec.withConfigSecret + +```ts +withConfigSecret(configSecret) +``` + +"ConfigSecret is the name of a Kubernetes Secret in the same namespace as the\nAlertmanager object, which contains the configuration for this Alertmanager\ninstance. If empty, it defaults to `alertmanager-`.\n\n\nThe Alertmanager configuration should be available under the\n`alertmanager.yaml` key. Additional keys from the original secret are\ncopied to the generated secret and mounted into the\n`/etc/alertmanager/config` directory in the `alertmanager` container.\n\n\nIf either the secret or the `alertmanager.yaml` key is missing, the\noperator provisions a minimal Alertmanager configuration with one empty\nreceiver (effectively dropping alert notifications)." + +### fn spec.withContainers + +```ts +withContainers(containers) +``` + +"Containers allows injecting additional containers. This is meant to\nallow adding an authentication proxy to an Alertmanager pod.\nContainers described here modify an operator generated container if they\nshare the same name and modifications are done via a strategic merge\npatch. The current container names are: `alertmanager` and\n`config-reloader`. Overriding containers is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice." + +### fn spec.withContainersMixin + +```ts +withContainersMixin(containers) +``` + +"Containers allows injecting additional containers. This is meant to\nallow adding an authentication proxy to an Alertmanager pod.\nContainers described here modify an operator generated container if they\nshare the same name and modifications are done via a strategic merge\npatch. The current container names are: `alertmanager` and\n`config-reloader`. Overriding containers is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice." + +**Note:** This function appends passed data to existing values + +### fn spec.withEnableFeatures + +```ts +withEnableFeatures(enableFeatures) +``` + +"Enable access to Alertmanager feature flags. By default, no features are enabled.\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\n\nIt requires Alertmanager >= 0.27.0." + +### fn spec.withEnableFeaturesMixin + +```ts +withEnableFeaturesMixin(enableFeatures) +``` + +"Enable access to Alertmanager feature flags. By default, no features are enabled.\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\n\nIt requires Alertmanager >= 0.27.0." + +**Note:** This function appends passed data to existing values + +### fn spec.withExternalUrl + +```ts +withExternalUrl(externalUrl) +``` + +"The external URL the Alertmanager instances will be available under. This is\nnecessary to generate correct URLs. This is necessary if Alertmanager is not\nserved from root of a DNS name." + +### fn spec.withForceEnableClusterMode + +```ts +withForceEnableClusterMode(forceEnableClusterMode) +``` + +"ForceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica.\nUse case is e.g. spanning an Alertmanager cluster across Kubernetes clusters with a single replica in each." + +### fn spec.withHostAliases + +```ts +withHostAliases(hostAliases) +``` + +"Pods' hostAliases configuration" + +### fn spec.withHostAliasesMixin + +```ts +withHostAliasesMixin(hostAliases) +``` + +"Pods' hostAliases configuration" + +**Note:** This function appends passed data to existing values + +### fn spec.withImage + +```ts +withImage(image) +``` + +"Image if specified has precedence over baseImage, tag and sha\ncombinations. Specifying the version is still necessary to ensure the\nPrometheus Operator knows what version of Alertmanager is being\nconfigured." + +### fn spec.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details." + +### fn spec.withImagePullSecrets + +```ts +withImagePullSecrets(imagePullSecrets) +``` + +"An optional list of references to secrets in the same namespace\nto use for pulling prometheus and alertmanager images from registries\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +### fn spec.withImagePullSecretsMixin + +```ts +withImagePullSecretsMixin(imagePullSecrets) +``` + +"An optional list of references to secrets in the same namespace\nto use for pulling prometheus and alertmanager images from registries\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +**Note:** This function appends passed data to existing values + +### fn spec.withInitContainers + +```ts +withInitContainers(initContainers) +``` + +"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the Alertmanager configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator\ngenerated init containers if they share the same name and modifications are\ndone via a strategic merge patch. The current init container name is:\n`init-config-reloader`. Overriding init containers is entirely outside the\nscope of what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice." + +### fn spec.withInitContainersMixin + +```ts +withInitContainersMixin(initContainers) +``` + +"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the Alertmanager configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator\ngenerated init containers if they share the same name and modifications are\ndone via a strategic merge patch. The current init container name is:\n`init-config-reloader`. Overriding init containers is entirely outside the\nscope of what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice." + +**Note:** This function appends passed data to existing values + +### fn spec.withListenLocal + +```ts +withListenLocal(listenLocal) +``` + +"ListenLocal makes the Alertmanager server listen on loopback, so that it\ndoes not bind against the Pod IP. Note this is only for the Alertmanager\nUI, not the gossip communication." + +### fn spec.withLogFormat + +```ts +withLogFormat(logFormat) +``` + +"Log format for Alertmanager to be configured with." + +### fn spec.withLogLevel + +```ts +withLogLevel(logLevel) +``` + +"Log level for Alertmanager to be configured with." + +### fn spec.withMinReadySeconds + +```ts +withMinReadySeconds(minReadySeconds) +``` + +"Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\nThis is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate." + +### fn spec.withNodeSelector + +```ts +withNodeSelector(nodeSelector) +``` + +"Define which Nodes the Pods are scheduled on." + +### fn spec.withNodeSelectorMixin + +```ts +withNodeSelectorMixin(nodeSelector) +``` + +"Define which Nodes the Pods are scheduled on." + +**Note:** This function appends passed data to existing values + +### fn spec.withPaused + +```ts +withPaused(paused) +``` + +"If set to true all actions on the underlying managed objects are not\ngoint to be performed, except for delete actions." + +### fn spec.withPortName + +```ts +withPortName(portName) +``` + +"Port name used for the pods and governing service.\nDefaults to `web`." + +### fn spec.withPriorityClassName + +```ts +withPriorityClassName(priorityClassName) +``` + +"Priority class assigned to the Pods" + +### fn spec.withReplicas + +```ts +withReplicas(replicas) +``` + +"Size is the expected size of the alertmanager cluster. The controller will\neventually make the size of the running cluster equal to the expected\nsize." + +### fn spec.withRetention + +```ts +withRetention(retention) +``` + +"Time duration Alertmanager shall retain data for. Default is '120h',\nand must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds seconds minutes hours)." + +### fn spec.withRoutePrefix + +```ts +withRoutePrefix(routePrefix) +``` + +"The route prefix Alertmanager registers HTTP handlers for. This is useful,\nif using ExternalURL and a proxy is rewriting HTTP routes of a request,\nand the actual ExternalURL is still true, but the server serves requests\nunder a different route prefix. For example for use with `kubectl proxy`." + +### fn spec.withSecrets + +```ts +withSecrets(secrets) +``` + +"Secrets is a list of Secrets in the same namespace as the Alertmanager\nobject, which shall be mounted into the Alertmanager Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into `/etc/alertmanager/secrets/` in the 'alertmanager' container." + +### fn spec.withSecretsMixin + +```ts +withSecretsMixin(secrets) +``` + +"Secrets is a list of Secrets in the same namespace as the Alertmanager\nobject, which shall be mounted into the Alertmanager Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into `/etc/alertmanager/secrets/` in the 'alertmanager' container." + +**Note:** This function appends passed data to existing values + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"ServiceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods." + +### fn spec.withSha + +```ts +withSha(sha) +``` + +"SHA of Alertmanager container image to be deployed. Defaults to the value of `version`.\nSimilar to a tag, but the SHA explicitly deploys an immutable container image.\nVersion and Tag are ignored if SHA is set.\nDeprecated: use 'image' instead. The image digest can be specified as part of the image URL." + +### fn spec.withTag + +```ts +withTag(tag) +``` + +"Tag of Alertmanager container image to be deployed. Defaults to the value of `version`.\nVersion is ignored if Tag is set.\nDeprecated: use 'image' instead. The image tag can be specified as part of the image URL." + +### fn spec.withTolerations + +```ts +withTolerations(tolerations) +``` + +"If specified, the pod's tolerations." + +### fn spec.withTolerationsMixin + +```ts +withTolerationsMixin(tolerations) +``` + +"If specified, the pod's tolerations." + +**Note:** This function appends passed data to existing values + +### fn spec.withTopologySpreadConstraints + +```ts +withTopologySpreadConstraints(topologySpreadConstraints) +``` + +"If specified, the pod's topology spread constraints." + +### fn spec.withTopologySpreadConstraintsMixin + +```ts +withTopologySpreadConstraintsMixin(topologySpreadConstraints) +``` + +"If specified, the pod's topology spread constraints." + +**Note:** This function appends passed data to existing values + +### fn spec.withVersion + +```ts +withVersion(version) +``` + +"Version the cluster should be on." + +### fn spec.withVolumeMounts + +```ts +withVolumeMounts(volumeMounts) +``` + +"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the alertmanager container,\nthat are generated as a result of StorageSpec objects." + +### fn spec.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the alertmanager container,\nthat are generated as a result of StorageSpec objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withVolumes + +```ts +withVolumes(volumes) +``` + +"Volumes allows configuration of additional volumes on the output StatefulSet definition.\nVolumes specified will be appended to other volumes that are generated as a result of\nStorageSpec objects." + +### fn spec.withVolumesMixin + +```ts +withVolumesMixin(volumes) +``` + +"Volumes allows configuration of additional volumes on the output StatefulSet definition.\nVolumes specified will be appended to other volumes that are generated as a result of\nStorageSpec objects." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(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\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +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 + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin + +```ts +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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms + +```ts +withNodeSelectorTerms(nodeSelectorTerms) +``` + +"Required. A list of node selector terms. The terms are ORed." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin + +```ts +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 + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin + +```ts +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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm 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\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm,\nin 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.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm 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\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm,\nin 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.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.alertmanagerConfigMatcherStrategy + +"AlertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects\nprocess incoming alerts." + +### fn spec.alertmanagerConfigMatcherStrategy.withType + +```ts +withType(type) +``` + +"AlertmanagerConfigMatcherStrategyType defines the strategy used by\nAlertmanagerConfig objects to match alerts in the routes and inhibition\nrules.\n\n\nThe default value is `OnNamespace`." + +## obj spec.alertmanagerConfigNamespaceSelector + +"Namespaces to be selected for AlertmanagerConfig discovery. If nil, only\ncheck own namespace." + +### fn spec.alertmanagerConfigNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.alertmanagerConfigNamespaceSelector.withMatchExpressionsMixin + +```ts +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.alertmanagerConfigNamespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.alertmanagerConfigNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.alertmanagerConfigNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.alertmanagerConfigNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.alertmanagerConfigNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.alertmanagerConfigNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.alertmanagerConfigNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.alertmanagerConfigSelector + +"AlertmanagerConfigs to be selected for to merge and configure Alertmanager with." + +### fn spec.alertmanagerConfigSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.alertmanagerConfigSelector.withMatchExpressionsMixin + +```ts +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.alertmanagerConfigSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.alertmanagerConfigSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.alertmanagerConfigSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.alertmanagerConfigSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.alertmanagerConfigSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.alertmanagerConfigSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.alertmanagerConfigSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.alertmanagerConfiguration + +"alertmanagerConfiguration specifies the configuration of Alertmanager.\n\n\nIf defined, it takes precedence over the `configSecret` field.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.alertmanagerConfiguration.withName + +```ts +withName(name) +``` + +"The name of the AlertmanagerConfig resource which is used to generate the Alertmanager configuration.\nIt must be defined in the same namespace as the Alertmanager object.\nThe operator will not enforce a `namespace` label for routes and inhibition rules." + +### fn spec.alertmanagerConfiguration.withTemplates + +```ts +withTemplates(templates) +``` + +"Custom notification templates." + +### fn spec.alertmanagerConfiguration.withTemplatesMixin + +```ts +withTemplatesMixin(templates) +``` + +"Custom notification templates." + +**Note:** This function appends passed data to existing values + +## obj spec.alertmanagerConfiguration.global + +"Defines the global parameters of the Alertmanager configuration." + +### fn spec.alertmanagerConfiguration.global.withPagerdutyUrl + +```ts +withPagerdutyUrl(pagerdutyUrl) +``` + +"The default Pagerduty URL." + +### fn spec.alertmanagerConfiguration.global.withResolveTimeout + +```ts +withResolveTimeout(resolveTimeout) +``` + +"ResolveTimeout is the default value used by alertmanager if the alert does\nnot include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated.\nThis has no impact on alerts from Prometheus, as they always include EndsAt." + +## obj spec.alertmanagerConfiguration.global.httpConfig + +"HTTP client configuration." + +### fn spec.alertmanagerConfiguration.global.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.alertmanagerConfiguration.global.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.alertmanagerConfiguration.global.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.alertmanagerConfiguration.global.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.alertmanagerConfiguration.global.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.alertmanagerConfiguration.global.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.alertmanagerConfiguration.global.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.alertmanagerConfiguration.global.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.alertmanagerConfiguration.global.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the Alertmanager\nobject and accessible by the Prometheus Operator." + +### fn spec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.opsGenieApiKey + +"The default OpsGenie API Key." + +### fn spec.alertmanagerConfiguration.global.opsGenieApiKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.opsGenieApiKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.opsGenieApiKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.opsGenieApiUrl + +"The default OpsGenie API URL." + +### fn spec.alertmanagerConfiguration.global.opsGenieApiUrl.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.opsGenieApiUrl.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.opsGenieApiUrl.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.slackApiUrl + +"The default Slack API URL." + +### fn spec.alertmanagerConfiguration.global.slackApiUrl.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.slackApiUrl.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.slackApiUrl.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.smtp + +"Configures global SMTP parameters." + +### fn spec.alertmanagerConfiguration.global.smtp.withAuthIdentity + +```ts +withAuthIdentity(authIdentity) +``` + +"SMTP Auth using PLAIN" + +### fn spec.alertmanagerConfiguration.global.smtp.withAuthUsername + +```ts +withAuthUsername(authUsername) +``` + +"SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server." + +### fn spec.alertmanagerConfiguration.global.smtp.withFrom + +```ts +withFrom(from) +``` + +"The default SMTP From header field." + +### fn spec.alertmanagerConfiguration.global.smtp.withHello + +```ts +withHello(hello) +``` + +"The default hostname to identify to the SMTP server." + +### fn spec.alertmanagerConfiguration.global.smtp.withRequireTLS + +```ts +withRequireTLS(requireTLS) +``` + +"The default SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints." + +## obj spec.alertmanagerConfiguration.global.smtp.authPassword + +"SMTP Auth using LOGIN and PLAIN." + +### fn spec.alertmanagerConfiguration.global.smtp.authPassword.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.smtp.authPassword.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.smtp.authPassword.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.smtp.authSecret + +"SMTP Auth using CRAM-MD5." + +### fn spec.alertmanagerConfiguration.global.smtp.authSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.global.smtp.authSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.global.smtp.authSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagerConfiguration.global.smtp.smartHost + +"The default SMTP smarthost used for sending emails." + +### fn spec.alertmanagerConfiguration.global.smtp.smartHost.withHost + +```ts +withHost(host) +``` + +"Defines the host's address, it can be a DNS name or a literal IP address." + +### fn spec.alertmanagerConfiguration.global.smtp.smartHost.withPort + +```ts +withPort(port) +``` + +"Defines the host's port, it can be a literal port number or a port name." + +## obj spec.alertmanagerConfiguration.templates + +"Custom notification templates." + +## obj spec.alertmanagerConfiguration.templates.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.templates.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.alertmanagerConfiguration.templates.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.templates.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.alertmanagerConfiguration.templates.secret + +"Secret containing data to use for the targets." + +### fn spec.alertmanagerConfiguration.templates.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagerConfiguration.templates.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagerConfiguration.templates.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.containers + +"Containers allows injecting additional containers. This is meant to\nallow adding an authentication proxy to an Alertmanager pod.\nContainers described here modify an operator generated container if they\nshare the same name and modifications are done via a strategic merge\npatch. The current container names are: `alertmanager` and\n`config-reloader`. Overriding containers is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice." + +### fn spec.containers.withArgs + +```ts +withArgs(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.containers.withArgsMixin + +```ts +withArgsMixin(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withCommand(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.containers.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.containers.withEnvFrom + +```ts +withEnvFrom(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.containers.withEnvFromMixin + +```ts +withEnvFromMixin(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withImage + +```ts +withImage(image) +``` + +"Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets." + +### fn spec.containers.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + +### fn spec.containers.withName + +```ts +withName(name) +``` + +"Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + +### fn spec.containers.withPorts + +```ts +withPorts(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.containers.withPortsMixin + +```ts +withPortsMixin(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withResizePolicy + +```ts +withResizePolicy(resizePolicy) +``` + +"Resources resize policy for the container." + +### fn spec.containers.withResizePolicyMixin + +```ts +withResizePolicyMixin(resizePolicy) +``` + +"Resources resize policy for the container." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted." + +### fn spec.containers.withStdin + +```ts +withStdin(stdin) +``` + +"Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false." + +### fn spec.containers.withStdinOnce + +```ts +withStdinOnce(stdinOnce) +``` + +"Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false" + +### fn spec.containers.withTerminationMessagePath + +```ts +withTerminationMessagePath(terminationMessagePath) +``` + +"Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated." + +### fn spec.containers.withTerminationMessagePolicy + +```ts +withTerminationMessagePolicy(terminationMessagePolicy) +``` + +"Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated." + +### fn spec.containers.withTty + +```ts +withTty(tty) +``` + +"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false." + +### fn spec.containers.withVolumeDevices + +```ts +withVolumeDevices(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.containers.withVolumeDevicesMixin + +```ts +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 + +```ts +withVolumeMounts(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +### fn spec.containers.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withWorkingDir + +```ts +withWorkingDir(workingDir) +``` + +"Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated." + +## obj spec.containers.env + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.containers.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.containers.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"." + +## obj spec.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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.containers.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.env.valueFrom.configMapKeyRef.withOptional + +```ts +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['']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.containers.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.containers.env.valueFrom.fieldRef.withFieldPath + +```ts +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\n(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 + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.containers.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.containers.env.valueFrom.resourceFieldRef.withResource + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.containers.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.env.valueFrom.secretKeyRef.withOptional + +```ts +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.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.containers.envFrom.withPrefix + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.envFrom.configMapRef.withOptional + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.envFrom.secretRef.withOptional + +```ts +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.\nCannot be updated." + +## obj spec.containers.lifecycle.postStart + +"PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.containers.lifecycle.postStart.exec + +"Exec specifies the action to take." + +### fn spec.containers.lifecycle.postStart.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.lifecycle.postStart.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.lifecycle.postStart.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.lifecycle.postStart.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.lifecycle.postStart.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.lifecycle.postStart.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.lifecycle.postStart.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.lifecycle.postStart.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.containers.lifecycle.postStart.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.containers.lifecycle.postStart.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.containers.lifecycle.postStart.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.lifecycle.postStart.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.lifecycle.preStop + +"PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.containers.lifecycle.preStop.exec + +"Exec specifies the action to take." + +### fn spec.containers.lifecycle.preStop.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.lifecycle.preStop.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.lifecycle.preStop.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.lifecycle.preStop.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.lifecycle.preStop.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.lifecycle.preStop.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.lifecycle.preStop.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.lifecycle.preStop.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.containers.lifecycle.preStop.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.containers.lifecycle.preStop.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.containers.lifecycle.preStop.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.lifecycle.preStop.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.livenessProbe + +"Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.livenessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.livenessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.livenessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.livenessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.livenessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.livenessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.livenessProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.livenessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.livenessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.livenessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.livenessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.livenessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.livenessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.livenessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.livenessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.livenessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.livenessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.livenessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.livenessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.livenessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.livenessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.ports + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.containers.ports.withContainerPort + +```ts +withContainerPort(containerPort) +``` + +"Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536." + +### fn spec.containers.ports.withHostIP + +```ts +withHostIP(hostIP) +``` + +"What host IP to bind the external port to." + +### fn spec.containers.ports.withHostPort + +```ts +withHostPort(hostPort) +``` + +"Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this." + +### fn spec.containers.ports.withName + +```ts +withName(name) +``` + +"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services." + +### fn spec.containers.ports.withProtocol + +```ts +withProtocol(protocol) +``` + +"Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\"." + +## obj spec.containers.readinessProbe + +"Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.readinessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.readinessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.readinessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.readinessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.readinessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.readinessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.readinessProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.readinessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.readinessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.readinessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.readinessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.readinessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.readinessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.readinessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.readinessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.readinessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.readinessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.readinessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.readinessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.readinessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.readinessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.resizePolicy + +"Resources resize policy for the container." + +### fn spec.containers.resizePolicy.withResourceName + +```ts +withResourceName(resourceName) +``` + +"Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + +### fn spec.containers.resizePolicy.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + +## obj spec.containers.resources + +"Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.containers.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.containers.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.containers.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.containers.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.containers.securityContext + +"SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.containers.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.containers.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +## obj spec.containers.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.containers.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.containers.securityContext.capabilities + +"The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.containers.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.containers.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.containers.securityContext.capabilities.withDropMixin + +```ts +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.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.containers.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.containers.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.containers.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.containers.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.containers.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.containers.startupProbe + +"StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.startupProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.startupProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.startupProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.startupProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.startupProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.startupProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.startupProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.startupProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.startupProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.startupProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.startupProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.startupProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.startupProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.startupProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.startupProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.startupProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.startupProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.startupProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.startupProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.startupProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.startupProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName 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 + +```ts +withDevicePath(devicePath) +``` + +"devicePath is the path inside of the container that the device will be mapped to." + +### fn spec.containers.volumeDevices.withName + +```ts +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.\nCannot be updated." + +### fn spec.containers.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.containers.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.containers.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.containers.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.containers.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.containers.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.containers.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.hostAliases + +"Pods' hostAliases configuration" + +### fn spec.hostAliases.withHostnames + +```ts +withHostnames(hostnames) +``` + +"Hostnames for the above IP address." + +### fn spec.hostAliases.withHostnamesMixin + +```ts +withHostnamesMixin(hostnames) +``` + +"Hostnames for the above IP address." + +**Note:** This function appends passed data to existing values + +### fn spec.hostAliases.withIp + +```ts +withIp(ip) +``` + +"IP address of the host file entry." + +## obj spec.imagePullSecrets + +"An optional list of references to secrets in the same namespace\nto use for pulling prometheus and alertmanager images from registries\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +### fn spec.imagePullSecrets.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.initContainers + +"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the Alertmanager configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator\ngenerated init containers if they share the same name and modifications are\ndone via a strategic merge patch. The current init container name is:\n`init-config-reloader`. Overriding init containers is entirely outside the\nscope of what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice." + +### fn spec.initContainers.withArgs + +```ts +withArgs(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.initContainers.withArgsMixin + +```ts +withArgsMixin(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withCommand(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.initContainers.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.initContainers.withEnvFrom + +```ts +withEnvFrom(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.initContainers.withEnvFromMixin + +```ts +withEnvFromMixin(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withImage + +```ts +withImage(image) +``` + +"Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets." + +### fn spec.initContainers.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + +### fn spec.initContainers.withName + +```ts +withName(name) +``` + +"Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + +### fn spec.initContainers.withPorts + +```ts +withPorts(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.initContainers.withPortsMixin + +```ts +withPortsMixin(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withResizePolicy + +```ts +withResizePolicy(resizePolicy) +``` + +"Resources resize policy for the container." + +### fn spec.initContainers.withResizePolicyMixin + +```ts +withResizePolicyMixin(resizePolicy) +``` + +"Resources resize policy for the container." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted." + +### fn spec.initContainers.withStdin + +```ts +withStdin(stdin) +``` + +"Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false." + +### fn spec.initContainers.withStdinOnce + +```ts +withStdinOnce(stdinOnce) +``` + +"Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false" + +### fn spec.initContainers.withTerminationMessagePath + +```ts +withTerminationMessagePath(terminationMessagePath) +``` + +"Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated." + +### fn spec.initContainers.withTerminationMessagePolicy + +```ts +withTerminationMessagePolicy(terminationMessagePolicy) +``` + +"Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated." + +### fn spec.initContainers.withTty + +```ts +withTty(tty) +``` + +"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false." + +### fn spec.initContainers.withVolumeDevices + +```ts +withVolumeDevices(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.initContainers.withVolumeDevicesMixin + +```ts +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 + +```ts +withVolumeMounts(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +### fn spec.initContainers.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withWorkingDir + +```ts +withWorkingDir(workingDir) +``` + +"Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated." + +## obj spec.initContainers.env + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.initContainers.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.initContainers.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"." + +## obj spec.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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.initContainers.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.env.valueFrom.configMapKeyRef.withOptional + +```ts +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['']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.initContainers.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.initContainers.env.valueFrom.fieldRef.withFieldPath + +```ts +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\n(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 + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.initContainers.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.initContainers.env.valueFrom.resourceFieldRef.withResource + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.initContainers.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.env.valueFrom.secretKeyRef.withOptional + +```ts +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.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.initContainers.envFrom.withPrefix + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.envFrom.configMapRef.withOptional + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.envFrom.secretRef.withOptional + +```ts +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.\nCannot be updated." + +## obj spec.initContainers.lifecycle.postStart + +"PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.initContainers.lifecycle.postStart.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.lifecycle.postStart.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.lifecycle.postStart.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.lifecycle.postStart.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.lifecycle.postStart.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.initContainers.lifecycle.postStart.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.initContainers.lifecycle.postStart.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.initContainers.lifecycle.postStart.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.lifecycle.postStart.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.lifecycle.preStop + +"PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.initContainers.lifecycle.preStop.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.lifecycle.preStop.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.lifecycle.preStop.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.lifecycle.preStop.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.lifecycle.preStop.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.initContainers.lifecycle.preStop.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.initContainers.lifecycle.preStop.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.initContainers.lifecycle.preStop.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.lifecycle.preStop.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.livenessProbe + +"Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.livenessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.livenessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.livenessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.livenessProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.livenessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.livenessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.livenessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.livenessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.livenessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.livenessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.livenessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.livenessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.livenessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.livenessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.livenessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.livenessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.livenessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.livenessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.ports + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.initContainers.ports.withContainerPort + +```ts +withContainerPort(containerPort) +``` + +"Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536." + +### fn spec.initContainers.ports.withHostIP + +```ts +withHostIP(hostIP) +``` + +"What host IP to bind the external port to." + +### fn spec.initContainers.ports.withHostPort + +```ts +withHostPort(hostPort) +``` + +"Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this." + +### fn spec.initContainers.ports.withName + +```ts +withName(name) +``` + +"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services." + +### fn spec.initContainers.ports.withProtocol + +```ts +withProtocol(protocol) +``` + +"Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\"." + +## obj spec.initContainers.readinessProbe + +"Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.readinessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.readinessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.readinessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.readinessProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.readinessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.readinessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.readinessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.readinessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.readinessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.readinessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.readinessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.readinessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.readinessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.readinessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.readinessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.readinessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.readinessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.readinessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.resizePolicy + +"Resources resize policy for the container." + +### fn spec.initContainers.resizePolicy.withResourceName + +```ts +withResourceName(resourceName) +``` + +"Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + +### fn spec.initContainers.resizePolicy.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + +## obj spec.initContainers.resources + +"Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.initContainers.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.initContainers.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.initContainers.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.initContainers.securityContext + +"SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.initContainers.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.initContainers.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +## obj spec.initContainers.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.initContainers.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.initContainers.securityContext.capabilities + +"The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.initContainers.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.initContainers.securityContext.capabilities.withDropMixin + +```ts +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.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.initContainers.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.initContainers.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.initContainers.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.initContainers.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.initContainers.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.initContainers.startupProbe + +"StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.startupProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.startupProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.startupProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.startupProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.startupProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.startupProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.startupProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.startupProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.startupProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.startupProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.startupProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.startupProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.startupProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.startupProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.startupProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.startupProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.startupProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.startupProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName 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 + +```ts +withDevicePath(devicePath) +``` + +"devicePath is the path inside of the container that the device will be mapped to." + +### fn spec.initContainers.volumeDevices.withName + +```ts +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.\nCannot be updated." + +### fn spec.initContainers.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.initContainers.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.initContainers.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.initContainers.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.initContainers.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.initContainers.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.initContainers.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.podMetadata + +"PodMetadata configures labels and annotations which are propagated to the Alertmanager pods.\n\n\nThe following items are reserved and cannot be overridden:\n* \"alertmanager\" label, set to the name of the Alertmanager instance.\n* \"app.kubernetes.io/instance\" label, set to the name of the Alertmanager instance.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"alertmanager\".\n* \"app.kubernetes.io/version\" label, set to the Alertmanager version.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"alertmanager\"." + +### fn spec.podMetadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +### fn spec.podMetadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn spec.podMetadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +### fn spec.podMetadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn spec.podMetadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + +## obj spec.resources + +"Define resources requests and limits for single Pods." + +### fn spec.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.securityContext + +"SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext." + +### fn spec.securityContext.withFsGroup + +```ts +withFsGroup(fsGroup) +``` + +"A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withFsGroupChangePolicy + +```ts +withFsGroupChangePolicy(fsGroupChangePolicy) +``` + +"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSupplementalGroups + +```ts +withSupplementalGroups(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSupplementalGroupsMixin + +```ts +withSupplementalGroupsMixin(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +### fn spec.securityContext.withSysctls + +```ts +withSysctls(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSysctlsMixin + +```ts +withSysctlsMixin(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +## obj spec.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.securityContext.seLinuxOptions + +"The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.securityContext.seccompProfile + +"The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.securityContext.sysctls + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.sysctls.withName + +```ts +withName(name) +``` + +"Name of a property to set" + +### fn spec.securityContext.sysctls.withValue + +```ts +withValue(value) +``` + +"Value of a property to set" + +## obj spec.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.storage + +"Storage is the definition of how storage will be used by the Alertmanager\ninstances." + +### fn spec.storage.withDisableMountSubPath + +```ts +withDisableMountSubPath(disableMountSubPath) +``` + +"Deprecated: subPath usage will be removed in a future release." + +## obj spec.storage.emptyDir + +"EmptyDirVolumeSource to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir" + +### fn spec.storage.emptyDir.withMedium + +```ts +withMedium(medium) +``` + +"medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.storage.emptyDir.withSizeLimit + +```ts +withSizeLimit(sizeLimit) +``` + +"sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +## obj spec.storage.ephemeral + +"EphemeralVolumeSource to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes" + +## obj spec.storage.ephemeral.volumeClaimTemplate + +"Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\n\nRequired, must not be nil." + +### fn spec.storage.ephemeral.volumeClaimTemplate.withMetadata + +```ts +withMetadata(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +### fn spec.storage.ephemeral.volumeClaimTemplate.withMetadataMixin + +```ts +withMetadataMixin(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec + +"The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate + +"Defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes." + +### fn spec.storage.volumeClaimTemplate.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources" + +### fn spec.storage.volumeClaimTemplate.withKind + +```ts +withKind(kind) +``` + +"Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + +## obj spec.storage.volumeClaimTemplate.metadata + +"EmbeddedMetadata contains metadata relevant to an EmbeddedResource." + +### fn spec.storage.volumeClaimTemplate.metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +### fn spec.storage.volumeClaimTemplate.metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +### fn spec.storage.volumeClaimTemplate.metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + +## obj spec.storage.volumeClaimTemplate.spec + +"Defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.storage.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.storage.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.storage.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.storage.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.storage.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.tolerations + +"If specified, the pod's tolerations." + +### fn spec.tolerations.withEffect + +```ts +withEffect(effect) +``` + +"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute." + +### fn spec.tolerations.withKey + +```ts +withKey(key) +``` + +"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys." + +### fn spec.tolerations.withOperator + +```ts +withOperator(operator) +``` + +"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category." + +### fn spec.tolerations.withTolerationSeconds + +```ts +withTolerationSeconds(tolerationSeconds) +``` + +"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system." + +### fn spec.tolerations.withValue + +```ts +withValue(value) +``` + +"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string." + +## obj spec.topologySpreadConstraints + +"If specified, the pod's topology spread constraints." + +### fn spec.topologySpreadConstraints.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default)." + +### fn spec.topologySpreadConstraints.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default)." + +**Note:** This function appends passed data to existing values + +### fn spec.topologySpreadConstraints.withMaxSkew + +```ts +withMaxSkew(maxSkew) +``` + +"MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n| zone1 | zone2 | zone3 |\n| P P | P P | P |\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed." + +### fn spec.topologySpreadConstraints.withMinDomains + +```ts +withMinDomains(minDomains) +``` + +"MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n| zone1 | zone2 | zone3 |\n| P P | P P | P P |\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew." + +### fn spec.topologySpreadConstraints.withNodeAffinityPolicy + +```ts +withNodeAffinityPolicy(nodeAffinityPolicy) +``` + +"NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\nwhen calculating pod topology spread skew. Options are:\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\n\nIf this value is nil, the behavior is equivalent to the Honor policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag." + +### fn spec.topologySpreadConstraints.withNodeTaintsPolicy + +```ts +withNodeTaintsPolicy(nodeTaintsPolicy) +``` + +"NodeTaintsPolicy indicates how we will treat node taints when calculating\npod topology spread skew. Options are:\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\nhas a toleration, are included.\n- Ignore: node taints are ignored. All nodes are included.\n\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag." + +### fn spec.topologySpreadConstraints.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field." + +### fn spec.topologySpreadConstraints.withWhenUnsatisfiable + +```ts +withWhenUnsatisfiable(whenUnsatisfiable) +``` + +"WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it.\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod\nif and only if every possible node assignment for that pod would violate\n\"MaxSkew\" on some topology.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n| zone1 | zone2 | zone3 |\n| P P P | P | P |\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field." + +## obj spec.topologySpreadConstraints.labelSelector + +"LabelSelector is used to find matching pods.\nPods that match this label selector are counted to determine the number of pods\nin their corresponding topology domain." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.topologySpreadConstraints.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.volumeMounts + +"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the alertmanager container,\nthat are generated as a result of StorageSpec objects." + +### fn spec.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.volumes + +"Volumes allows configuration of additional volumes on the output StatefulSet definition.\nVolumes specified will be appended to other volumes that are generated as a result of\nStorageSpec objects." + +### fn spec.volumes.withName + +```ts +withName(name) +``` + +"name of the volume.\nMust be a DNS_LABEL and unique within the pod.\nMore 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\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.volumes.awsElasticBlockStore.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.awsElasticBlockStore.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)." + +### fn spec.volumes.awsElasticBlockStore.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly value true will force the readOnly setting in VolumeMounts.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.volumes.awsElasticBlockStore.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore 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 + +```ts +withCachingMode(cachingMode) +``` + +"cachingMode is the Host Caching mode: None, Read Only, Read Write." + +### fn spec.volumes.azureDisk.withDiskName + +```ts +withDiskName(diskName) +``` + +"diskName is the Name of the data disk in the blob storage" + +### fn spec.volumes.azureDisk.withDiskURI + +```ts +withDiskURI(diskURI) +``` + +"diskURI is the URI of data disk in the blob storage" + +### fn spec.volumes.azureDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.azureDisk.withKind + +```ts +withKind(kind) +``` + +"kind expected values are 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 + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force\nthe 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 + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.azureFile.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of secret that contains Azure Storage Account Name and Key" + +### fn spec.volumes.azureFile.withShareName + +```ts +withShareName(shareName) +``` + +"shareName is the azure 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 + +```ts +withMonitors(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors\nMore 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 + +```ts +withPath(path) +``` + +"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /" + +### fn spec.volumes.cephfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withSecretFile + +```ts +withSecretFile(secretFile) +``` + +"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withUser + +```ts +withUser(user) +``` + +"user is optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +## obj spec.volumes.cephfs.secretRef + +"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.cinder + +"cinder represents a cinder volume attached and mounted on kubelets host machine.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +## obj spec.volumes.cinder.secretRef + +"secretRef is optional: points to a secret object containing parameters used to connect\nto OpenStack." + +### fn spec.volumes.cinder.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.configMap + +"configMap represents a configMap that should populate this volume" + +### fn spec.volumes.configMap.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.volumes.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.csi + +"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)." + +### fn spec.volumes.csi.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster." + +### fn spec.volumes.csi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply." + +### fn spec.volumes.csi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write)." + +### fn spec.volumes.csi.withVolumeAttributes + +```ts +withVolumeAttributes(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values." + +### fn spec.volumes.csi.withVolumeAttributesMixin + +```ts +withVolumeAttributesMixin(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. 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\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed." + +### fn spec.volumes.csi.nodePublishSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.downwardAPI + +"downwardAPI represents downward API about the pod that should populate this volume" + +### fn spec.volumes.downwardAPI.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of downward API volume file" + +### fn spec.volumes.downwardAPI.withItemsMixin + +```ts +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 + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.downwardAPI.items.withPath + +```ts +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, namespace and uid are supported." + +### fn spec.volumes.downwardAPI.items.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.volumes.downwardAPI.items.fieldRef.withFieldPath + +```ts +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\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.volumes.emptyDir + +"emptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.volumes.emptyDir.withMedium + +```ts +withMedium(medium) +``` + +"medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.volumes.emptyDir.withSizeLimit + +```ts +withSizeLimit(sizeLimit) +``` + +"sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +## obj spec.volumes.ephemeral + +"ephemeral represents a volume that is handled by a cluster storage driver.\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\nand deleted when the pod is removed.\n\n\nUse this if:\na) the volume is only needed while the pod runs,\nb) features of normal volumes like restoring from snapshot or capacity\n tracking are needed,\nc) the storage driver is specified through a storage class, and\nd) the storage driver supports dynamic volume provisioning through\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\n information on the connection between this volume type\n and PersistentVolumeClaim).\n\n\nUse PersistentVolumeClaim or one of the vendor-specific\nAPIs for volumes that persist for longer than the lifecycle\nof an individual pod.\n\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\nbe used that way - see the documentation of the driver for\nmore information.\n\n\nA pod can use both types of ephemeral volumes and\npersistent volumes at the same time." + +## obj spec.volumes.ephemeral.volumeClaimTemplate + +"Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\n\nRequired, must not be nil." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.withMetadata + +```ts +withMetadata(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.withMetadataMixin + +```ts +withMetadataMixin(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec + +"The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.fc.withLun + +```ts +withLun(lun) +``` + +"lun is Optional: FC target lun number" + +### fn spec.volumes.fc.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.fc.withTargetWWNs + +```ts +withTargetWWNs(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +### fn spec.volumes.fc.withTargetWWNsMixin + +```ts +withTargetWWNsMixin(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.fc.withWwids + +```ts +withWwids(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously." + +### fn spec.volumes.fc.withWwidsMixin + +```ts +withWwidsMixin(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids)\nEither 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\nprovisioned/attached using an exec based plugin." + +### fn spec.volumes.flexVolume.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the driver to use for this volume." + +### fn spec.volumes.flexVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script." + +### fn spec.volumes.flexVolume.withOptions + +```ts +withOptions(options) +``` + +"options is Optional: this field holds extra command options if any." + +### fn spec.volumes.flexVolume.withOptionsMixin + +```ts +withOptionsMixin(options) +``` + +"options is Optional: this field holds extra command options if any." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.flexVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +## obj spec.volumes.flexVolume.secretRef + +"secretRef is Optional: secretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts." + +### fn spec.volumes.flexVolume.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.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 + +```ts +withDatasetName(datasetName) +``` + +"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\nshould be considered as deprecated" + +### fn spec.volumes.flocker.withDatasetUUID + +```ts +withDatasetUUID(datasetUUID) +``` + +"datasetUUID is the 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\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.gcePersistentDisk.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withPdName + +```ts +withPdName(pdName) +``` + +"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +## obj spec.volumes.gitRepo + +"gitRepo represents a git repository at a particular revision.\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container." + +### fn spec.volumes.gitRepo.withDirectory + +```ts +withDirectory(directory) +``` + +"directory is the target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name." + +### fn spec.volumes.gitRepo.withRepository + +```ts +withRepository(repository) +``` + +"repository is the URL" + +### fn spec.volumes.gitRepo.withRevision + +```ts +withRevision(revision) +``` + +"revision is the commit hash for the specified revision." + +## obj spec.volumes.glusterfs + +"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md" + +### fn spec.volumes.glusterfs.withEndpoints + +```ts +withEndpoints(endpoints) +``` + +"endpoints is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.volumes.glusterfs.withPath + +```ts +withPath(path) +``` + +"path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.volumes.glusterfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore 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\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n---\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\nmount host directories as read/write." + +### fn spec.volumes.hostPath.withPath + +```ts +withPath(path) +``` + +"path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +### fn spec.volumes.hostPath.withType + +```ts +withType(type) +``` + +"type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +## obj spec.volumes.iscsi + +"iscsi represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://examples.k8s.io/volumes/iscsi/README.md" + +### fn spec.volumes.iscsi.withChapAuthDiscovery + +```ts +withChapAuthDiscovery(chapAuthDiscovery) +``` + +"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication" + +### fn spec.volumes.iscsi.withChapAuthSession + +```ts +withChapAuthSession(chapAuthSession) +``` + +"chapAuthSession defines whether support iSCSI Session CHAP authentication" + +### fn spec.volumes.iscsi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.iscsi.withInitiatorName + +```ts +withInitiatorName(initiatorName) +``` + +"initiatorName is the custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n: will be created for the connection." + +### fn spec.volumes.iscsi.withIqn + +```ts +withIqn(iqn) +``` + +"iqn is the target iSCSI Qualified Name." + +### fn spec.volumes.iscsi.withIscsiInterface + +```ts +withIscsiInterface(iscsiInterface) +``` + +"iscsiInterface is the interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp)." + +### fn spec.volumes.iscsi.withLun + +```ts +withLun(lun) +``` + +"lun represents iSCSI Target Lun number." + +### fn spec.volumes.iscsi.withPortals + +```ts +withPortals(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +### fn spec.volumes.iscsi.withPortalsMixin + +```ts +withPortalsMixin(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.iscsi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false." + +### fn spec.volumes.iscsi.withTargetPortal + +```ts +withTargetPortal(targetPortal) +``` + +"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +## obj spec.volumes.iscsi.secretRef + +"secretRef is the CHAP Secret for iSCSI target and initiator authentication" + +### fn spec.volumes.iscsi.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.nfs + +"nfs represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withPath + +```ts +withPath(path) +``` + +"path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withServer + +```ts +withServer(server) +``` + +"server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +## obj spec.volumes.persistentVolumeClaim + +"persistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.volumes.persistentVolumeClaim.withClaimName + +```ts +withClaimName(claimName) +``` + +"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.volumes.persistentVolumeClaim.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Will force the ReadOnly setting in VolumeMounts.\nDefault false." + +## obj spec.volumes.photonPersistentDisk + +"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine" + +### fn spec.volumes.photonPersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.photonPersistentDisk.withPdID + +```ts +withPdID(pdID) +``` + +"pdID is the 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 + +```ts +withFsType(fsType) +``` + +"fSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.portworxVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.portworxVolume.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID uniquely identifies a Portworx volume" + +## obj spec.volumes.projected + +"projected items for all in one resources secrets, configmaps, and downward API" + +### fn spec.volumes.projected.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode are the mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.withSources + +```ts +withSources(sources) +``` + +"sources is the list of volume projections" + +### fn spec.volumes.projected.withSourcesMixin + +```ts +withSourcesMixin(sources) +``` + +"sources is the list of volume projections" + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources + +"sources is the list of volume projections" + +## obj spec.volumes.projected.sources.clusterTrustBundle + +"ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\nof ClusterTrustBundle objects in an auto-updating file.\n\n\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\n\n\nClusterTrustBundle objects can either be selected by name, or by the\ncombination of signer name and a label selector.\n\n\nKubelet performs aggressive normalization of the PEM contents written\ninto the pod filesystem. Esoteric PEM features such as inter-block\ncomments and block headers are stripped. Certificates are deduplicated.\nThe ordering of certificates within the file is arbitrary, and Kubelet\nmay change the order over time." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withName + +```ts +withName(name) +``` + +"Select a single ClusterTrustBundle by object name. Mutually-exclusive\nwith signerName and labelSelector." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withOptional + +```ts +withOptional(optional) +``` + +"If true, don't block pod startup if the referenced ClusterTrustBundle(s)\naren't available. If using name, then the named ClusterTrustBundle is\nallowed not to exist. If using signerName, then the combination of\nsignerName and labelSelector is allowed to match zero\nClusterTrustBundles." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withPath + +```ts +withPath(path) +``` + +"Relative path from the volume root to write the bundle." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withSignerName + +```ts +withSignerName(signerName) +``` + +"Select all ClusterTrustBundles that match this signer name.\nMutually-exclusive with name. The contents of all selected\nClusterTrustBundles will be unified and deduplicated." + +## obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector + +"Select all ClusterTrustBundles that match this label selector. Only has\neffect if signerName is set. Mutually-exclusive with name. If unset,\ninterpreted as \"match nothing\". If set but empty, interpreted as \"match\neverything\"." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchExpressionsMixin + +```ts +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.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources.configMap + +"configMap information about the configMap data to project" + +### fn spec.volumes.projected.sources.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative 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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.projected.sources.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.volumes.projected.sources.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.projected.sources.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.projected.sources.downwardAPI + +"downwardAPI information about the downwardAPI data to project" + +### fn spec.volumes.projected.sources.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of DownwardAPIVolume file" + +### fn spec.volumes.projected.sources.downwardAPI.withItemsMixin + +```ts +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 + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.downwardAPI.items.withPath + +```ts +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, namespace and uid are supported." + +### fn spec.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion + +```ts +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 + +```ts +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\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.volumes.projected.sources.secret + +"secret information about the secret data to project" + +### fn spec.volumes.projected.sources.secret.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative 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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.projected.sources.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its key must be defined" + +## obj spec.volumes.projected.sources.secret.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.projected.sources.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.projected.sources.serviceAccountToken + +"serviceAccountToken is information about the serviceAccountToken data to project" + +### fn spec.volumes.projected.sources.serviceAccountToken.withAudience + +```ts +withAudience(audience) +``` + +"audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver." + +### fn spec.volumes.projected.sources.serviceAccountToken.withExpirationSeconds + +```ts +withExpirationSeconds(expirationSeconds) +``` + +"expirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes." + +### fn spec.volumes.projected.sources.serviceAccountToken.withPath + +```ts +withPath(path) +``` + +"path is the path relative to the mount point of the file to project the\ntoken into." + +## obj spec.volumes.quobyte + +"quobyte represents a Quobyte mount on the host that shares a pod's lifetime" + +### fn spec.volumes.quobyte.withGroup + +```ts +withGroup(group) +``` + +"group to map volume access to\nDefault is no group" + +### fn spec.volumes.quobyte.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false." + +### fn spec.volumes.quobyte.withRegistry + +```ts +withRegistry(registry) +``` + +"registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes" + +### fn spec.volumes.quobyte.withTenant + +```ts +withTenant(tenant) +``` + +"tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin" + +### fn spec.volumes.quobyte.withUser + +```ts +withUser(user) +``` + +"user to map volume access to\nDefaults to serivceaccount user" + +### fn spec.volumes.quobyte.withVolume + +```ts +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.\nMore info: https://examples.k8s.io/volumes/rbd/README.md" + +### fn spec.volumes.rbd.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.rbd.withImage + +```ts +withImage(image) +``` + +"image is the rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withKeyring + +```ts +withKeyring(keyring) +``` + +"keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withMonitors + +```ts +withMonitors(monitors) +``` + +"monitors is a collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is a collection of Ceph monitors.\nMore 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 + +```ts +withPool(pool) +``` + +"pool is the rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withUser + +```ts +withUser(user) +``` + +"user is the rados user name.\nDefault is admin.\nMore 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\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.scaleIO + +"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes." + +### fn spec.volumes.scaleIO.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\"." + +### fn spec.volumes.scaleIO.withGateway + +```ts +withGateway(gateway) +``` + +"gateway is the host address of the ScaleIO API Gateway." + +### fn spec.volumes.scaleIO.withProtectionDomain + +```ts +withProtectionDomain(protectionDomain) +``` + +"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage." + +### fn spec.volumes.scaleIO.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.scaleIO.withSslEnabled + +```ts +withSslEnabled(sslEnabled) +``` + +"sslEnabled Flag enable/disable SSL communication with Gateway, default false" + +### fn spec.volumes.scaleIO.withStorageMode + +```ts +withStorageMode(storageMode) +``` + +"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned." + +### fn spec.volumes.scaleIO.withStoragePool + +```ts +withStoragePool(storagePool) +``` + +"storagePool is the ScaleIO Storage Pool associated with the protection domain." + +### fn spec.volumes.scaleIO.withSystem + +```ts +withSystem(system) +``` + +"system is the name of the storage system as configured in ScaleIO." + +### fn spec.volumes.scaleIO.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the name of a volume already created in the ScaleIO system\nthat is associated with this volume source." + +## obj spec.volumes.scaleIO.secretRef + +"secretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail." + +### fn spec.volumes.scaleIO.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.secret + +"secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +### fn spec.volumes.secret.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.secret.withItems + +```ts +withItems(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its keys must be defined" + +### fn spec.volumes.secret.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +## obj spec.volumes.secret.items + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay 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 + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.storageos.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.storageos.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace." + +### fn spec.volumes.storageos.withVolumeNamespace + +```ts +withVolumeNamespace(volumeNamespace) +``` + +"volumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces 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\ncredentials. If not specified, default values will be attempted." + +### fn spec.volumes.storageos.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.vsphereVolume + +"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine" + +### fn spec.volumes.vsphereVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.vsphereVolume.withStoragePolicyID + +```ts +withStoragePolicyID(storagePolicyID) +``` + +"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName." + +### fn spec.volumes.vsphereVolume.withStoragePolicyName + +```ts +withStoragePolicyName(storagePolicyName) +``` + +"storagePolicyName is the storage Policy Based Management (SPBM) profile name." + +### fn spec.volumes.vsphereVolume.withVolumePath + +```ts +withVolumePath(volumePath) +``` + +"volumePath is the path that identifies vSphere volume vmdk" + +## obj spec.web + +"Defines the web command line flags when starting Alertmanager." + +### fn spec.web.withGetConcurrency + +```ts +withGetConcurrency(getConcurrency) +``` + +"Maximum number of GET requests processed concurrently. This corresponds to the\nAlertmanager's `--web.get-concurrency` flag." + +### fn spec.web.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout for HTTP requests. This corresponds to the Alertmanager's\n`--web.timeout` flag." + +## obj spec.web.httpConfig + +"Defines HTTP parameters for web server." + +### fn spec.web.httpConfig.withHttp2 + +```ts +withHttp2(http2) +``` + +"Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered." + +## obj spec.web.httpConfig.headers + +"List of headers that can be added to HTTP responses." + +### fn spec.web.httpConfig.headers.withContentSecurityPolicy + +```ts +withContentSecurityPolicy(contentSecurityPolicy) +``` + +"Set the Content-Security-Policy header to HTTP responses.\nUnset if blank." + +### fn spec.web.httpConfig.headers.withStrictTransportSecurity + +```ts +withStrictTransportSecurity(strictTransportSecurity) +``` + +"Set the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security" + +### fn spec.web.httpConfig.headers.withXContentTypeOptions + +```ts +withXContentTypeOptions(xContentTypeOptions) +``` + +"Set the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options" + +### fn spec.web.httpConfig.headers.withXFrameOptions + +```ts +withXFrameOptions(xFrameOptions) +``` + +"Set the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options" + +### fn spec.web.httpConfig.headers.withXXSSProtection + +```ts +withXXSSProtection(xXSSProtection) +``` + +"Set the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection" + +## obj spec.web.tlsConfig + +"Defines the TLS parameters for HTTPS." + +### fn spec.web.tlsConfig.withCipherSuites + +```ts +withCipherSuites(cipherSuites) +``` + +"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\nGo default cipher suites are used. Available cipher suites are documented\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants" + +### fn spec.web.tlsConfig.withCipherSuitesMixin + +```ts +withCipherSuitesMixin(cipherSuites) +``` + +"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\nGo default cipher suites are used. Available cipher suites are documented\nin 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 + +```ts +withClientAuthType(clientAuthType) +``` + +"Server policy for client authentication. Maps to ClientAuth Policies.\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType" + +### fn spec.web.tlsConfig.withCurvePreferences + +```ts +withCurvePreferences(curvePreferences) +``` + +"Elliptic curves that will be used in an ECDHE handshake, in preference\norder. Available curves are documented in the go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID" + +### fn spec.web.tlsConfig.withCurvePreferencesMixin + +```ts +withCurvePreferencesMixin(curvePreferences) +``` + +"Elliptic curves that will be used in an ECDHE handshake, in preference\norder. Available curves are documented in the go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID" + +**Note:** This function appends passed data to existing values + +### fn spec.web.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum TLS version that is acceptable. Defaults to TLS13." + +### fn spec.web.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum TLS version that is acceptable. Defaults to TLS12." + +### fn spec.web.tlsConfig.withPreferServerCipherSuites + +```ts +withPreferServerCipherSuites(preferServerCipherSuites) +``` + +"Controls whether the server selects the\nclient's most preferred cipher suite, or the server's most preferred\ncipher suite. If true then the server's preference, as expressed in\nthe 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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.web.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.web.tlsConfig.client_ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.client_ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.client_ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.client_ca.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/endpoint.md b/docs/0.14/monitoring/v1/endpoint.md new file mode 100644 index 0000000..212e93c --- /dev/null +++ b/docs/0.14/monitoring/v1/endpoint.md @@ -0,0 +1,629 @@ +--- +permalink: /0.14/monitoring/v1/endpoint/ +--- + +# monitoring.v1.endpoint + +Endpoint is a helper to create endpoint configurations in ServiceMonitors. An endpoint defines a scrapeable endpoint serving Prometheus metrics. + +## Index + +* [`fn withBearerTokenFile(path)`](#fn-withbearertokenfile) +* [`fn withHonorLabels(honor_labels)`](#fn-withhonorlabels) +* [`fn withHonorTimestamps(honor_timestamps)`](#fn-withhonortimestamps) +* [`fn withInterval(interval)`](#fn-withinterval) +* [`fn withMetricRelabelings(relabelings)`](#fn-withmetricrelabelings) +* [`fn withParams(params)`](#fn-withparams) +* [`fn withPath(path)`](#fn-withpath) +* [`fn withPort(port)`](#fn-withport) +* [`fn withProxyUrl(url)`](#fn-withproxyurl) +* [`fn withRelabelings(relabelings)`](#fn-withrelabelings) +* [`fn withScheme(scheme)`](#fn-withscheme) +* [`fn withScrapeTimeout(timeout)`](#fn-withscrapetimeout) +* [`fn withTargetPort(port)`](#fn-withtargetport) +* [`obj authorization`](#obj-authorization) + * [`fn withType(type)`](#fn-authorizationwithtype) + * [`obj authorization.credentials`](#obj-authorizationcredentials) + * [`fn withKey(key)`](#fn-authorizationcredentialswithkey) + * [`fn withName(name)`](#fn-authorizationcredentialswithname) + * [`fn withOptional(is_optional)`](#fn-authorizationcredentialswithoptional) +* [`obj basicAuth`](#obj-basicauth) + * [`obj basicAuth.password`](#obj-basicauthpassword) + * [`fn withKey(key)`](#fn-basicauthpasswordwithkey) + * [`fn withName(name)`](#fn-basicauthpasswordwithname) + * [`fn withOptional(is_optional)`](#fn-basicauthpasswordwithoptional) + * [`obj basicAuth.username`](#obj-basicauthusername) + * [`fn withKey(key)`](#fn-basicauthusernamewithkey) + * [`fn withName(name)`](#fn-basicauthusernamewithname) + * [`fn withOptional(is_optional)`](#fn-basicauthusernamewithoptional) +* [`obj bearerTokenSecret`](#obj-bearertokensecret) + * [`fn withKey(key)`](#fn-bearertokensecretwithkey) + * [`fn withName(name)`](#fn-bearertokensecretwithname) + * [`fn withOptional(is_optional)`](#fn-bearertokensecretwithoptional) +* [`obj oauth2`](#obj-oauth2) + * [`fn withEndpointParams(params)`](#fn-oauth2withendpointparams) + * [`fn withScopes(scopes)`](#fn-oauth2withscopes) + * [`fn withTokenUrl(url)`](#fn-oauth2withtokenurl) + * [`obj oauth2.clientId`](#obj-oauth2clientid) + * [`obj oauth2.clientId.configMap`](#obj-oauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-oauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-oauth2clientidconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientidconfigmapwithoptional) + * [`obj oauth2.clientId.secret`](#obj-oauth2clientidsecret) + * [`fn withKey(key)`](#fn-oauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-oauth2clientidsecretwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientidsecretwithoptional) + * [`obj oauth2.clientSecret`](#obj-oauth2clientsecret) + * [`fn withKey(key)`](#fn-oauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-oauth2clientsecretwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientsecretwithoptional) +* [`obj tlsConfig`](#obj-tlsconfig) + * [`fn withCaFile(path)`](#fn-tlsconfigwithcafile) + * [`fn withCertFile(path)`](#fn-tlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(skip_verify)`](#fn-tlsconfigwithinsecureskipverify) + * [`fn withKeyFile(path)`](#fn-tlsconfigwithkeyfile) + * [`fn withServerName(name)`](#fn-tlsconfigwithservername) + * [`obj tlsConfig.ca`](#obj-tlsconfigca) + * [`obj tlsConfig.ca.configMap`](#obj-tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-tlsconfigcaconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcaconfigmapwithoptional) + * [`obj tlsConfig.ca.secret`](#obj-tlsconfigcasecret) + * [`fn withKey(key)`](#fn-tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigcasecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcasecretwithoptional) + * [`obj tlsConfig.cert`](#obj-tlsconfigcert) + * [`obj tlsConfig.cert.configMap`](#obj-tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-tlsconfigcertconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcertconfigmapwithoptional) + * [`obj tlsConfig.cert.secret`](#obj-tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigcertsecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcertsecretwithoptional) + * [`obj tlsConfig.keySecret`](#obj-tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigkeysecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigkeysecretwithoptional) + +## Fields + +### fn withBearerTokenFile + +```ts +withBearerTokenFile(path) +``` + +File to read bearer token for scraping targets. + +### fn withHonorLabels + +```ts +withHonorLabels(honor_labels) +``` + +HonorLabels chooses the metric’s labels on collisions with target labels. + +### fn withHonorTimestamps + +```ts +withHonorTimestamps(honor_timestamps) +``` + +HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. + +### fn withInterval + +```ts +withInterval(interval) +``` + +Interval at which metrics should be scraped. + +### fn withMetricRelabelings + +```ts +withMetricRelabelings(relabelings) +``` + +MetricRelabelConfigs to apply to samples before ingestion. + +### fn withParams + +```ts +withParams(params) +``` + +Optional HTTP URL parameters. + +### fn withPath + +```ts +withPath(path) +``` + +HTTP path to scrape for metrics. + +### fn withPort + +```ts +withPort(port) +``` + +Name of the service port this endpoint refers to. Mutually exclusive with withTargetPort. + +### fn withProxyUrl + +```ts +withProxyUrl(url) +``` + +ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. + +### fn withRelabelings + +```ts +withRelabelings(relabelings) +``` + +RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config + +### fn withScheme + +```ts +withScheme(scheme) +``` + +HTTP scheme to use for scraping. + +### fn withScrapeTimeout + +```ts +withScrapeTimeout(timeout) +``` + +Timeout after which the scrape is ended. + +### fn withTargetPort + +```ts +withTargetPort(port) +``` + +Name or number of the target port of the Pod behind the Service, the port must be specified with container port property. Mutually exclusive with withPort. + +## obj authorization + +Authorization section for this endpoint + +### fn authorization.withType + +```ts +withType(type) +``` + +Set the authentication type. Defaults to Bearer, Basic will cause an error + +## obj authorization.credentials + +The secret's key that contains the credentials of the request + +### fn authorization.credentials.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn authorization.credentials.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn authorization.credentials.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj basicAuth + +BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints + +## obj basicAuth.password + +The secret in the service monitor namespace that contains the password for authentication. + +### fn basicAuth.password.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn basicAuth.password.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn basicAuth.password.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj basicAuth.username + +The secret in the service monitor namespace that contains the username for authentication. + +### fn basicAuth.username.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn basicAuth.username.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn basicAuth.username.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj bearerTokenSecret + +Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator. + +### fn bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn bearerTokenSecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn bearerTokenSecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj oauth2 + +OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + +### fn oauth2.withEndpointParams + +```ts +withEndpointParams(params) +``` + +Parameters to append to the token URL + +### fn oauth2.withScopes + +```ts +withScopes(scopes) +``` + +OAuth2 scopes used for the token request. + +### fn oauth2.withTokenUrl + +```ts +withTokenUrl(url) +``` + +The URL to fetch the token from. + +## obj oauth2.clientId + +The secret or configmap containing the OAuth2 client id. + +## obj oauth2.clientId.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientId.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj oauth2.clientId.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientId.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj oauth2.clientSecret + +The secret containing the OAuth2 client secret. + +### fn oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn oauth2.clientSecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientSecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig + +TLS configuration to use when scraping the endpoint + +### fn tlsConfig.withCaFile + +```ts +withCaFile(path) +``` + +Path to the CA cert in the Prometheus container to use for the targets. + +### fn tlsConfig.withCertFile + +```ts +withCertFile(path) +``` + +Path to the client cert file in the Prometheus container for the targets. + +### fn tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(skip_verify) +``` + +Disable target certificate validation. + +### fn tlsConfig.withKeyFile + +```ts +withKeyFile(path) +``` + +Path to the client key file in the Prometheus container for the targets. + +### fn tlsConfig.withServerName + +```ts +withServerName(name) +``` + +Used to verify the hostname for the targets. + +## obj tlsConfig.ca + +Struct containing the CA cert to use for the targets. + +## obj tlsConfig.ca.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.ca.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj tlsConfig.ca.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.ca.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig.cert + +Struct containing the client cert file for the targets. + +## obj tlsConfig.cert.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.cert.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj tlsConfig.cert.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.cert.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig.keySecret + +Secret containing the client key file for the targets. + +### fn tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.keySecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/index.md b/docs/0.14/monitoring/v1/index.md new file mode 100644 index 0000000..7f7361f --- /dev/null +++ b/docs/0.14/monitoring/v1/index.md @@ -0,0 +1,18 @@ +--- +permalink: /0.14/monitoring/v1/ +--- + +# monitoring.v1 + + + +* [alertmanager](alertmanager.md) +* [endpoint](endpoint.md) +* [podMetricsEndpoint](podMetricsEndpoint.md) +* [podMonitor](podMonitor.md) +* [probe](probe.md) +* [prometheus](prometheus.md) +* [prometheusRule](prometheusRule.md) +* [relabelConfig](relabelConfig.md) +* [serviceMonitor](serviceMonitor.md) +* [thanosRuler](thanosRuler.md) \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/podMetricsEndpoint.md b/docs/0.14/monitoring/v1/podMetricsEndpoint.md new file mode 100644 index 0000000..efc142e --- /dev/null +++ b/docs/0.14/monitoring/v1/podMetricsEndpoint.md @@ -0,0 +1,602 @@ +--- +permalink: /0.14/monitoring/v1/podMetricsEndpoint/ +--- + +# monitoring.v1.podMetricsEndpoint + +PodMetricsEndpoint defines a scrapeable endpoint of a Kubernetes Pod serving Prometheus metrics. + +## Index + +* [`fn withBearerTokenFile(path)`](#fn-withbearertokenfile) +* [`fn withHonorLabels(honor_labels)`](#fn-withhonorlabels) +* [`fn withHonorTimestamps(honor_timestamps)`](#fn-withhonortimestamps) +* [`fn withInterval(interval)`](#fn-withinterval) +* [`fn withMetricRelabelings(relabelings)`](#fn-withmetricrelabelings) +* [`fn withParams(params)`](#fn-withparams) +* [`fn withPath(path)`](#fn-withpath) +* [`fn withPort(port)`](#fn-withport) +* [`fn withProxyUrl(url)`](#fn-withproxyurl) +* [`fn withRelabelings(relabelings)`](#fn-withrelabelings) +* [`fn withScheme(scheme)`](#fn-withscheme) +* [`fn withScrapeTimeout(timeout)`](#fn-withscrapetimeout) +* [`fn withTargetPort(port)`](#fn-withtargetport) +* [`obj authorization`](#obj-authorization) + * [`fn withType(type)`](#fn-authorizationwithtype) + * [`obj authorization.credentials`](#obj-authorizationcredentials) + * [`fn withKey(key)`](#fn-authorizationcredentialswithkey) + * [`fn withName(name)`](#fn-authorizationcredentialswithname) + * [`fn withOptional(is_optional)`](#fn-authorizationcredentialswithoptional) +* [`obj basicAuth`](#obj-basicauth) + * [`obj basicAuth.password`](#obj-basicauthpassword) + * [`fn withKey(key)`](#fn-basicauthpasswordwithkey) + * [`fn withName(name)`](#fn-basicauthpasswordwithname) + * [`fn withOptional(is_optional)`](#fn-basicauthpasswordwithoptional) + * [`obj basicAuth.username`](#obj-basicauthusername) + * [`fn withKey(key)`](#fn-basicauthusernamewithkey) + * [`fn withName(name)`](#fn-basicauthusernamewithname) + * [`fn withOptional(is_optional)`](#fn-basicauthusernamewithoptional) +* [`obj bearerTokenSecret`](#obj-bearertokensecret) + * [`fn withKey(key)`](#fn-bearertokensecretwithkey) + * [`fn withName(name)`](#fn-bearertokensecretwithname) + * [`fn withOptional(is_optional)`](#fn-bearertokensecretwithoptional) +* [`obj oauth2`](#obj-oauth2) + * [`fn withEndpointParams(params)`](#fn-oauth2withendpointparams) + * [`fn withScopes(scopes)`](#fn-oauth2withscopes) + * [`fn withTokenUrl(url)`](#fn-oauth2withtokenurl) + * [`obj oauth2.clientId`](#obj-oauth2clientid) + * [`obj oauth2.clientId.configMap`](#obj-oauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-oauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-oauth2clientidconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientidconfigmapwithoptional) + * [`obj oauth2.clientId.secret`](#obj-oauth2clientidsecret) + * [`fn withKey(key)`](#fn-oauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-oauth2clientidsecretwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientidsecretwithoptional) + * [`obj oauth2.clientSecret`](#obj-oauth2clientsecret) + * [`fn withKey(key)`](#fn-oauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-oauth2clientsecretwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientsecretwithoptional) +* [`obj tlsConfig`](#obj-tlsconfig) + * [`fn withInsecureSkipVerify(skip_verify)`](#fn-tlsconfigwithinsecureskipverify) + * [`fn withServerName(name)`](#fn-tlsconfigwithservername) + * [`obj tlsConfig.ca`](#obj-tlsconfigca) + * [`obj tlsConfig.ca.configMap`](#obj-tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-tlsconfigcaconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcaconfigmapwithoptional) + * [`obj tlsConfig.ca.secret`](#obj-tlsconfigcasecret) + * [`fn withKey(key)`](#fn-tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigcasecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcasecretwithoptional) + * [`obj tlsConfig.cert`](#obj-tlsconfigcert) + * [`obj tlsConfig.cert.configMap`](#obj-tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-tlsconfigcertconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcertconfigmapwithoptional) + * [`obj tlsConfig.cert.secret`](#obj-tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigcertsecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcertsecretwithoptional) + * [`obj tlsConfig.keySecret`](#obj-tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigkeysecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigkeysecretwithoptional) + +## Fields + +### fn withBearerTokenFile + +```ts +withBearerTokenFile(path) +``` + +File to read bearer token for scraping targets. + +### fn withHonorLabels + +```ts +withHonorLabels(honor_labels) +``` + +HonorLabels chooses the metric’s labels on collisions with target labels. + +### fn withHonorTimestamps + +```ts +withHonorTimestamps(honor_timestamps) +``` + +HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. + +### fn withInterval + +```ts +withInterval(interval) +``` + +Interval at which metrics should be scraped. + +### fn withMetricRelabelings + +```ts +withMetricRelabelings(relabelings) +``` + +MetricRelabelConfigs to apply to samples before ingestion. + +### fn withParams + +```ts +withParams(params) +``` + +Optional HTTP URL parameters. + +### fn withPath + +```ts +withPath(path) +``` + +HTTP path to scrape for metrics. + +### fn withPort + +```ts +withPort(port) +``` + +Name of the pod port this endpoint refers to. Mutually exclusive with targetPort. + +### fn withProxyUrl + +```ts +withProxyUrl(url) +``` + +ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. + +### fn withRelabelings + +```ts +withRelabelings(relabelings) +``` + +RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config + +### fn withScheme + +```ts +withScheme(scheme) +``` + +HTTP scheme to use for scraping. + +### fn withScrapeTimeout + +```ts +withScrapeTimeout(timeout) +``` + +Timeout after which the scrape is ended. + +### fn withTargetPort + +```ts +withTargetPort(port) +``` + +Deprecated: Use ‘port’ instead. + +## obj authorization + +Authorization section for this endpoint + +### fn authorization.withType + +```ts +withType(type) +``` + +Set the authentication type. Defaults to Bearer, Basic will cause an error + +## obj authorization.credentials + +The secret's key that contains the credentials of the request + +### fn authorization.credentials.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn authorization.credentials.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn authorization.credentials.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj basicAuth + +BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints + +## obj basicAuth.password + +The secret in the service monitor namespace that contains the password for authentication. + +### fn basicAuth.password.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn basicAuth.password.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn basicAuth.password.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj basicAuth.username + +The secret in the service monitor namespace that contains the username for authentication. + +### fn basicAuth.username.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn basicAuth.username.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn basicAuth.username.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj bearerTokenSecret + +Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator. + +### fn bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn bearerTokenSecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn bearerTokenSecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj oauth2 + +OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + +### fn oauth2.withEndpointParams + +```ts +withEndpointParams(params) +``` + +Parameters to append to the token URL + +### fn oauth2.withScopes + +```ts +withScopes(scopes) +``` + +OAuth2 scopes used for the token request. + +### fn oauth2.withTokenUrl + +```ts +withTokenUrl(url) +``` + +The URL to fetch the token from. + +## obj oauth2.clientId + +The secret or configmap containing the OAuth2 client id. + +## obj oauth2.clientId.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientId.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj oauth2.clientId.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientId.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj oauth2.clientSecret + +The secret containing the OAuth2 client secret. + +### fn oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn oauth2.clientSecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientSecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig + +TLS configuration to use when scraping the endpoint + +### fn tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(skip_verify) +``` + +Disable target certificate validation. + +### fn tlsConfig.withServerName + +```ts +withServerName(name) +``` + +Used to verify the hostname for the targets. + +## obj tlsConfig.ca + +Struct containing the CA cert to use for the targets. + +## obj tlsConfig.ca.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.ca.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj tlsConfig.ca.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.ca.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig.cert + +Struct containing the client cert file for the targets. + +## obj tlsConfig.cert.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.cert.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj tlsConfig.cert.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.cert.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig.keySecret + +Secret containing the client key file for the targets. + +### fn tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.keySecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/podMonitor.md b/docs/0.14/monitoring/v1/podMonitor.md new file mode 100644 index 0000000..ec82d5b --- /dev/null +++ b/docs/0.14/monitoring/v1/podMonitor.md @@ -0,0 +1,1598 @@ +--- +permalink: /0.14/monitoring/v1/podMonitor/ +--- + +# monitoring.v1.podMonitor + +"The `PodMonitor` custom resource definition (CRD) defines how `Prometheus` and `PrometheusAgent` can scrape metrics from a group of pods.\nAmong other things, it allows to specify:\n* The pods to scrape via label selectors.\n* The container ports to scrape.\n* Authentication credentials to use.\n* Target and metric relabeling.\n\n\n`Prometheus` and `PrometheusAgent` objects select `PodMonitor` objects using label and namespace selectors." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withBodySizeLimit(bodySizeLimit)`](#fn-specwithbodysizelimit) + * [`fn withJobLabel(jobLabel)`](#fn-specwithjoblabel) + * [`fn withKeepDroppedTargets(keepDroppedTargets)`](#fn-specwithkeepdroppedtargets) + * [`fn withLabelLimit(labelLimit)`](#fn-specwithlabellimit) + * [`fn withLabelNameLengthLimit(labelNameLengthLimit)`](#fn-specwithlabelnamelengthlimit) + * [`fn withLabelValueLengthLimit(labelValueLengthLimit)`](#fn-specwithlabelvaluelengthlimit) + * [`fn withPodMetricsEndpoints(podMetricsEndpoints)`](#fn-specwithpodmetricsendpoints) + * [`fn withPodMetricsEndpointsMixin(podMetricsEndpoints)`](#fn-specwithpodmetricsendpointsmixin) + * [`fn withPodTargetLabels(podTargetLabels)`](#fn-specwithpodtargetlabels) + * [`fn withPodTargetLabelsMixin(podTargetLabels)`](#fn-specwithpodtargetlabelsmixin) + * [`fn withSampleLimit(sampleLimit)`](#fn-specwithsamplelimit) + * [`fn withScrapeClass(scrapeClass)`](#fn-specwithscrapeclass) + * [`fn withScrapeProtocols(scrapeProtocols)`](#fn-specwithscrapeprotocols) + * [`fn withScrapeProtocolsMixin(scrapeProtocols)`](#fn-specwithscrapeprotocolsmixin) + * [`fn withTargetLimit(targetLimit)`](#fn-specwithtargetlimit) + * [`obj spec.attachMetadata`](#obj-specattachmetadata) + * [`fn withNode(node)`](#fn-specattachmetadatawithnode) + * [`obj spec.namespaceSelector`](#obj-specnamespaceselector) + * [`fn withAny(any)`](#fn-specnamespaceselectorwithany) + * [`fn withMatchNames(matchNames)`](#fn-specnamespaceselectorwithmatchnames) + * [`fn withMatchNamesMixin(matchNames)`](#fn-specnamespaceselectorwithmatchnamesmixin) + * [`obj spec.podMetricsEndpoints`](#obj-specpodmetricsendpoints) + * [`fn withEnableHttp2(enableHttp2)`](#fn-specpodmetricsendpointswithenablehttp2) + * [`fn withFilterRunning(filterRunning)`](#fn-specpodmetricsendpointswithfilterrunning) + * [`fn withFollowRedirects(followRedirects)`](#fn-specpodmetricsendpointswithfollowredirects) + * [`fn withHonorLabels(honorLabels)`](#fn-specpodmetricsendpointswithhonorlabels) + * [`fn withHonorTimestamps(honorTimestamps)`](#fn-specpodmetricsendpointswithhonortimestamps) + * [`fn withInterval(interval)`](#fn-specpodmetricsendpointswithinterval) + * [`fn withMetricRelabelings(metricRelabelings)`](#fn-specpodmetricsendpointswithmetricrelabelings) + * [`fn withMetricRelabelingsMixin(metricRelabelings)`](#fn-specpodmetricsendpointswithmetricrelabelingsmixin) + * [`fn withParams(params)`](#fn-specpodmetricsendpointswithparams) + * [`fn withParamsMixin(params)`](#fn-specpodmetricsendpointswithparamsmixin) + * [`fn withPath(path)`](#fn-specpodmetricsendpointswithpath) + * [`fn withPort(port)`](#fn-specpodmetricsendpointswithport) + * [`fn withProxyUrl(proxyUrl)`](#fn-specpodmetricsendpointswithproxyurl) + * [`fn withRelabelings(relabelings)`](#fn-specpodmetricsendpointswithrelabelings) + * [`fn withRelabelingsMixin(relabelings)`](#fn-specpodmetricsendpointswithrelabelingsmixin) + * [`fn withScheme(scheme)`](#fn-specpodmetricsendpointswithscheme) + * [`fn withScrapeTimeout(scrapeTimeout)`](#fn-specpodmetricsendpointswithscrapetimeout) + * [`fn withTargetPort(targetPort)`](#fn-specpodmetricsendpointswithtargetport) + * [`fn withTrackTimestampsStaleness(trackTimestampsStaleness)`](#fn-specpodmetricsendpointswithtracktimestampsstaleness) + * [`obj spec.podMetricsEndpoints.authorization`](#obj-specpodmetricsendpointsauthorization) + * [`fn withType(type)`](#fn-specpodmetricsendpointsauthorizationwithtype) + * [`obj spec.podMetricsEndpoints.authorization.credentials`](#obj-specpodmetricsendpointsauthorizationcredentials) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsauthorizationcredentialswithoptional) + * [`obj spec.podMetricsEndpoints.basicAuth`](#obj-specpodmetricsendpointsbasicauth) + * [`obj spec.podMetricsEndpoints.basicAuth.password`](#obj-specpodmetricsendpointsbasicauthpassword) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsbasicauthpasswordwithoptional) + * [`obj spec.podMetricsEndpoints.basicAuth.username`](#obj-specpodmetricsendpointsbasicauthusername) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsbasicauthusernamewithoptional) + * [`obj spec.podMetricsEndpoints.bearerTokenSecret`](#obj-specpodmetricsendpointsbearertokensecret) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsbearertokensecretwithoptional) + * [`obj spec.podMetricsEndpoints.metricRelabelings`](#obj-specpodmetricsendpointsmetricrelabelings) + * [`fn withAction(action)`](#fn-specpodmetricsendpointsmetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specpodmetricsendpointsmetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specpodmetricsendpointsmetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specpodmetricsendpointsmetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specpodmetricsendpointsmetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specpodmetricsendpointsmetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specpodmetricsendpointsmetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specpodmetricsendpointsmetricrelabelingswithtargetlabel) + * [`obj spec.podMetricsEndpoints.oauth2`](#obj-specpodmetricsendpointsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specpodmetricsendpointsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specpodmetricsendpointsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specpodmetricsendpointsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specpodmetricsendpointsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specpodmetricsendpointsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specpodmetricsendpointsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specpodmetricsendpointsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specpodmetricsendpointsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specpodmetricsendpointsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specpodmetricsendpointsoauth2withtokenurl) + * [`obj spec.podMetricsEndpoints.oauth2.clientId`](#obj-specpodmetricsendpointsoauth2clientid) + * [`obj spec.podMetricsEndpoints.oauth2.clientId.configMap`](#obj-specpodmetricsendpointsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsoauth2clientidconfigmapwithoptional) + * [`obj spec.podMetricsEndpoints.oauth2.clientId.secret`](#obj-specpodmetricsendpointsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsoauth2clientidsecretwithoptional) + * [`obj spec.podMetricsEndpoints.oauth2.clientSecret`](#obj-specpodmetricsendpointsoauth2clientsecret) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsoauth2clientsecretwithoptional) + * [`obj spec.podMetricsEndpoints.oauth2.tlsConfig`](#obj-specpodmetricsendpointsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specpodmetricsendpointsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specpodmetricsendpointsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specpodmetricsendpointsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specpodmetricsendpointsoauth2tlsconfigwithservername) + * [`obj spec.podMetricsEndpoints.oauth2.tlsConfig.ca`](#obj-specpodmetricsendpointsoauth2tlsconfigca) + * [`obj spec.podMetricsEndpoints.oauth2.tlsConfig.ca.configMap`](#obj-specpodmetricsendpointsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.podMetricsEndpoints.oauth2.tlsConfig.ca.secret`](#obj-specpodmetricsendpointsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.podMetricsEndpoints.oauth2.tlsConfig.cert`](#obj-specpodmetricsendpointsoauth2tlsconfigcert) + * [`obj spec.podMetricsEndpoints.oauth2.tlsConfig.cert.configMap`](#obj-specpodmetricsendpointsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.podMetricsEndpoints.oauth2.tlsConfig.cert.secret`](#obj-specpodmetricsendpointsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.podMetricsEndpoints.oauth2.tlsConfig.keySecret`](#obj-specpodmetricsendpointsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specpodmetricsendpointsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.podMetricsEndpoints.relabelings`](#obj-specpodmetricsendpointsrelabelings) + * [`fn withAction(action)`](#fn-specpodmetricsendpointsrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specpodmetricsendpointsrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specpodmetricsendpointsrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specpodmetricsendpointsrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specpodmetricsendpointsrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specpodmetricsendpointsrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specpodmetricsendpointsrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specpodmetricsendpointsrelabelingswithtargetlabel) + * [`obj spec.podMetricsEndpoints.tlsConfig`](#obj-specpodmetricsendpointstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specpodmetricsendpointstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specpodmetricsendpointstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specpodmetricsendpointstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specpodmetricsendpointstlsconfigwithservername) + * [`obj spec.podMetricsEndpoints.tlsConfig.ca`](#obj-specpodmetricsendpointstlsconfigca) + * [`obj spec.podMetricsEndpoints.tlsConfig.ca.configMap`](#obj-specpodmetricsendpointstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specpodmetricsendpointstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointstlsconfigcaconfigmapwithoptional) + * [`obj spec.podMetricsEndpoints.tlsConfig.ca.secret`](#obj-specpodmetricsendpointstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specpodmetricsendpointstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointstlsconfigcasecretwithoptional) + * [`obj spec.podMetricsEndpoints.tlsConfig.cert`](#obj-specpodmetricsendpointstlsconfigcert) + * [`obj spec.podMetricsEndpoints.tlsConfig.cert.configMap`](#obj-specpodmetricsendpointstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specpodmetricsendpointstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointstlsconfigcertconfigmapwithoptional) + * [`obj spec.podMetricsEndpoints.tlsConfig.cert.secret`](#obj-specpodmetricsendpointstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specpodmetricsendpointstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointstlsconfigcertsecretwithoptional) + * [`obj spec.podMetricsEndpoints.tlsConfig.keySecret`](#obj-specpodmetricsendpointstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specpodmetricsendpointstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specpodmetricsendpointstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specpodmetricsendpointstlsconfigkeysecretwithoptional) + * [`obj spec.selector`](#obj-specselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specselectorwithmatchlabelsmixin) + * [`obj spec.selector.matchExpressions`](#obj-specselectormatchexpressions) + * [`fn withKey(key)`](#fn-specselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specselectormatchexpressionswithvaluesmixin) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of PodMonitor + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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 desired Pod selection for target discovery by Prometheus." + +### fn spec.withBodySizeLimit + +```ts +withBodySizeLimit(bodySizeLimit) +``` + +"When defined, bodySizeLimit specifies a job level limit on the size\nof uncompressed response body that will be accepted by Prometheus.\n\n\nIt requires Prometheus >= v2.28.0." + +### fn spec.withJobLabel + +```ts +withJobLabel(jobLabel) +``` + +"The label to use to retrieve the job name from.\n`jobLabel` selects the label from the associated Kubernetes `Pod`\nobject which will be used as the `job` label for all metrics.\n\n\nFor example if `jobLabel` is set to `foo` and the Kubernetes `Pod`\nobject is labeled with `foo: bar`, then Prometheus adds the `job=\"bar\"`\nlabel to all ingested metrics.\n\n\nIf the value of this field is empty, the `job` label of the metrics\ndefaults to the namespace and name of the PodMonitor object (e.g. `/`)." + +### fn spec.withKeepDroppedTargets + +```ts +withKeepDroppedTargets(keepDroppedTargets) +``` + +"Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\n\nIt requires Prometheus >= v2.47.0." + +### fn spec.withLabelLimit + +```ts +withLabelLimit(labelLimit) +``` + +"Per-scrape limit on number of labels that will be accepted for a sample.\n\n\nIt requires Prometheus >= v2.27.0." + +### fn spec.withLabelNameLengthLimit + +```ts +withLabelNameLengthLimit(labelNameLengthLimit) +``` + +"Per-scrape limit on length of labels name that will be accepted for a sample.\n\n\nIt requires Prometheus >= v2.27.0." + +### fn spec.withLabelValueLengthLimit + +```ts +withLabelValueLengthLimit(labelValueLengthLimit) +``` + +"Per-scrape limit on length of labels value that will be accepted for a sample.\n\n\nIt requires Prometheus >= v2.27.0." + +### fn spec.withPodMetricsEndpoints + +```ts +withPodMetricsEndpoints(podMetricsEndpoints) +``` + +"Defines how to scrape metrics from the selected pods." + +### fn spec.withPodMetricsEndpointsMixin + +```ts +withPodMetricsEndpointsMixin(podMetricsEndpoints) +``` + +"Defines how to scrape metrics from the selected pods." + +**Note:** This function appends passed data to existing values + +### fn spec.withPodTargetLabels + +```ts +withPodTargetLabels(podTargetLabels) +``` + +"`podTargetLabels` defines the labels which are transferred from the\nassociated Kubernetes `Pod` object onto the ingested metrics." + +### fn spec.withPodTargetLabelsMixin + +```ts +withPodTargetLabelsMixin(podTargetLabels) +``` + +"`podTargetLabels` defines the labels which are transferred from the\nassociated Kubernetes `Pod` object onto the ingested metrics." + +**Note:** This function appends passed data to existing values + +### fn spec.withSampleLimit + +```ts +withSampleLimit(sampleLimit) +``` + +"`sampleLimit` defines a per-scrape limit on the number of scraped samples\nthat will be accepted." + +### fn spec.withScrapeClass + +```ts +withScrapeClass(scrapeClass) +``` + +"The scrape class to apply." + +### fn spec.withScrapeProtocols + +```ts +withScrapeProtocols(scrapeProtocols) +``` + +"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +### fn spec.withScrapeProtocolsMixin + +```ts +withScrapeProtocolsMixin(scrapeProtocols) +``` + +"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +**Note:** This function appends passed data to existing values + +### fn spec.withTargetLimit + +```ts +withTargetLimit(targetLimit) +``` + +"`targetLimit` defines a limit on the number of scraped targets that will\nbe accepted." + +## obj spec.attachMetadata + +"`attachMetadata` defines additional metadata which is added to the\ndiscovered targets.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.attachMetadata.withNode + +```ts +withNode(node) +``` + +"When set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects." + +## obj spec.namespaceSelector + +"`namespaceSelector` defines in which namespace(s) Prometheus should discover the pods.\nBy default, the pods are discovered in the same namespace as the `PodMonitor` object but it is possible to select pods across different/all namespaces." + +### fn spec.namespaceSelector.withAny + +```ts +withAny(any) +``` + +"Boolean describing whether all namespaces are selected in contrast to a\nlist restricting them." + +### fn spec.namespaceSelector.withMatchNames + +```ts +withMatchNames(matchNames) +``` + +"List of namespace names to select from." + +### fn spec.namespaceSelector.withMatchNamesMixin + +```ts +withMatchNamesMixin(matchNames) +``` + +"List of namespace names to select from." + +**Note:** This function appends passed data to existing values + +## obj spec.podMetricsEndpoints + +"Defines how to scrape metrics from the selected pods." + +### fn spec.podMetricsEndpoints.withEnableHttp2 + +```ts +withEnableHttp2(enableHttp2) +``` + +"`enableHttp2` can be used to disable HTTP2 when scraping the target." + +### fn spec.podMetricsEndpoints.withFilterRunning + +```ts +withFilterRunning(filterRunning) +``` + +"When true, the pods which are not running (e.g. either in Failed or\nSucceeded state) are dropped during the target discovery.\n\n\nIf unset, the filtering is enabled.\n\n\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase" + +### fn spec.podMetricsEndpoints.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"`followRedirects` defines whether the scrape requests should follow HTTP\n3xx redirects." + +### fn spec.podMetricsEndpoints.withHonorLabels + +```ts +withHonorLabels(honorLabels) +``` + +"When true, `honorLabels` preserves the metric's labels when they collide\nwith the target's labels." + +### fn spec.podMetricsEndpoints.withHonorTimestamps + +```ts +withHonorTimestamps(honorTimestamps) +``` + +"`honorTimestamps` controls whether Prometheus preserves the timestamps\nwhen exposed by the target." + +### fn spec.podMetricsEndpoints.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which Prometheus scrapes the metrics from the target.\n\n\nIf empty, Prometheus uses the global scrape interval." + +### fn spec.podMetricsEndpoints.withMetricRelabelings + +```ts +withMetricRelabelings(metricRelabelings) +``` + +"`metricRelabelings` configures the relabeling rules to apply to the\nsamples before ingestion." + +### fn spec.podMetricsEndpoints.withMetricRelabelingsMixin + +```ts +withMetricRelabelingsMixin(metricRelabelings) +``` + +"`metricRelabelings` configures the relabeling rules to apply to the\nsamples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.podMetricsEndpoints.withParams + +```ts +withParams(params) +``` + +"`params` define optional HTTP URL parameters." + +### fn spec.podMetricsEndpoints.withParamsMixin + +```ts +withParamsMixin(params) +``` + +"`params` define optional HTTP URL parameters." + +**Note:** This function appends passed data to existing values + +### fn spec.podMetricsEndpoints.withPath + +```ts +withPath(path) +``` + +"HTTP path from which to scrape for metrics.\n\n\nIf empty, Prometheus uses the default value (e.g. `/metrics`)." + +### fn spec.podMetricsEndpoints.withPort + +```ts +withPort(port) +``` + +"Name of the Pod port which this endpoint refers to.\n\n\nIt takes precedence over `targetPort`." + +### fn spec.podMetricsEndpoints.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` configures the HTTP Proxy URL (e.g.\n\"http://proxyserver:2195\") to go through when scraping the target." + +### fn spec.podMetricsEndpoints.withRelabelings + +```ts +withRelabelings(relabelings) +``` + +"`relabelings` configures the relabeling rules to apply the target's\nmetadata labels.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.podMetricsEndpoints.withRelabelingsMixin + +```ts +withRelabelingsMixin(relabelings) +``` + +"`relabelings` configures the relabeling rules to apply the target's\nmetadata labels.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +**Note:** This function appends passed data to existing values + +### fn spec.podMetricsEndpoints.withScheme + +```ts +withScheme(scheme) +``` + +"HTTP scheme to use for scraping.\n\n\n`http` and `https` are the expected values unless you rewrite the\n`__scheme__` label via relabeling.\n\n\nIf empty, Prometheus uses the default value `http`." + +### fn spec.podMetricsEndpoints.withScrapeTimeout + +```ts +withScrapeTimeout(scrapeTimeout) +``` + +"Timeout after which Prometheus considers the scrape to be failed.\n\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used." + +### fn spec.podMetricsEndpoints.withTargetPort + +```ts +withTargetPort(targetPort) +``` + +"Name or number of the target port of the `Pod` object behind the Service, the\nport must be specified with container port property.\n\n\nDeprecated: use 'port' instead." + +### fn spec.podMetricsEndpoints.withTrackTimestampsStaleness + +```ts +withTrackTimestampsStaleness(trackTimestampsStaleness) +``` + +"`trackTimestampsStaleness` defines whether Prometheus tracks staleness of\nthe metrics that have an explicit timestamp present in scraped data.\nHas no effect if `honorTimestamps` is false.\n\n\nIt requires Prometheus >= v2.48.0." + +## obj spec.podMetricsEndpoints.authorization + +"`authorization` configures the Authorization header credentials to use when\nscraping the target.\n\n\nCannot be set at the same time as `basicAuth`, or `oauth2`." + +### fn spec.podMetricsEndpoints.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.podMetricsEndpoints.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.podMetricsEndpoints.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.basicAuth + +"`basicAuth` configures the Basic Authentication credentials to use when\nscraping the target.\n\n\nCannot be set at the same time as `authorization`, or `oauth2`." + +## obj spec.podMetricsEndpoints.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.podMetricsEndpoints.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.podMetricsEndpoints.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.bearerTokenSecret + +"`bearerTokenSecret` specifies a key of a Secret containing the bearer\ntoken for scraping targets. The secret needs to be in the same namespace\nas the PodMonitor object and readable by the Prometheus Operator.\n\n\nDeprecated: use `authorization` instead." + +### fn spec.podMetricsEndpoints.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.metricRelabelings + +"`metricRelabelings` configures the relabeling rules to apply to the\nsamples before ingestion." + +### fn spec.podMetricsEndpoints.metricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.podMetricsEndpoints.metricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.podMetricsEndpoints.metricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.podMetricsEndpoints.metricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.podMetricsEndpoints.metricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.podMetricsEndpoints.metricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.podMetricsEndpoints.metricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.podMetricsEndpoints.metricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.podMetricsEndpoints.oauth2 + +"`oauth2` configures the OAuth2 settings to use when scraping the target.\n\n\nIt requires Prometheus >= 2.27.0.\n\n\nCannot be set at the same time as `authorization`, or `basicAuth`." + +### fn spec.podMetricsEndpoints.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.podMetricsEndpoints.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.podMetricsEndpoints.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.podMetricsEndpoints.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.podMetricsEndpoints.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.podMetricsEndpoints.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.podMetricsEndpoints.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.podMetricsEndpoints.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.podMetricsEndpoints.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.podMetricsEndpoints.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.podMetricsEndpoints.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.podMetricsEndpoints.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.podMetricsEndpoints.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.podMetricsEndpoints.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.podMetricsEndpoints.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.podMetricsEndpoints.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.podMetricsEndpoints.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.podMetricsEndpoints.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.podMetricsEndpoints.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.podMetricsEndpoints.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.podMetricsEndpoints.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.podMetricsEndpoints.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.relabelings + +"`relabelings` configures the relabeling rules to apply the target's\nmetadata labels.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.podMetricsEndpoints.relabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.podMetricsEndpoints.relabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.podMetricsEndpoints.relabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.podMetricsEndpoints.relabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.podMetricsEndpoints.relabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.podMetricsEndpoints.relabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.podMetricsEndpoints.relabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.podMetricsEndpoints.relabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.podMetricsEndpoints.tlsConfig + +"TLS configuration to use when scraping the target." + +### fn spec.podMetricsEndpoints.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.podMetricsEndpoints.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.podMetricsEndpoints.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.podMetricsEndpoints.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.podMetricsEndpoints.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.podMetricsEndpoints.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.podMetricsEndpoints.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.podMetricsEndpoints.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.podMetricsEndpoints.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.podMetricsEndpoints.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.podMetricsEndpoints.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.podMetricsEndpoints.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.podMetricsEndpoints.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.podMetricsEndpoints.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.podMetricsEndpoints.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetricsEndpoints.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.podMetricsEndpoints.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.podMetricsEndpoints.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.podMetricsEndpoints.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.selector + +"Label selector to select the Kubernetes `Pod` objects to scrape metrics from." + +### fn spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.selector.withMatchExpressionsMixin + +```ts +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.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/probe.md b/docs/0.14/monitoring/v1/probe.md new file mode 100644 index 0000000..c52f2a8 --- /dev/null +++ b/docs/0.14/monitoring/v1/probe.md @@ -0,0 +1,1615 @@ +--- +permalink: /0.14/monitoring/v1/probe/ +--- + +# monitoring.v1.probe + +"The `Probe` custom resource definition (CRD) defines how to scrape metrics from prober exporters such as the [blackbox exporter](https://github.com/prometheus/blackbox_exporter).\n\n\nThe `Probe` resource needs 2 pieces of information:\n* The list of probed addresses which can be defined statically or by discovering Kubernetes Ingress objects.\n* The prober which exposes the availability of probed endpoints (over various protocols such HTTP, TCP, ICMP, ...) as Prometheus metrics.\n\n\n`Prometheus` and `PrometheusAgent` objects select `Probe` objects using label and namespace selectors." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withInterval(interval)`](#fn-specwithinterval) + * [`fn withJobName(jobName)`](#fn-specwithjobname) + * [`fn withKeepDroppedTargets(keepDroppedTargets)`](#fn-specwithkeepdroppedtargets) + * [`fn withLabelLimit(labelLimit)`](#fn-specwithlabellimit) + * [`fn withLabelNameLengthLimit(labelNameLengthLimit)`](#fn-specwithlabelnamelengthlimit) + * [`fn withLabelValueLengthLimit(labelValueLengthLimit)`](#fn-specwithlabelvaluelengthlimit) + * [`fn withMetricRelabelings(metricRelabelings)`](#fn-specwithmetricrelabelings) + * [`fn withMetricRelabelingsMixin(metricRelabelings)`](#fn-specwithmetricrelabelingsmixin) + * [`fn withModule(module)`](#fn-specwithmodule) + * [`fn withSampleLimit(sampleLimit)`](#fn-specwithsamplelimit) + * [`fn withScrapeClass(scrapeClass)`](#fn-specwithscrapeclass) + * [`fn withScrapeProtocols(scrapeProtocols)`](#fn-specwithscrapeprotocols) + * [`fn withScrapeProtocolsMixin(scrapeProtocols)`](#fn-specwithscrapeprotocolsmixin) + * [`fn withScrapeTimeout(scrapeTimeout)`](#fn-specwithscrapetimeout) + * [`fn withTargetLimit(targetLimit)`](#fn-specwithtargetlimit) + * [`obj spec.authorization`](#obj-specauthorization) + * [`fn withType(type)`](#fn-specauthorizationwithtype) + * [`obj spec.authorization.credentials`](#obj-specauthorizationcredentials) + * [`fn withKey(key)`](#fn-specauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specauthorizationcredentialswithoptional) + * [`obj spec.basicAuth`](#obj-specbasicauth) + * [`obj spec.basicAuth.password`](#obj-specbasicauthpassword) + * [`fn withKey(key)`](#fn-specbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specbasicauthpasswordwithoptional) + * [`obj spec.basicAuth.username`](#obj-specbasicauthusername) + * [`fn withKey(key)`](#fn-specbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specbasicauthusernamewithoptional) + * [`obj spec.bearerTokenSecret`](#obj-specbearertokensecret) + * [`fn withKey(key)`](#fn-specbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specbearertokensecretwithoptional) + * [`obj spec.metricRelabelings`](#obj-specmetricrelabelings) + * [`fn withAction(action)`](#fn-specmetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmetricrelabelingswithtargetlabel) + * [`obj spec.oauth2`](#obj-specoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specoauth2withtokenurl) + * [`obj spec.oauth2.clientId`](#obj-specoauth2clientid) + * [`obj spec.oauth2.clientId.configMap`](#obj-specoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specoauth2clientidconfigmapwithoptional) + * [`obj spec.oauth2.clientId.secret`](#obj-specoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2clientidsecretwithoptional) + * [`obj spec.oauth2.clientSecret`](#obj-specoauth2clientsecret) + * [`fn withKey(key)`](#fn-specoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2clientsecretwithoptional) + * [`obj spec.oauth2.tlsConfig`](#obj-specoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specoauth2tlsconfigwithservername) + * [`obj spec.oauth2.tlsConfig.ca`](#obj-specoauth2tlsconfigca) + * [`obj spec.oauth2.tlsConfig.ca.configMap`](#obj-specoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.oauth2.tlsConfig.ca.secret`](#obj-specoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigcasecretwithoptional) + * [`obj spec.oauth2.tlsConfig.cert`](#obj-specoauth2tlsconfigcert) + * [`obj spec.oauth2.tlsConfig.cert.configMap`](#obj-specoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.oauth2.tlsConfig.cert.secret`](#obj-specoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.oauth2.tlsConfig.keySecret`](#obj-specoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.prober`](#obj-specprober) + * [`fn withPath(path)`](#fn-specproberwithpath) + * [`fn withProxyUrl(proxyUrl)`](#fn-specproberwithproxyurl) + * [`fn withScheme(scheme)`](#fn-specproberwithscheme) + * [`fn withUrl(url)`](#fn-specproberwithurl) + * [`obj spec.targets`](#obj-spectargets) + * [`obj spec.targets.ingress`](#obj-spectargetsingress) + * [`fn withRelabelingConfigs(relabelingConfigs)`](#fn-spectargetsingresswithrelabelingconfigs) + * [`fn withRelabelingConfigsMixin(relabelingConfigs)`](#fn-spectargetsingresswithrelabelingconfigsmixin) + * [`obj spec.targets.ingress.namespaceSelector`](#obj-spectargetsingressnamespaceselector) + * [`fn withAny(any)`](#fn-spectargetsingressnamespaceselectorwithany) + * [`fn withMatchNames(matchNames)`](#fn-spectargetsingressnamespaceselectorwithmatchnames) + * [`fn withMatchNamesMixin(matchNames)`](#fn-spectargetsingressnamespaceselectorwithmatchnamesmixin) + * [`obj spec.targets.ingress.relabelingConfigs`](#obj-spectargetsingressrelabelingconfigs) + * [`fn withAction(action)`](#fn-spectargetsingressrelabelingconfigswithaction) + * [`fn withModulus(modulus)`](#fn-spectargetsingressrelabelingconfigswithmodulus) + * [`fn withRegex(regex)`](#fn-spectargetsingressrelabelingconfigswithregex) + * [`fn withReplacement(replacement)`](#fn-spectargetsingressrelabelingconfigswithreplacement) + * [`fn withSeparator(separator)`](#fn-spectargetsingressrelabelingconfigswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-spectargetsingressrelabelingconfigswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-spectargetsingressrelabelingconfigswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-spectargetsingressrelabelingconfigswithtargetlabel) + * [`obj spec.targets.ingress.selector`](#obj-spectargetsingressselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-spectargetsingressselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-spectargetsingressselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-spectargetsingressselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-spectargetsingressselectorwithmatchlabelsmixin) + * [`obj spec.targets.ingress.selector.matchExpressions`](#obj-spectargetsingressselectormatchexpressions) + * [`fn withKey(key)`](#fn-spectargetsingressselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-spectargetsingressselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-spectargetsingressselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-spectargetsingressselectormatchexpressionswithvaluesmixin) + * [`obj spec.targets.staticConfig`](#obj-spectargetsstaticconfig) + * [`fn withLabels(labels)`](#fn-spectargetsstaticconfigwithlabels) + * [`fn withLabelsMixin(labels)`](#fn-spectargetsstaticconfigwithlabelsmixin) + * [`fn withRelabelingConfigs(relabelingConfigs)`](#fn-spectargetsstaticconfigwithrelabelingconfigs) + * [`fn withRelabelingConfigsMixin(relabelingConfigs)`](#fn-spectargetsstaticconfigwithrelabelingconfigsmixin) + * [`fn withStatic(static)`](#fn-spectargetsstaticconfigwithstatic) + * [`fn withStaticMixin(static)`](#fn-spectargetsstaticconfigwithstaticmixin) + * [`obj spec.targets.staticConfig.relabelingConfigs`](#obj-spectargetsstaticconfigrelabelingconfigs) + * [`fn withAction(action)`](#fn-spectargetsstaticconfigrelabelingconfigswithaction) + * [`fn withModulus(modulus)`](#fn-spectargetsstaticconfigrelabelingconfigswithmodulus) + * [`fn withRegex(regex)`](#fn-spectargetsstaticconfigrelabelingconfigswithregex) + * [`fn withReplacement(replacement)`](#fn-spectargetsstaticconfigrelabelingconfigswithreplacement) + * [`fn withSeparator(separator)`](#fn-spectargetsstaticconfigrelabelingconfigswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-spectargetsstaticconfigrelabelingconfigswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-spectargetsstaticconfigrelabelingconfigswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-spectargetsstaticconfigrelabelingconfigswithtargetlabel) + * [`obj spec.tlsConfig`](#obj-spectlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-spectlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-spectlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-spectlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-spectlsconfigwithservername) + * [`obj spec.tlsConfig.ca`](#obj-spectlsconfigca) + * [`obj spec.tlsConfig.ca.configMap`](#obj-spectlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-spectlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-spectlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigcaconfigmapwithoptional) + * [`obj spec.tlsConfig.ca.secret`](#obj-spectlsconfigcasecret) + * [`fn withKey(key)`](#fn-spectlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-spectlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigcasecretwithoptional) + * [`obj spec.tlsConfig.cert`](#obj-spectlsconfigcert) + * [`obj spec.tlsConfig.cert.configMap`](#obj-spectlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-spectlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-spectlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigcertconfigmapwithoptional) + * [`obj spec.tlsConfig.cert.secret`](#obj-spectlsconfigcertsecret) + * [`fn withKey(key)`](#fn-spectlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-spectlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigcertsecretwithoptional) + * [`obj spec.tlsConfig.keySecret`](#obj-spectlsconfigkeysecret) + * [`fn withKey(key)`](#fn-spectlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-spectlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigkeysecretwithoptional) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of Probe + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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 desired Ingress selection for target discovery by Prometheus." + +### fn spec.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which targets are probed using the configured prober.\nIf not specified Prometheus' global scrape interval is used." + +### fn spec.withJobName + +```ts +withJobName(jobName) +``` + +"The job name assigned to scraped metrics by default." + +### fn spec.withKeepDroppedTargets + +```ts +withKeepDroppedTargets(keepDroppedTargets) +``` + +"Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\n\nIt requires Prometheus >= v2.47.0." + +### fn spec.withLabelLimit + +```ts +withLabelLimit(labelLimit) +``` + +"Per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer." + +### fn spec.withLabelNameLengthLimit + +```ts +withLabelNameLengthLimit(labelNameLengthLimit) +``` + +"Per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer." + +### fn spec.withLabelValueLengthLimit + +```ts +withLabelValueLengthLimit(labelValueLengthLimit) +``` + +"Per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer." + +### fn spec.withMetricRelabelings + +```ts +withMetricRelabelings(metricRelabelings) +``` + +"MetricRelabelConfigs to apply to samples before ingestion." + +### fn spec.withMetricRelabelingsMixin + +```ts +withMetricRelabelingsMixin(metricRelabelings) +``` + +"MetricRelabelConfigs to apply to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.withModule + +```ts +withModule(module) +``` + +"The module to use for probing specifying how to probe the target.\nExample module configuring in the blackbox exporter:\nhttps://github.com/prometheus/blackbox_exporter/blob/master/example.yml" + +### fn spec.withSampleLimit + +```ts +withSampleLimit(sampleLimit) +``` + +"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted." + +### fn spec.withScrapeClass + +```ts +withScrapeClass(scrapeClass) +``` + +"The scrape class to apply." + +### fn spec.withScrapeProtocols + +```ts +withScrapeProtocols(scrapeProtocols) +``` + +"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +### fn spec.withScrapeProtocolsMixin + +```ts +withScrapeProtocolsMixin(scrapeProtocols) +``` + +"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +**Note:** This function appends passed data to existing values + +### fn spec.withScrapeTimeout + +```ts +withScrapeTimeout(scrapeTimeout) +``` + +"Timeout for scraping metrics from the Prometheus exporter.\nIf not specified, the Prometheus global scrape timeout is used." + +### fn spec.withTargetLimit + +```ts +withTargetLimit(targetLimit) +``` + +"TargetLimit defines a limit on the number of scraped targets that will be accepted." + +## obj spec.authorization + +"Authorization section for this endpoint" + +### fn spec.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.basicAuth + +"BasicAuth allow an endpoint to authenticate over basic authentication.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoint" + +## obj spec.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.bearerTokenSecret + +"Secret to mount to read bearer token for scraping targets. The secret\nneeds to be in the same namespace as the probe and accessible by\nthe Prometheus Operator." + +### fn spec.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.metricRelabelings + +"MetricRelabelConfigs to apply to samples before ingestion." + +### fn spec.metricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.metricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.metricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.metricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.metricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.metricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.metricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.metricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.oauth2 + +"OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer." + +### fn spec.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.prober + +"Specification for the prober to use for probing targets.\nThe prober.URL parameter is required. Targets cannot be probed if left empty." + +### fn spec.prober.withPath + +```ts +withPath(path) +``` + +"Path to collect metrics from.\nDefaults to `/probe`." + +### fn spec.prober.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"Optional ProxyURL." + +### fn spec.prober.withScheme + +```ts +withScheme(scheme) +``` + +"HTTP scheme to use for scraping.\n`http` and `https` are the expected values unless you rewrite the `__scheme__` label via relabeling.\nIf empty, Prometheus uses the default value `http`." + +### fn spec.prober.withUrl + +```ts +withUrl(url) +``` + +"Mandatory URL of the prober." + +## obj spec.targets + +"Targets defines a set of static or dynamically discovered targets to probe." + +## obj spec.targets.ingress + +"ingress defines the Ingress objects to probe and the relabeling\nconfiguration.\nIf `staticConfig` is also defined, `staticConfig` takes precedence." + +### fn spec.targets.ingress.withRelabelingConfigs + +```ts +withRelabelingConfigs(relabelingConfigs) +``` + +"RelabelConfigs to apply to the label set of the target before it gets\nscraped.\nThe original ingress address is available via the\n`__tmp_prometheus_ingress_address` label. It can be used to customize the\nprobed URL.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.targets.ingress.withRelabelingConfigsMixin + +```ts +withRelabelingConfigsMixin(relabelingConfigs) +``` + +"RelabelConfigs to apply to the label set of the target before it gets\nscraped.\nThe original ingress address is available via the\n`__tmp_prometheus_ingress_address` label. It can be used to customize the\nprobed URL.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +**Note:** This function appends passed data to existing values + +## obj spec.targets.ingress.namespaceSelector + +"From which namespaces to select Ingress objects." + +### fn spec.targets.ingress.namespaceSelector.withAny + +```ts +withAny(any) +``` + +"Boolean describing whether all namespaces are selected in contrast to a\nlist restricting them." + +### fn spec.targets.ingress.namespaceSelector.withMatchNames + +```ts +withMatchNames(matchNames) +``` + +"List of namespace names to select from." + +### fn spec.targets.ingress.namespaceSelector.withMatchNamesMixin + +```ts +withMatchNamesMixin(matchNames) +``` + +"List of namespace names to select from." + +**Note:** This function appends passed data to existing values + +## obj spec.targets.ingress.relabelingConfigs + +"RelabelConfigs to apply to the label set of the target before it gets\nscraped.\nThe original ingress address is available via the\n`__tmp_prometheus_ingress_address` label. It can be used to customize the\nprobed URL.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.targets.ingress.relabelingConfigs.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.targets.ingress.relabelingConfigs.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.targets.ingress.relabelingConfigs.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.targets.ingress.relabelingConfigs.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.targets.ingress.relabelingConfigs.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.targets.ingress.relabelingConfigs.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.targets.ingress.relabelingConfigs.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.targets.ingress.relabelingConfigs.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.targets.ingress.selector + +"Selector to select the Ingress objects." + +### fn spec.targets.ingress.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.targets.ingress.selector.withMatchExpressionsMixin + +```ts +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.targets.ingress.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.targets.ingress.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.targets.ingress.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.targets.ingress.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.targets.ingress.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.targets.ingress.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.targets.ingress.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.targets.staticConfig + +"staticConfig defines the static list of targets to probe and the\nrelabeling configuration.\nIf `ingress` is also defined, `staticConfig` takes precedence.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#static_config." + +### fn spec.targets.staticConfig.withLabels + +```ts +withLabels(labels) +``` + +"Labels assigned to all metrics scraped from the targets." + +### fn spec.targets.staticConfig.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Labels assigned to all metrics scraped from the targets." + +**Note:** This function appends passed data to existing values + +### fn spec.targets.staticConfig.withRelabelingConfigs + +```ts +withRelabelingConfigs(relabelingConfigs) +``` + +"RelabelConfigs to apply to the label set of the targets before it gets\nscraped.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.targets.staticConfig.withRelabelingConfigsMixin + +```ts +withRelabelingConfigsMixin(relabelingConfigs) +``` + +"RelabelConfigs to apply to the label set of the targets before it gets\nscraped.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +**Note:** This function appends passed data to existing values + +### fn spec.targets.staticConfig.withStatic + +```ts +withStatic(static) +``` + +"The list of hosts to probe." + +### fn spec.targets.staticConfig.withStaticMixin + +```ts +withStaticMixin(static) +``` + +"The list of hosts to probe." + +**Note:** This function appends passed data to existing values + +## obj spec.targets.staticConfig.relabelingConfigs + +"RelabelConfigs to apply to the label set of the targets before it gets\nscraped.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.targets.staticConfig.relabelingConfigs.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.targets.staticConfig.relabelingConfigs.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.targets.staticConfig.relabelingConfigs.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.targets.staticConfig.relabelingConfigs.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.targets.staticConfig.relabelingConfigs.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.targets.staticConfig.relabelingConfigs.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.targets.staticConfig.relabelingConfigs.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.targets.staticConfig.relabelingConfigs.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.tlsConfig + +"TLS configuration to use when scraping the endpoint." + +### fn spec.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/prometheus.md b/docs/0.14/monitoring/v1/prometheus.md new file mode 100644 index 0000000..b0bbc71 --- /dev/null +++ b/docs/0.14/monitoring/v1/prometheus.md @@ -0,0 +1,16435 @@ +--- +permalink: /0.14/monitoring/v1/prometheus/ +--- + +# monitoring.v1.prometheus + +"The `Prometheus` custom resource definition (CRD) defines a desired [Prometheus](https://prometheus.io/docs/prometheus) setup to run in a Kubernetes cluster. It allows to specify many options such as the number of replicas, persistent storage, and Alertmanagers where firing alerts should be sent and many more.\n\n\nFor each `Prometheus` resource, the Operator deploys one or several `StatefulSet` objects in the same namespace. The number of StatefulSets is equal to the number of shards which is 1 by default.\n\n\nThe resource defines via label and namespace selectors which `ServiceMonitor`, `PodMonitor`, `Probe` and `PrometheusRule` objects should be associated to the deployed Prometheus instances.\n\n\nThe Operator continuously reconciles the scrape and rules configuration and a sidecar container running in the Prometheus pods triggers a reload of the configuration when needed." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withAdditionalArgs(additionalArgs)`](#fn-specwithadditionalargs) + * [`fn withAdditionalArgsMixin(additionalArgs)`](#fn-specwithadditionalargsmixin) + * [`fn withAllowOverlappingBlocks(allowOverlappingBlocks)`](#fn-specwithallowoverlappingblocks) + * [`fn withAutomountServiceAccountToken(automountServiceAccountToken)`](#fn-specwithautomountserviceaccounttoken) + * [`fn withBaseImage(baseImage)`](#fn-specwithbaseimage) + * [`fn withBodySizeLimit(bodySizeLimit)`](#fn-specwithbodysizelimit) + * [`fn withConfigMaps(configMaps)`](#fn-specwithconfigmaps) + * [`fn withConfigMapsMixin(configMaps)`](#fn-specwithconfigmapsmixin) + * [`fn withContainers(containers)`](#fn-specwithcontainers) + * [`fn withContainersMixin(containers)`](#fn-specwithcontainersmixin) + * [`fn withDisableCompaction(disableCompaction)`](#fn-specwithdisablecompaction) + * [`fn withEnableAdminAPI(enableAdminAPI)`](#fn-specwithenableadminapi) + * [`fn withEnableFeatures(enableFeatures)`](#fn-specwithenablefeatures) + * [`fn withEnableFeaturesMixin(enableFeatures)`](#fn-specwithenablefeaturesmixin) + * [`fn withEnableRemoteWriteReceiver(enableRemoteWriteReceiver)`](#fn-specwithenableremotewritereceiver) + * [`fn withEnforcedBodySizeLimit(enforcedBodySizeLimit)`](#fn-specwithenforcedbodysizelimit) + * [`fn withEnforcedKeepDroppedTargets(enforcedKeepDroppedTargets)`](#fn-specwithenforcedkeepdroppedtargets) + * [`fn withEnforcedLabelLimit(enforcedLabelLimit)`](#fn-specwithenforcedlabellimit) + * [`fn withEnforcedLabelNameLengthLimit(enforcedLabelNameLengthLimit)`](#fn-specwithenforcedlabelnamelengthlimit) + * [`fn withEnforcedLabelValueLengthLimit(enforcedLabelValueLengthLimit)`](#fn-specwithenforcedlabelvaluelengthlimit) + * [`fn withEnforcedNamespaceLabel(enforcedNamespaceLabel)`](#fn-specwithenforcednamespacelabel) + * [`fn withEnforcedSampleLimit(enforcedSampleLimit)`](#fn-specwithenforcedsamplelimit) + * [`fn withEnforcedTargetLimit(enforcedTargetLimit)`](#fn-specwithenforcedtargetlimit) + * [`fn withEvaluationInterval(evaluationInterval)`](#fn-specwithevaluationinterval) + * [`fn withExcludedFromEnforcement(excludedFromEnforcement)`](#fn-specwithexcludedfromenforcement) + * [`fn withExcludedFromEnforcementMixin(excludedFromEnforcement)`](#fn-specwithexcludedfromenforcementmixin) + * [`fn withExternalLabels(externalLabels)`](#fn-specwithexternallabels) + * [`fn withExternalLabelsMixin(externalLabels)`](#fn-specwithexternallabelsmixin) + * [`fn withExternalUrl(externalUrl)`](#fn-specwithexternalurl) + * [`fn withHostAliases(hostAliases)`](#fn-specwithhostaliases) + * [`fn withHostAliasesMixin(hostAliases)`](#fn-specwithhostaliasesmixin) + * [`fn withHostNetwork(hostNetwork)`](#fn-specwithhostnetwork) + * [`fn withIgnoreNamespaceSelectors(ignoreNamespaceSelectors)`](#fn-specwithignorenamespaceselectors) + * [`fn withImage(image)`](#fn-specwithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-specwithimagepullpolicy) + * [`fn withImagePullSecrets(imagePullSecrets)`](#fn-specwithimagepullsecrets) + * [`fn withImagePullSecretsMixin(imagePullSecrets)`](#fn-specwithimagepullsecretsmixin) + * [`fn withInitContainers(initContainers)`](#fn-specwithinitcontainers) + * [`fn withInitContainersMixin(initContainers)`](#fn-specwithinitcontainersmixin) + * [`fn withKeepDroppedTargets(keepDroppedTargets)`](#fn-specwithkeepdroppedtargets) + * [`fn withLabelLimit(labelLimit)`](#fn-specwithlabellimit) + * [`fn withLabelNameLengthLimit(labelNameLengthLimit)`](#fn-specwithlabelnamelengthlimit) + * [`fn withLabelValueLengthLimit(labelValueLengthLimit)`](#fn-specwithlabelvaluelengthlimit) + * [`fn withListenLocal(listenLocal)`](#fn-specwithlistenlocal) + * [`fn withLogFormat(logFormat)`](#fn-specwithlogformat) + * [`fn withLogLevel(logLevel)`](#fn-specwithloglevel) + * [`fn withMaximumStartupDurationSeconds(maximumStartupDurationSeconds)`](#fn-specwithmaximumstartupdurationseconds) + * [`fn withMinReadySeconds(minReadySeconds)`](#fn-specwithminreadyseconds) + * [`fn withNodeSelector(nodeSelector)`](#fn-specwithnodeselector) + * [`fn withNodeSelectorMixin(nodeSelector)`](#fn-specwithnodeselectormixin) + * [`fn withOverrideHonorLabels(overrideHonorLabels)`](#fn-specwithoverridehonorlabels) + * [`fn withOverrideHonorTimestamps(overrideHonorTimestamps)`](#fn-specwithoverridehonortimestamps) + * [`fn withPaused(paused)`](#fn-specwithpaused) + * [`fn withPodTargetLabels(podTargetLabels)`](#fn-specwithpodtargetlabels) + * [`fn withPodTargetLabelsMixin(podTargetLabels)`](#fn-specwithpodtargetlabelsmixin) + * [`fn withPortName(portName)`](#fn-specwithportname) + * [`fn withPriorityClassName(priorityClassName)`](#fn-specwithpriorityclassname) + * [`fn withPrometheusExternalLabelName(prometheusExternalLabelName)`](#fn-specwithprometheusexternallabelname) + * [`fn withPrometheusRulesExcludedFromEnforce(prometheusRulesExcludedFromEnforce)`](#fn-specwithprometheusrulesexcludedfromenforce) + * [`fn withPrometheusRulesExcludedFromEnforceMixin(prometheusRulesExcludedFromEnforce)`](#fn-specwithprometheusrulesexcludedfromenforcemixin) + * [`fn withQueryLogFile(queryLogFile)`](#fn-specwithquerylogfile) + * [`fn withReloadStrategy(reloadStrategy)`](#fn-specwithreloadstrategy) + * [`fn withRemoteRead(remoteRead)`](#fn-specwithremoteread) + * [`fn withRemoteReadMixin(remoteRead)`](#fn-specwithremotereadmixin) + * [`fn withRemoteWrite(remoteWrite)`](#fn-specwithremotewrite) + * [`fn withRemoteWriteMixin(remoteWrite)`](#fn-specwithremotewritemixin) + * [`fn withReplicaExternalLabelName(replicaExternalLabelName)`](#fn-specwithreplicaexternallabelname) + * [`fn withReplicas(replicas)`](#fn-specwithreplicas) + * [`fn withRetention(retention)`](#fn-specwithretention) + * [`fn withRetentionSize(retentionSize)`](#fn-specwithretentionsize) + * [`fn withRoutePrefix(routePrefix)`](#fn-specwithrouteprefix) + * [`fn withSampleLimit(sampleLimit)`](#fn-specwithsamplelimit) + * [`fn withScrapeClasses(scrapeClasses)`](#fn-specwithscrapeclasses) + * [`fn withScrapeClassesMixin(scrapeClasses)`](#fn-specwithscrapeclassesmixin) + * [`fn withScrapeInterval(scrapeInterval)`](#fn-specwithscrapeinterval) + * [`fn withScrapeProtocols(scrapeProtocols)`](#fn-specwithscrapeprotocols) + * [`fn withScrapeProtocolsMixin(scrapeProtocols)`](#fn-specwithscrapeprotocolsmixin) + * [`fn withScrapeTimeout(scrapeTimeout)`](#fn-specwithscrapetimeout) + * [`fn withSecrets(secrets)`](#fn-specwithsecrets) + * [`fn withSecretsMixin(secrets)`](#fn-specwithsecretsmixin) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withServiceDiscoveryRole(serviceDiscoveryRole)`](#fn-specwithservicediscoveryrole) + * [`fn withSha(sha)`](#fn-specwithsha) + * [`fn withShards(shards)`](#fn-specwithshards) + * [`fn withTag(tag)`](#fn-specwithtag) + * [`fn withTargetLimit(targetLimit)`](#fn-specwithtargetlimit) + * [`fn withTolerations(tolerations)`](#fn-specwithtolerations) + * [`fn withTolerationsMixin(tolerations)`](#fn-specwithtolerationsmixin) + * [`fn withTopologySpreadConstraints(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraints) + * [`fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraintsmixin) + * [`fn withVersion(version)`](#fn-specwithversion) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specwithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specwithvolumemountsmixin) + * [`fn withVolumes(volumes)`](#fn-specwithvolumes) + * [`fn withVolumesMixin(volumes)`](#fn-specwithvolumesmixin) + * [`fn withWalCompression(walCompression)`](#fn-specwithwalcompression) + * [`obj spec.additionalAlertManagerConfigs`](#obj-specadditionalalertmanagerconfigs) + * [`fn withKey(key)`](#fn-specadditionalalertmanagerconfigswithkey) + * [`fn withName(name)`](#fn-specadditionalalertmanagerconfigswithname) + * [`fn withOptional(optional)`](#fn-specadditionalalertmanagerconfigswithoptional) + * [`obj spec.additionalAlertRelabelConfigs`](#obj-specadditionalalertrelabelconfigs) + * [`fn withKey(key)`](#fn-specadditionalalertrelabelconfigswithkey) + * [`fn withName(name)`](#fn-specadditionalalertrelabelconfigswithname) + * [`fn withOptional(optional)`](#fn-specadditionalalertrelabelconfigswithoptional) + * [`obj spec.additionalArgs`](#obj-specadditionalargs) + * [`fn withName(name)`](#fn-specadditionalargswithname) + * [`fn withValue(value)`](#fn-specadditionalargswithvalue) + * [`obj spec.additionalScrapeConfigs`](#obj-specadditionalscrapeconfigs) + * [`fn withKey(key)`](#fn-specadditionalscrapeconfigswithkey) + * [`fn withName(name)`](#fn-specadditionalscrapeconfigswithname) + * [`fn withOptional(optional)`](#fn-specadditionalscrapeconfigswithoptional) + * [`obj spec.affinity`](#obj-specaffinity) + * [`obj spec.affinity.nodeAffinity`](#obj-specaffinitynodeaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfieldsmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressions) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfields) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withNodeSelectorTerms(nodeSelectorTerms)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectorterms) + * [`fn withNodeSelectorTermsMixin(nodeSelectorTerms)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectortermsmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfieldsmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfields) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvaluesmixin) + * [`obj spec.affinity.podAffinity`](#obj-specaffinitypodaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity`](#obj-specaffinitypodantiaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.alerting`](#obj-specalerting) + * [`fn withAlertmanagers(alertmanagers)`](#fn-specalertingwithalertmanagers) + * [`fn withAlertmanagersMixin(alertmanagers)`](#fn-specalertingwithalertmanagersmixin) + * [`obj spec.alerting.alertmanagers`](#obj-specalertingalertmanagers) + * [`fn withAlertRelabelings(alertRelabelings)`](#fn-specalertingalertmanagerswithalertrelabelings) + * [`fn withAlertRelabelingsMixin(alertRelabelings)`](#fn-specalertingalertmanagerswithalertrelabelingsmixin) + * [`fn withApiVersion(apiVersion)`](#fn-specalertingalertmanagerswithapiversion) + * [`fn withBearerTokenFile(bearerTokenFile)`](#fn-specalertingalertmanagerswithbearertokenfile) + * [`fn withEnableHttp2(enableHttp2)`](#fn-specalertingalertmanagerswithenablehttp2) + * [`fn withName(name)`](#fn-specalertingalertmanagerswithname) + * [`fn withNamespace(namespace)`](#fn-specalertingalertmanagerswithnamespace) + * [`fn withPathPrefix(pathPrefix)`](#fn-specalertingalertmanagerswithpathprefix) + * [`fn withPort(port)`](#fn-specalertingalertmanagerswithport) + * [`fn withRelabelings(relabelings)`](#fn-specalertingalertmanagerswithrelabelings) + * [`fn withRelabelingsMixin(relabelings)`](#fn-specalertingalertmanagerswithrelabelingsmixin) + * [`fn withScheme(scheme)`](#fn-specalertingalertmanagerswithscheme) + * [`fn withTimeout(timeout)`](#fn-specalertingalertmanagerswithtimeout) + * [`obj spec.alerting.alertmanagers.alertRelabelings`](#obj-specalertingalertmanagersalertrelabelings) + * [`fn withAction(action)`](#fn-specalertingalertmanagersalertrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specalertingalertmanagersalertrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specalertingalertmanagersalertrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specalertingalertmanagersalertrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specalertingalertmanagersalertrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specalertingalertmanagersalertrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specalertingalertmanagersalertrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specalertingalertmanagersalertrelabelingswithtargetlabel) + * [`obj spec.alerting.alertmanagers.authorization`](#obj-specalertingalertmanagersauthorization) + * [`fn withType(type)`](#fn-specalertingalertmanagersauthorizationwithtype) + * [`obj spec.alerting.alertmanagers.authorization.credentials`](#obj-specalertingalertmanagersauthorizationcredentials) + * [`fn withKey(key)`](#fn-specalertingalertmanagersauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagersauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagersauthorizationcredentialswithoptional) + * [`obj spec.alerting.alertmanagers.basicAuth`](#obj-specalertingalertmanagersbasicauth) + * [`obj spec.alerting.alertmanagers.basicAuth.password`](#obj-specalertingalertmanagersbasicauthpassword) + * [`fn withKey(key)`](#fn-specalertingalertmanagersbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagersbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagersbasicauthpasswordwithoptional) + * [`obj spec.alerting.alertmanagers.basicAuth.username`](#obj-specalertingalertmanagersbasicauthusername) + * [`fn withKey(key)`](#fn-specalertingalertmanagersbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagersbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagersbasicauthusernamewithoptional) + * [`obj spec.alerting.alertmanagers.relabelings`](#obj-specalertingalertmanagersrelabelings) + * [`fn withAction(action)`](#fn-specalertingalertmanagersrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specalertingalertmanagersrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specalertingalertmanagersrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specalertingalertmanagersrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specalertingalertmanagersrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specalertingalertmanagersrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specalertingalertmanagersrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specalertingalertmanagersrelabelingswithtargetlabel) + * [`obj spec.alerting.alertmanagers.sigv4`](#obj-specalertingalertmanagerssigv4) + * [`fn withProfile(profile)`](#fn-specalertingalertmanagerssigv4withprofile) + * [`fn withRegion(region)`](#fn-specalertingalertmanagerssigv4withregion) + * [`fn withRoleArn(roleArn)`](#fn-specalertingalertmanagerssigv4withrolearn) + * [`obj spec.alerting.alertmanagers.sigv4.accessKey`](#obj-specalertingalertmanagerssigv4accesskey) + * [`fn withKey(key)`](#fn-specalertingalertmanagerssigv4accesskeywithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagerssigv4accesskeywithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagerssigv4accesskeywithoptional) + * [`obj spec.alerting.alertmanagers.sigv4.secretKey`](#obj-specalertingalertmanagerssigv4secretkey) + * [`fn withKey(key)`](#fn-specalertingalertmanagerssigv4secretkeywithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagerssigv4secretkeywithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagerssigv4secretkeywithoptional) + * [`obj spec.alerting.alertmanagers.tlsConfig`](#obj-specalertingalertmanagerstlsconfig) + * [`fn withCaFile(caFile)`](#fn-specalertingalertmanagerstlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specalertingalertmanagerstlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specalertingalertmanagerstlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specalertingalertmanagerstlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specalertingalertmanagerstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specalertingalertmanagerstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specalertingalertmanagerstlsconfigwithservername) + * [`obj spec.alerting.alertmanagers.tlsConfig.ca`](#obj-specalertingalertmanagerstlsconfigca) + * [`obj spec.alerting.alertmanagers.tlsConfig.ca.configMap`](#obj-specalertingalertmanagerstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specalertingalertmanagerstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagerstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagerstlsconfigcaconfigmapwithoptional) + * [`obj spec.alerting.alertmanagers.tlsConfig.ca.secret`](#obj-specalertingalertmanagerstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specalertingalertmanagerstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagerstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagerstlsconfigcasecretwithoptional) + * [`obj spec.alerting.alertmanagers.tlsConfig.cert`](#obj-specalertingalertmanagerstlsconfigcert) + * [`obj spec.alerting.alertmanagers.tlsConfig.cert.configMap`](#obj-specalertingalertmanagerstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specalertingalertmanagerstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagerstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagerstlsconfigcertconfigmapwithoptional) + * [`obj spec.alerting.alertmanagers.tlsConfig.cert.secret`](#obj-specalertingalertmanagerstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specalertingalertmanagerstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagerstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagerstlsconfigcertsecretwithoptional) + * [`obj spec.alerting.alertmanagers.tlsConfig.keySecret`](#obj-specalertingalertmanagerstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specalertingalertmanagerstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specalertingalertmanagerstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specalertingalertmanagerstlsconfigkeysecretwithoptional) + * [`obj spec.apiserverConfig`](#obj-specapiserverconfig) + * [`fn withBearerToken(bearerToken)`](#fn-specapiserverconfigwithbearertoken) + * [`fn withBearerTokenFile(bearerTokenFile)`](#fn-specapiserverconfigwithbearertokenfile) + * [`fn withHost(host)`](#fn-specapiserverconfigwithhost) + * [`obj spec.apiserverConfig.authorization`](#obj-specapiserverconfigauthorization) + * [`fn withCredentialsFile(credentialsFile)`](#fn-specapiserverconfigauthorizationwithcredentialsfile) + * [`fn withType(type)`](#fn-specapiserverconfigauthorizationwithtype) + * [`obj spec.apiserverConfig.authorization.credentials`](#obj-specapiserverconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specapiserverconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specapiserverconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigauthorizationcredentialswithoptional) + * [`obj spec.apiserverConfig.basicAuth`](#obj-specapiserverconfigbasicauth) + * [`obj spec.apiserverConfig.basicAuth.password`](#obj-specapiserverconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specapiserverconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigbasicauthpasswordwithoptional) + * [`obj spec.apiserverConfig.basicAuth.username`](#obj-specapiserverconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specapiserverconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specapiserverconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigbasicauthusernamewithoptional) + * [`obj spec.apiserverConfig.tlsConfig`](#obj-specapiserverconfigtlsconfig) + * [`fn withCaFile(caFile)`](#fn-specapiserverconfigtlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specapiserverconfigtlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specapiserverconfigtlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specapiserverconfigtlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specapiserverconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specapiserverconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specapiserverconfigtlsconfigwithservername) + * [`obj spec.apiserverConfig.tlsConfig.ca`](#obj-specapiserverconfigtlsconfigca) + * [`obj spec.apiserverConfig.tlsConfig.ca.configMap`](#obj-specapiserverconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.apiserverConfig.tlsConfig.ca.secret`](#obj-specapiserverconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigcasecretwithoptional) + * [`obj spec.apiserverConfig.tlsConfig.cert`](#obj-specapiserverconfigtlsconfigcert) + * [`obj spec.apiserverConfig.tlsConfig.cert.configMap`](#obj-specapiserverconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.apiserverConfig.tlsConfig.cert.secret`](#obj-specapiserverconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigcertsecretwithoptional) + * [`obj spec.apiserverConfig.tlsConfig.keySecret`](#obj-specapiserverconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigkeysecretwithoptional) + * [`obj spec.arbitraryFSAccessThroughSMs`](#obj-specarbitraryfsaccessthroughsms) + * [`fn withDeny(deny)`](#fn-specarbitraryfsaccessthroughsmswithdeny) + * [`obj spec.containers`](#obj-speccontainers) + * [`fn withArgs(args)`](#fn-speccontainerswithargs) + * [`fn withArgsMixin(args)`](#fn-speccontainerswithargsmixin) + * [`fn withCommand(command)`](#fn-speccontainerswithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerswithcommandmixin) + * [`fn withEnv(env)`](#fn-speccontainerswithenv) + * [`fn withEnvFrom(envFrom)`](#fn-speccontainerswithenvfrom) + * [`fn withEnvFromMixin(envFrom)`](#fn-speccontainerswithenvfrommixin) + * [`fn withEnvMixin(env)`](#fn-speccontainerswithenvmixin) + * [`fn withImage(image)`](#fn-speccontainerswithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-speccontainerswithimagepullpolicy) + * [`fn withName(name)`](#fn-speccontainerswithname) + * [`fn withPorts(ports)`](#fn-speccontainerswithports) + * [`fn withPortsMixin(ports)`](#fn-speccontainerswithportsmixin) + * [`fn withResizePolicy(resizePolicy)`](#fn-speccontainerswithresizepolicy) + * [`fn withResizePolicyMixin(resizePolicy)`](#fn-speccontainerswithresizepolicymixin) + * [`fn withRestartPolicy(restartPolicy)`](#fn-speccontainerswithrestartpolicy) + * [`fn withStdin(stdin)`](#fn-speccontainerswithstdin) + * [`fn withStdinOnce(stdinOnce)`](#fn-speccontainerswithstdinonce) + * [`fn withTerminationMessagePath(terminationMessagePath)`](#fn-speccontainerswithterminationmessagepath) + * [`fn withTerminationMessagePolicy(terminationMessagePolicy)`](#fn-speccontainerswithterminationmessagepolicy) + * [`fn withTty(tty)`](#fn-speccontainerswithtty) + * [`fn withVolumeDevices(volumeDevices)`](#fn-speccontainerswithvolumedevices) + * [`fn withVolumeDevicesMixin(volumeDevices)`](#fn-speccontainerswithvolumedevicesmixin) + * [`fn withVolumeMounts(volumeMounts)`](#fn-speccontainerswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-speccontainerswithvolumemountsmixin) + * [`fn withWorkingDir(workingDir)`](#fn-speccontainerswithworkingdir) + * [`obj spec.containers.env`](#obj-speccontainersenv) + * [`fn withName(name)`](#fn-speccontainersenvwithname) + * [`fn withValue(value)`](#fn-speccontainersenvwithvalue) + * [`obj spec.containers.env.valueFrom`](#obj-speccontainersenvvaluefrom) + * [`obj spec.containers.env.valueFrom.configMapKeyRef`](#obj-speccontainersenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.containers.env.valueFrom.fieldRef`](#obj-speccontainersenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-speccontainersenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-speccontainersenvvaluefromfieldrefwithfieldpath) + * [`obj spec.containers.env.valueFrom.resourceFieldRef`](#obj-speccontainersenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-speccontainersenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-speccontainersenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-speccontainersenvvaluefromresourcefieldrefwithresource) + * [`obj spec.containers.env.valueFrom.secretKeyRef`](#obj-speccontainersenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-speccontainersenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-speccontainersenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.containers.envFrom`](#obj-speccontainersenvfrom) + * [`fn withPrefix(prefix)`](#fn-speccontainersenvfromwithprefix) + * [`obj spec.containers.envFrom.configMapRef`](#obj-speccontainersenvfromconfigmapref) + * [`fn withName(name)`](#fn-speccontainersenvfromconfigmaprefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvfromconfigmaprefwithoptional) + * [`obj spec.containers.envFrom.secretRef`](#obj-speccontainersenvfromsecretref) + * [`fn withName(name)`](#fn-speccontainersenvfromsecretrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvfromsecretrefwithoptional) + * [`obj spec.containers.lifecycle`](#obj-speccontainerslifecycle) + * [`obj spec.containers.lifecycle.postStart`](#obj-speccontainerslifecyclepoststart) + * [`obj spec.containers.lifecycle.postStart.exec`](#obj-speccontainerslifecyclepoststartexec) + * [`fn withCommand(command)`](#fn-speccontainerslifecyclepoststartexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslifecyclepoststartexecwithcommandmixin) + * [`obj spec.containers.lifecycle.postStart.httpGet`](#obj-speccontainerslifecyclepoststarthttpget) + * [`fn withHost(host)`](#fn-speccontainerslifecyclepoststarthttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslifecyclepoststarthttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslifecyclepoststarthttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslifecyclepoststarthttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslifecyclepoststarthttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslifecyclepoststarthttpgetwithscheme) + * [`obj spec.containers.lifecycle.postStart.httpGet.httpHeaders`](#obj-speccontainerslifecyclepoststarthttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslifecyclepoststarthttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslifecyclepoststarthttpgethttpheaderswithvalue) + * [`obj spec.containers.lifecycle.postStart.sleep`](#obj-speccontainerslifecyclepoststartsleep) + * [`fn withSeconds(seconds)`](#fn-speccontainerslifecyclepoststartsleepwithseconds) + * [`obj spec.containers.lifecycle.postStart.tcpSocket`](#obj-speccontainerslifecyclepoststarttcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslifecyclepoststarttcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslifecyclepoststarttcpsocketwithport) + * [`obj spec.containers.lifecycle.preStop`](#obj-speccontainerslifecycleprestop) + * [`obj spec.containers.lifecycle.preStop.exec`](#obj-speccontainerslifecycleprestopexec) + * [`fn withCommand(command)`](#fn-speccontainerslifecycleprestopexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslifecycleprestopexecwithcommandmixin) + * [`obj spec.containers.lifecycle.preStop.httpGet`](#obj-speccontainerslifecycleprestophttpget) + * [`fn withHost(host)`](#fn-speccontainerslifecycleprestophttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslifecycleprestophttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslifecycleprestophttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslifecycleprestophttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslifecycleprestophttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslifecycleprestophttpgetwithscheme) + * [`obj spec.containers.lifecycle.preStop.httpGet.httpHeaders`](#obj-speccontainerslifecycleprestophttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslifecycleprestophttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslifecycleprestophttpgethttpheaderswithvalue) + * [`obj spec.containers.lifecycle.preStop.sleep`](#obj-speccontainerslifecycleprestopsleep) + * [`fn withSeconds(seconds)`](#fn-speccontainerslifecycleprestopsleepwithseconds) + * [`obj spec.containers.lifecycle.preStop.tcpSocket`](#obj-speccontainerslifecycleprestoptcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslifecycleprestoptcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslifecycleprestoptcpsocketwithport) + * [`obj spec.containers.livenessProbe`](#obj-speccontainerslivenessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainerslivenessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainerslivenessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainerslivenessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainerslivenessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainerslivenessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainerslivenessprobewithtimeoutseconds) + * [`obj spec.containers.livenessProbe.exec`](#obj-speccontainerslivenessprobeexec) + * [`fn withCommand(command)`](#fn-speccontainerslivenessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslivenessprobeexecwithcommandmixin) + * [`obj spec.containers.livenessProbe.grpc`](#obj-speccontainerslivenessprobegrpc) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainerslivenessprobegrpcwithservice) + * [`obj spec.containers.livenessProbe.httpGet`](#obj-speccontainerslivenessprobehttpget) + * [`fn withHost(host)`](#fn-speccontainerslivenessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslivenessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslivenessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslivenessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslivenessprobehttpgetwithscheme) + * [`obj spec.containers.livenessProbe.httpGet.httpHeaders`](#obj-speccontainerslivenessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslivenessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslivenessprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.livenessProbe.tcpSocket`](#obj-speccontainerslivenessprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslivenessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobetcpsocketwithport) + * [`obj spec.containers.ports`](#obj-speccontainersports) + * [`fn withContainerPort(containerPort)`](#fn-speccontainersportswithcontainerport) + * [`fn withHostIP(hostIP)`](#fn-speccontainersportswithhostip) + * [`fn withHostPort(hostPort)`](#fn-speccontainersportswithhostport) + * [`fn withName(name)`](#fn-speccontainersportswithname) + * [`fn withProtocol(protocol)`](#fn-speccontainersportswithprotocol) + * [`obj spec.containers.readinessProbe`](#obj-speccontainersreadinessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainersreadinessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainersreadinessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainersreadinessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainersreadinessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainersreadinessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainersreadinessprobewithtimeoutseconds) + * [`obj spec.containers.readinessProbe.exec`](#obj-speccontainersreadinessprobeexec) + * [`fn withCommand(command)`](#fn-speccontainersreadinessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainersreadinessprobeexecwithcommandmixin) + * [`obj spec.containers.readinessProbe.grpc`](#obj-speccontainersreadinessprobegrpc) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainersreadinessprobegrpcwithservice) + * [`obj spec.containers.readinessProbe.httpGet`](#obj-speccontainersreadinessprobehttpget) + * [`fn withHost(host)`](#fn-speccontainersreadinessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainersreadinessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainersreadinessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainersreadinessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainersreadinessprobehttpgetwithscheme) + * [`obj spec.containers.readinessProbe.httpGet.httpHeaders`](#obj-speccontainersreadinessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainersreadinessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainersreadinessprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.readinessProbe.tcpSocket`](#obj-speccontainersreadinessprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainersreadinessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobetcpsocketwithport) + * [`obj spec.containers.resizePolicy`](#obj-speccontainersresizepolicy) + * [`fn withResourceName(resourceName)`](#fn-speccontainersresizepolicywithresourcename) + * [`fn withRestartPolicy(restartPolicy)`](#fn-speccontainersresizepolicywithrestartpolicy) + * [`obj spec.containers.resources`](#obj-speccontainersresources) + * [`fn withClaims(claims)`](#fn-speccontainersresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-speccontainersresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-speccontainersresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-speccontainersresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-speccontainersresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-speccontainersresourceswithrequestsmixin) + * [`obj spec.containers.resources.claims`](#obj-speccontainersresourcesclaims) + * [`fn withName(name)`](#fn-speccontainersresourcesclaimswithname) + * [`obj spec.containers.securityContext`](#obj-speccontainerssecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-speccontainerssecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-speccontainerssecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-speccontainerssecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-speccontainerssecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-speccontainerssecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-speccontainerssecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-speccontainerssecuritycontextwithrunasuser) + * [`obj spec.containers.securityContext.appArmorProfile`](#obj-speccontainerssecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-speccontainerssecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextapparmorprofilewithtype) + * [`obj spec.containers.securityContext.capabilities`](#obj-speccontainerssecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-speccontainerssecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-speccontainerssecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-speccontainerssecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-speccontainerssecuritycontextcapabilitieswithdropmixin) + * [`obj spec.containers.securityContext.seLinuxOptions`](#obj-speccontainerssecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-speccontainerssecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-speccontainerssecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-speccontainerssecuritycontextselinuxoptionswithuser) + * [`obj spec.containers.securityContext.seccompProfile`](#obj-speccontainerssecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-speccontainerssecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextseccompprofilewithtype) + * [`obj spec.containers.securityContext.windowsOptions`](#obj-speccontainerssecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-speccontainerssecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-speccontainerssecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-speccontainerssecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-speccontainerssecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.containers.startupProbe`](#obj-speccontainersstartupprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainersstartupprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainersstartupprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainersstartupprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainersstartupprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainersstartupprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainersstartupprobewithtimeoutseconds) + * [`obj spec.containers.startupProbe.exec`](#obj-speccontainersstartupprobeexec) + * [`fn withCommand(command)`](#fn-speccontainersstartupprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainersstartupprobeexecwithcommandmixin) + * [`obj spec.containers.startupProbe.grpc`](#obj-speccontainersstartupprobegrpc) + * [`fn withPort(port)`](#fn-speccontainersstartupprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainersstartupprobegrpcwithservice) + * [`obj spec.containers.startupProbe.httpGet`](#obj-speccontainersstartupprobehttpget) + * [`fn withHost(host)`](#fn-speccontainersstartupprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainersstartupprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainersstartupprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainersstartupprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainersstartupprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainersstartupprobehttpgetwithscheme) + * [`obj spec.containers.startupProbe.httpGet.httpHeaders`](#obj-speccontainersstartupprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainersstartupprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainersstartupprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.startupProbe.tcpSocket`](#obj-speccontainersstartupprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainersstartupprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainersstartupprobetcpsocketwithport) + * [`obj spec.containers.volumeDevices`](#obj-speccontainersvolumedevices) + * [`fn withDevicePath(devicePath)`](#fn-speccontainersvolumedeviceswithdevicepath) + * [`fn withName(name)`](#fn-speccontainersvolumedeviceswithname) + * [`obj spec.containers.volumeMounts`](#obj-speccontainersvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-speccontainersvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-speccontainersvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-speccontainersvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-speccontainersvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-speccontainersvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-speccontainersvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-speccontainersvolumemountswithsubpathexpr) + * [`obj spec.excludedFromEnforcement`](#obj-specexcludedfromenforcement) + * [`fn withGroup(group)`](#fn-specexcludedfromenforcementwithgroup) + * [`fn withName(name)`](#fn-specexcludedfromenforcementwithname) + * [`fn withNamespace(namespace)`](#fn-specexcludedfromenforcementwithnamespace) + * [`fn withResource(resource)`](#fn-specexcludedfromenforcementwithresource) + * [`obj spec.exemplars`](#obj-specexemplars) + * [`fn withMaxSize(maxSize)`](#fn-specexemplarswithmaxsize) + * [`obj spec.hostAliases`](#obj-spechostaliases) + * [`fn withHostnames(hostnames)`](#fn-spechostaliaseswithhostnames) + * [`fn withHostnamesMixin(hostnames)`](#fn-spechostaliaseswithhostnamesmixin) + * [`fn withIp(ip)`](#fn-spechostaliaseswithip) + * [`obj spec.imagePullSecrets`](#obj-specimagepullsecrets) + * [`fn withName(name)`](#fn-specimagepullsecretswithname) + * [`obj spec.initContainers`](#obj-specinitcontainers) + * [`fn withArgs(args)`](#fn-specinitcontainerswithargs) + * [`fn withArgsMixin(args)`](#fn-specinitcontainerswithargsmixin) + * [`fn withCommand(command)`](#fn-specinitcontainerswithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerswithcommandmixin) + * [`fn withEnv(env)`](#fn-specinitcontainerswithenv) + * [`fn withEnvFrom(envFrom)`](#fn-specinitcontainerswithenvfrom) + * [`fn withEnvFromMixin(envFrom)`](#fn-specinitcontainerswithenvfrommixin) + * [`fn withEnvMixin(env)`](#fn-specinitcontainerswithenvmixin) + * [`fn withImage(image)`](#fn-specinitcontainerswithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-specinitcontainerswithimagepullpolicy) + * [`fn withName(name)`](#fn-specinitcontainerswithname) + * [`fn withPorts(ports)`](#fn-specinitcontainerswithports) + * [`fn withPortsMixin(ports)`](#fn-specinitcontainerswithportsmixin) + * [`fn withResizePolicy(resizePolicy)`](#fn-specinitcontainerswithresizepolicy) + * [`fn withResizePolicyMixin(resizePolicy)`](#fn-specinitcontainerswithresizepolicymixin) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specinitcontainerswithrestartpolicy) + * [`fn withStdin(stdin)`](#fn-specinitcontainerswithstdin) + * [`fn withStdinOnce(stdinOnce)`](#fn-specinitcontainerswithstdinonce) + * [`fn withTerminationMessagePath(terminationMessagePath)`](#fn-specinitcontainerswithterminationmessagepath) + * [`fn withTerminationMessagePolicy(terminationMessagePolicy)`](#fn-specinitcontainerswithterminationmessagepolicy) + * [`fn withTty(tty)`](#fn-specinitcontainerswithtty) + * [`fn withVolumeDevices(volumeDevices)`](#fn-specinitcontainerswithvolumedevices) + * [`fn withVolumeDevicesMixin(volumeDevices)`](#fn-specinitcontainerswithvolumedevicesmixin) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specinitcontainerswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specinitcontainerswithvolumemountsmixin) + * [`fn withWorkingDir(workingDir)`](#fn-specinitcontainerswithworkingdir) + * [`obj spec.initContainers.env`](#obj-specinitcontainersenv) + * [`fn withName(name)`](#fn-specinitcontainersenvwithname) + * [`fn withValue(value)`](#fn-specinitcontainersenvwithvalue) + * [`obj spec.initContainers.env.valueFrom`](#obj-specinitcontainersenvvaluefrom) + * [`obj spec.initContainers.env.valueFrom.configMapKeyRef`](#obj-specinitcontainersenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.initContainers.env.valueFrom.fieldRef`](#obj-specinitcontainersenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specinitcontainersenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specinitcontainersenvvaluefromfieldrefwithfieldpath) + * [`obj spec.initContainers.env.valueFrom.resourceFieldRef`](#obj-specinitcontainersenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithresource) + * [`obj spec.initContainers.env.valueFrom.secretKeyRef`](#obj-specinitcontainersenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.initContainers.envFrom`](#obj-specinitcontainersenvfrom) + * [`fn withPrefix(prefix)`](#fn-specinitcontainersenvfromwithprefix) + * [`obj spec.initContainers.envFrom.configMapRef`](#obj-specinitcontainersenvfromconfigmapref) + * [`fn withName(name)`](#fn-specinitcontainersenvfromconfigmaprefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvfromconfigmaprefwithoptional) + * [`obj spec.initContainers.envFrom.secretRef`](#obj-specinitcontainersenvfromsecretref) + * [`fn withName(name)`](#fn-specinitcontainersenvfromsecretrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvfromsecretrefwithoptional) + * [`obj spec.initContainers.lifecycle`](#obj-specinitcontainerslifecycle) + * [`obj spec.initContainers.lifecycle.postStart`](#obj-specinitcontainerslifecyclepoststart) + * [`obj spec.initContainers.lifecycle.postStart.exec`](#obj-specinitcontainerslifecyclepoststartexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslifecyclepoststartexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslifecyclepoststartexecwithcommandmixin) + * [`obj spec.initContainers.lifecycle.postStart.httpGet`](#obj-specinitcontainerslifecyclepoststarthttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithscheme) + * [`obj spec.initContainers.lifecycle.postStart.httpGet.httpHeaders`](#obj-specinitcontainerslifecyclepoststarthttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslifecyclepoststarthttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslifecyclepoststarthttpgethttpheaderswithvalue) + * [`obj spec.initContainers.lifecycle.postStart.sleep`](#obj-specinitcontainerslifecyclepoststartsleep) + * [`fn withSeconds(seconds)`](#fn-specinitcontainerslifecyclepoststartsleepwithseconds) + * [`obj spec.initContainers.lifecycle.postStart.tcpSocket`](#obj-specinitcontainerslifecyclepoststarttcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslifecyclepoststarttcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslifecyclepoststarttcpsocketwithport) + * [`obj spec.initContainers.lifecycle.preStop`](#obj-specinitcontainerslifecycleprestop) + * [`obj spec.initContainers.lifecycle.preStop.exec`](#obj-specinitcontainerslifecycleprestopexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslifecycleprestopexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslifecycleprestopexecwithcommandmixin) + * [`obj spec.initContainers.lifecycle.preStop.httpGet`](#obj-specinitcontainerslifecycleprestophttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslifecycleprestophttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslifecycleprestophttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslifecycleprestophttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslifecycleprestophttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslifecycleprestophttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslifecycleprestophttpgetwithscheme) + * [`obj spec.initContainers.lifecycle.preStop.httpGet.httpHeaders`](#obj-specinitcontainerslifecycleprestophttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslifecycleprestophttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslifecycleprestophttpgethttpheaderswithvalue) + * [`obj spec.initContainers.lifecycle.preStop.sleep`](#obj-specinitcontainerslifecycleprestopsleep) + * [`fn withSeconds(seconds)`](#fn-specinitcontainerslifecycleprestopsleepwithseconds) + * [`obj spec.initContainers.lifecycle.preStop.tcpSocket`](#obj-specinitcontainerslifecycleprestoptcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslifecycleprestoptcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslifecycleprestoptcpsocketwithport) + * [`obj spec.initContainers.livenessProbe`](#obj-specinitcontainerslivenessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainerslivenessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainerslivenessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainerslivenessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainerslivenessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainerslivenessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainerslivenessprobewithtimeoutseconds) + * [`obj spec.initContainers.livenessProbe.exec`](#obj-specinitcontainerslivenessprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslivenessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslivenessprobeexecwithcommandmixin) + * [`obj spec.initContainers.livenessProbe.grpc`](#obj-specinitcontainerslivenessprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainerslivenessprobegrpcwithservice) + * [`obj spec.initContainers.livenessProbe.httpGet`](#obj-specinitcontainerslivenessprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslivenessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslivenessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslivenessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslivenessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslivenessprobehttpgetwithscheme) + * [`obj spec.initContainers.livenessProbe.httpGet.httpHeaders`](#obj-specinitcontainerslivenessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslivenessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslivenessprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.livenessProbe.tcpSocket`](#obj-specinitcontainerslivenessprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslivenessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobetcpsocketwithport) + * [`obj spec.initContainers.ports`](#obj-specinitcontainersports) + * [`fn withContainerPort(containerPort)`](#fn-specinitcontainersportswithcontainerport) + * [`fn withHostIP(hostIP)`](#fn-specinitcontainersportswithhostip) + * [`fn withHostPort(hostPort)`](#fn-specinitcontainersportswithhostport) + * [`fn withName(name)`](#fn-specinitcontainersportswithname) + * [`fn withProtocol(protocol)`](#fn-specinitcontainersportswithprotocol) + * [`obj spec.initContainers.readinessProbe`](#obj-specinitcontainersreadinessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainersreadinessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainersreadinessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainersreadinessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainersreadinessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainersreadinessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainersreadinessprobewithtimeoutseconds) + * [`obj spec.initContainers.readinessProbe.exec`](#obj-specinitcontainersreadinessprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainersreadinessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainersreadinessprobeexecwithcommandmixin) + * [`obj spec.initContainers.readinessProbe.grpc`](#obj-specinitcontainersreadinessprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainersreadinessprobegrpcwithservice) + * [`obj spec.initContainers.readinessProbe.httpGet`](#obj-specinitcontainersreadinessprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainersreadinessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainersreadinessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainersreadinessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainersreadinessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainersreadinessprobehttpgetwithscheme) + * [`obj spec.initContainers.readinessProbe.httpGet.httpHeaders`](#obj-specinitcontainersreadinessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainersreadinessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainersreadinessprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.readinessProbe.tcpSocket`](#obj-specinitcontainersreadinessprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainersreadinessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobetcpsocketwithport) + * [`obj spec.initContainers.resizePolicy`](#obj-specinitcontainersresizepolicy) + * [`fn withResourceName(resourceName)`](#fn-specinitcontainersresizepolicywithresourcename) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specinitcontainersresizepolicywithrestartpolicy) + * [`obj spec.initContainers.resources`](#obj-specinitcontainersresources) + * [`fn withClaims(claims)`](#fn-specinitcontainersresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specinitcontainersresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specinitcontainersresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specinitcontainersresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specinitcontainersresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specinitcontainersresourceswithrequestsmixin) + * [`obj spec.initContainers.resources.claims`](#obj-specinitcontainersresourcesclaims) + * [`fn withName(name)`](#fn-specinitcontainersresourcesclaimswithname) + * [`obj spec.initContainers.securityContext`](#obj-specinitcontainerssecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-specinitcontainerssecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-specinitcontainerssecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-specinitcontainerssecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-specinitcontainerssecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specinitcontainerssecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specinitcontainerssecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specinitcontainerssecuritycontextwithrunasuser) + * [`obj spec.initContainers.securityContext.appArmorProfile`](#obj-specinitcontainerssecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specinitcontainerssecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextapparmorprofilewithtype) + * [`obj spec.initContainers.securityContext.capabilities`](#obj-specinitcontainerssecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-specinitcontainerssecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-specinitcontainerssecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-specinitcontainerssecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-specinitcontainerssecuritycontextcapabilitieswithdropmixin) + * [`obj spec.initContainers.securityContext.seLinuxOptions`](#obj-specinitcontainerssecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithuser) + * [`obj spec.initContainers.securityContext.seccompProfile`](#obj-specinitcontainerssecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specinitcontainerssecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextseccompprofilewithtype) + * [`obj spec.initContainers.securityContext.windowsOptions`](#obj-specinitcontainerssecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.initContainers.startupProbe`](#obj-specinitcontainersstartupprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainersstartupprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainersstartupprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainersstartupprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainersstartupprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainersstartupprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainersstartupprobewithtimeoutseconds) + * [`obj spec.initContainers.startupProbe.exec`](#obj-specinitcontainersstartupprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainersstartupprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainersstartupprobeexecwithcommandmixin) + * [`obj spec.initContainers.startupProbe.grpc`](#obj-specinitcontainersstartupprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainersstartupprobegrpcwithservice) + * [`obj spec.initContainers.startupProbe.httpGet`](#obj-specinitcontainersstartupprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainersstartupprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainersstartupprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainersstartupprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainersstartupprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainersstartupprobehttpgetwithscheme) + * [`obj spec.initContainers.startupProbe.httpGet.httpHeaders`](#obj-specinitcontainersstartupprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainersstartupprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainersstartupprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.startupProbe.tcpSocket`](#obj-specinitcontainersstartupprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainersstartupprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobetcpsocketwithport) + * [`obj spec.initContainers.volumeDevices`](#obj-specinitcontainersvolumedevices) + * [`fn withDevicePath(devicePath)`](#fn-specinitcontainersvolumedeviceswithdevicepath) + * [`fn withName(name)`](#fn-specinitcontainersvolumedeviceswithname) + * [`obj spec.initContainers.volumeMounts`](#obj-specinitcontainersvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specinitcontainersvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specinitcontainersvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specinitcontainersvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specinitcontainersvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-specinitcontainersvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-specinitcontainersvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specinitcontainersvolumemountswithsubpathexpr) + * [`obj spec.persistentVolumeClaimRetentionPolicy`](#obj-specpersistentvolumeclaimretentionpolicy) + * [`fn withWhenDeleted(whenDeleted)`](#fn-specpersistentvolumeclaimretentionpolicywithwhendeleted) + * [`fn withWhenScaled(whenScaled)`](#fn-specpersistentvolumeclaimretentionpolicywithwhenscaled) + * [`obj spec.podMetadata`](#obj-specpodmetadata) + * [`fn withAnnotations(annotations)`](#fn-specpodmetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specpodmetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specpodmetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specpodmetadatawithlabelsmixin) + * [`fn withName(name)`](#fn-specpodmetadatawithname) + * [`obj spec.podMonitorNamespaceSelector`](#obj-specpodmonitornamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specpodmonitornamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specpodmonitornamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specpodmonitornamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specpodmonitornamespaceselectorwithmatchlabelsmixin) + * [`obj spec.podMonitorNamespaceSelector.matchExpressions`](#obj-specpodmonitornamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specpodmonitornamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specpodmonitornamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specpodmonitornamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specpodmonitornamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.podMonitorSelector`](#obj-specpodmonitorselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specpodmonitorselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specpodmonitorselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specpodmonitorselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specpodmonitorselectorwithmatchlabelsmixin) + * [`obj spec.podMonitorSelector.matchExpressions`](#obj-specpodmonitorselectormatchexpressions) + * [`fn withKey(key)`](#fn-specpodmonitorselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specpodmonitorselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specpodmonitorselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specpodmonitorselectormatchexpressionswithvaluesmixin) + * [`obj spec.probeNamespaceSelector`](#obj-specprobenamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specprobenamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specprobenamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specprobenamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specprobenamespaceselectorwithmatchlabelsmixin) + * [`obj spec.probeNamespaceSelector.matchExpressions`](#obj-specprobenamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specprobenamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specprobenamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specprobenamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specprobenamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.probeSelector`](#obj-specprobeselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specprobeselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specprobeselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specprobeselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specprobeselectorwithmatchlabelsmixin) + * [`obj spec.probeSelector.matchExpressions`](#obj-specprobeselectormatchexpressions) + * [`fn withKey(key)`](#fn-specprobeselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specprobeselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specprobeselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specprobeselectormatchexpressionswithvaluesmixin) + * [`obj spec.prometheusRulesExcludedFromEnforce`](#obj-specprometheusrulesexcludedfromenforce) + * [`fn withRuleName(ruleName)`](#fn-specprometheusrulesexcludedfromenforcewithrulename) + * [`fn withRuleNamespace(ruleNamespace)`](#fn-specprometheusrulesexcludedfromenforcewithrulenamespace) + * [`obj spec.query`](#obj-specquery) + * [`fn withLookbackDelta(lookbackDelta)`](#fn-specquerywithlookbackdelta) + * [`fn withMaxConcurrency(maxConcurrency)`](#fn-specquerywithmaxconcurrency) + * [`fn withMaxSamples(maxSamples)`](#fn-specquerywithmaxsamples) + * [`fn withTimeout(timeout)`](#fn-specquerywithtimeout) + * [`obj spec.remoteRead`](#obj-specremoteread) + * [`fn withBearerToken(bearerToken)`](#fn-specremotereadwithbearertoken) + * [`fn withBearerTokenFile(bearerTokenFile)`](#fn-specremotereadwithbearertokenfile) + * [`fn withFilterExternalLabels(filterExternalLabels)`](#fn-specremotereadwithfilterexternallabels) + * [`fn withFollowRedirects(followRedirects)`](#fn-specremotereadwithfollowredirects) + * [`fn withHeaders(headers)`](#fn-specremotereadwithheaders) + * [`fn withHeadersMixin(headers)`](#fn-specremotereadwithheadersmixin) + * [`fn withName(name)`](#fn-specremotereadwithname) + * [`fn withNoProxy(noProxy)`](#fn-specremotereadwithnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specremotereadwithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specremotereadwithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specremotereadwithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specremotereadwithproxyurl) + * [`fn withReadRecent(readRecent)`](#fn-specremotereadwithreadrecent) + * [`fn withRemoteTimeout(remoteTimeout)`](#fn-specremotereadwithremotetimeout) + * [`fn withRequiredMatchers(requiredMatchers)`](#fn-specremotereadwithrequiredmatchers) + * [`fn withRequiredMatchersMixin(requiredMatchers)`](#fn-specremotereadwithrequiredmatchersmixin) + * [`fn withUrl(url)`](#fn-specremotereadwithurl) + * [`obj spec.remoteRead.authorization`](#obj-specremotereadauthorization) + * [`fn withCredentialsFile(credentialsFile)`](#fn-specremotereadauthorizationwithcredentialsfile) + * [`fn withType(type)`](#fn-specremotereadauthorizationwithtype) + * [`obj spec.remoteRead.authorization.credentials`](#obj-specremotereadauthorizationcredentials) + * [`fn withKey(key)`](#fn-specremotereadauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specremotereadauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specremotereadauthorizationcredentialswithoptional) + * [`obj spec.remoteRead.basicAuth`](#obj-specremotereadbasicauth) + * [`obj spec.remoteRead.basicAuth.password`](#obj-specremotereadbasicauthpassword) + * [`fn withKey(key)`](#fn-specremotereadbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specremotereadbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specremotereadbasicauthpasswordwithoptional) + * [`obj spec.remoteRead.basicAuth.username`](#obj-specremotereadbasicauthusername) + * [`fn withKey(key)`](#fn-specremotereadbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specremotereadbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specremotereadbasicauthusernamewithoptional) + * [`obj spec.remoteRead.oauth2`](#obj-specremotereadoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specremotereadoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specremotereadoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specremotereadoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specremotereadoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specremotereadoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specremotereadoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specremotereadoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specremotereadoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specremotereadoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specremotereadoauth2withtokenurl) + * [`obj spec.remoteRead.oauth2.clientId`](#obj-specremotereadoauth2clientid) + * [`obj spec.remoteRead.oauth2.clientId.configMap`](#obj-specremotereadoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specremotereadoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotereadoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotereadoauth2clientidconfigmapwithoptional) + * [`obj spec.remoteRead.oauth2.clientId.secret`](#obj-specremotereadoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specremotereadoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specremotereadoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotereadoauth2clientidsecretwithoptional) + * [`obj spec.remoteRead.oauth2.clientSecret`](#obj-specremotereadoauth2clientsecret) + * [`fn withKey(key)`](#fn-specremotereadoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specremotereadoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotereadoauth2clientsecretwithoptional) + * [`obj spec.remoteRead.oauth2.tlsConfig`](#obj-specremotereadoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specremotereadoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specremotereadoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specremotereadoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specremotereadoauth2tlsconfigwithservername) + * [`obj spec.remoteRead.oauth2.tlsConfig.ca`](#obj-specremotereadoauth2tlsconfigca) + * [`obj spec.remoteRead.oauth2.tlsConfig.ca.configMap`](#obj-specremotereadoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specremotereadoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotereadoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotereadoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.remoteRead.oauth2.tlsConfig.ca.secret`](#obj-specremotereadoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specremotereadoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specremotereadoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specremotereadoauth2tlsconfigcasecretwithoptional) + * [`obj spec.remoteRead.oauth2.tlsConfig.cert`](#obj-specremotereadoauth2tlsconfigcert) + * [`obj spec.remoteRead.oauth2.tlsConfig.cert.configMap`](#obj-specremotereadoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specremotereadoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotereadoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotereadoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.remoteRead.oauth2.tlsConfig.cert.secret`](#obj-specremotereadoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specremotereadoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specremotereadoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotereadoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.remoteRead.oauth2.tlsConfig.keySecret`](#obj-specremotereadoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specremotereadoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specremotereadoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specremotereadoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.remoteRead.tlsConfig`](#obj-specremotereadtlsconfig) + * [`fn withCaFile(caFile)`](#fn-specremotereadtlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specremotereadtlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specremotereadtlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specremotereadtlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specremotereadtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specremotereadtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specremotereadtlsconfigwithservername) + * [`obj spec.remoteRead.tlsConfig.ca`](#obj-specremotereadtlsconfigca) + * [`obj spec.remoteRead.tlsConfig.ca.configMap`](#obj-specremotereadtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specremotereadtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotereadtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotereadtlsconfigcaconfigmapwithoptional) + * [`obj spec.remoteRead.tlsConfig.ca.secret`](#obj-specremotereadtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specremotereadtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specremotereadtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specremotereadtlsconfigcasecretwithoptional) + * [`obj spec.remoteRead.tlsConfig.cert`](#obj-specremotereadtlsconfigcert) + * [`obj spec.remoteRead.tlsConfig.cert.configMap`](#obj-specremotereadtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specremotereadtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotereadtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotereadtlsconfigcertconfigmapwithoptional) + * [`obj spec.remoteRead.tlsConfig.cert.secret`](#obj-specremotereadtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specremotereadtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specremotereadtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotereadtlsconfigcertsecretwithoptional) + * [`obj spec.remoteRead.tlsConfig.keySecret`](#obj-specremotereadtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specremotereadtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specremotereadtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specremotereadtlsconfigkeysecretwithoptional) + * [`obj spec.remoteWrite`](#obj-specremotewrite) + * [`fn withBearerToken(bearerToken)`](#fn-specremotewritewithbearertoken) + * [`fn withBearerTokenFile(bearerTokenFile)`](#fn-specremotewritewithbearertokenfile) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-specremotewritewithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-specremotewritewithfollowredirects) + * [`fn withHeaders(headers)`](#fn-specremotewritewithheaders) + * [`fn withHeadersMixin(headers)`](#fn-specremotewritewithheadersmixin) + * [`fn withName(name)`](#fn-specremotewritewithname) + * [`fn withNoProxy(noProxy)`](#fn-specremotewritewithnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specremotewritewithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specremotewritewithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specremotewritewithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specremotewritewithproxyurl) + * [`fn withRemoteTimeout(remoteTimeout)`](#fn-specremotewritewithremotetimeout) + * [`fn withSendExemplars(sendExemplars)`](#fn-specremotewritewithsendexemplars) + * [`fn withSendNativeHistograms(sendNativeHistograms)`](#fn-specremotewritewithsendnativehistograms) + * [`fn withUrl(url)`](#fn-specremotewritewithurl) + * [`fn withWriteRelabelConfigs(writeRelabelConfigs)`](#fn-specremotewritewithwriterelabelconfigs) + * [`fn withWriteRelabelConfigsMixin(writeRelabelConfigs)`](#fn-specremotewritewithwriterelabelconfigsmixin) + * [`obj spec.remoteWrite.authorization`](#obj-specremotewriteauthorization) + * [`fn withCredentialsFile(credentialsFile)`](#fn-specremotewriteauthorizationwithcredentialsfile) + * [`fn withType(type)`](#fn-specremotewriteauthorizationwithtype) + * [`obj spec.remoteWrite.authorization.credentials`](#obj-specremotewriteauthorizationcredentials) + * [`fn withKey(key)`](#fn-specremotewriteauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specremotewriteauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specremotewriteauthorizationcredentialswithoptional) + * [`obj spec.remoteWrite.azureAd`](#obj-specremotewriteazuread) + * [`fn withCloud(cloud)`](#fn-specremotewriteazureadwithcloud) + * [`obj spec.remoteWrite.azureAd.managedIdentity`](#obj-specremotewriteazureadmanagedidentity) + * [`fn withClientId(clientId)`](#fn-specremotewriteazureadmanagedidentitywithclientid) + * [`obj spec.remoteWrite.azureAd.oauth`](#obj-specremotewriteazureadoauth) + * [`fn withClientId(clientId)`](#fn-specremotewriteazureadoauthwithclientid) + * [`fn withTenantId(tenantId)`](#fn-specremotewriteazureadoauthwithtenantid) + * [`obj spec.remoteWrite.azureAd.oauth.clientSecret`](#obj-specremotewriteazureadoauthclientsecret) + * [`fn withKey(key)`](#fn-specremotewriteazureadoauthclientsecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteazureadoauthclientsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteazureadoauthclientsecretwithoptional) + * [`obj spec.remoteWrite.azureAd.sdk`](#obj-specremotewriteazureadsdk) + * [`fn withTenantId(tenantId)`](#fn-specremotewriteazureadsdkwithtenantid) + * [`obj spec.remoteWrite.basicAuth`](#obj-specremotewritebasicauth) + * [`obj spec.remoteWrite.basicAuth.password`](#obj-specremotewritebasicauthpassword) + * [`fn withKey(key)`](#fn-specremotewritebasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specremotewritebasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specremotewritebasicauthpasswordwithoptional) + * [`obj spec.remoteWrite.basicAuth.username`](#obj-specremotewritebasicauthusername) + * [`fn withKey(key)`](#fn-specremotewritebasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specremotewritebasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specremotewritebasicauthusernamewithoptional) + * [`obj spec.remoteWrite.metadataConfig`](#obj-specremotewritemetadataconfig) + * [`fn withSend(send)`](#fn-specremotewritemetadataconfigwithsend) + * [`fn withSendInterval(sendInterval)`](#fn-specremotewritemetadataconfigwithsendinterval) + * [`obj spec.remoteWrite.oauth2`](#obj-specremotewriteoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specremotewriteoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specremotewriteoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specremotewriteoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specremotewriteoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specremotewriteoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specremotewriteoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specremotewriteoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specremotewriteoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specremotewriteoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specremotewriteoauth2withtokenurl) + * [`obj spec.remoteWrite.oauth2.clientId`](#obj-specremotewriteoauth2clientid) + * [`obj spec.remoteWrite.oauth2.clientId.configMap`](#obj-specremotewriteoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specremotewriteoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2clientidconfigmapwithoptional) + * [`obj spec.remoteWrite.oauth2.clientId.secret`](#obj-specremotewriteoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2clientidsecretwithoptional) + * [`obj spec.remoteWrite.oauth2.clientSecret`](#obj-specremotewriteoauth2clientsecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2clientsecretwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig`](#obj-specremotewriteoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specremotewriteoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specremotewriteoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specremotewriteoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specremotewriteoauth2tlsconfigwithservername) + * [`obj spec.remoteWrite.oauth2.tlsConfig.ca`](#obj-specremotewriteoauth2tlsconfigca) + * [`obj spec.remoteWrite.oauth2.tlsConfig.ca.configMap`](#obj-specremotewriteoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig.ca.secret`](#obj-specremotewriteoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigcasecretwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig.cert`](#obj-specremotewriteoauth2tlsconfigcert) + * [`obj spec.remoteWrite.oauth2.tlsConfig.cert.configMap`](#obj-specremotewriteoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig.cert.secret`](#obj-specremotewriteoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig.keySecret`](#obj-specremotewriteoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.remoteWrite.queueConfig`](#obj-specremotewritequeueconfig) + * [`fn withBatchSendDeadline(batchSendDeadline)`](#fn-specremotewritequeueconfigwithbatchsenddeadline) + * [`fn withCapacity(capacity)`](#fn-specremotewritequeueconfigwithcapacity) + * [`fn withMaxBackoff(maxBackoff)`](#fn-specremotewritequeueconfigwithmaxbackoff) + * [`fn withMaxRetries(maxRetries)`](#fn-specremotewritequeueconfigwithmaxretries) + * [`fn withMaxSamplesPerSend(maxSamplesPerSend)`](#fn-specremotewritequeueconfigwithmaxsamplespersend) + * [`fn withMaxShards(maxShards)`](#fn-specremotewritequeueconfigwithmaxshards) + * [`fn withMinBackoff(minBackoff)`](#fn-specremotewritequeueconfigwithminbackoff) + * [`fn withMinShards(minShards)`](#fn-specremotewritequeueconfigwithminshards) + * [`fn withRetryOnRateLimit(retryOnRateLimit)`](#fn-specremotewritequeueconfigwithretryonratelimit) + * [`fn withSampleAgeLimit(sampleAgeLimit)`](#fn-specremotewritequeueconfigwithsampleagelimit) + * [`obj spec.remoteWrite.sigv4`](#obj-specremotewritesigv4) + * [`fn withProfile(profile)`](#fn-specremotewritesigv4withprofile) + * [`fn withRegion(region)`](#fn-specremotewritesigv4withregion) + * [`fn withRoleArn(roleArn)`](#fn-specremotewritesigv4withrolearn) + * [`obj spec.remoteWrite.sigv4.accessKey`](#obj-specremotewritesigv4accesskey) + * [`fn withKey(key)`](#fn-specremotewritesigv4accesskeywithkey) + * [`fn withName(name)`](#fn-specremotewritesigv4accesskeywithname) + * [`fn withOptional(optional)`](#fn-specremotewritesigv4accesskeywithoptional) + * [`obj spec.remoteWrite.sigv4.secretKey`](#obj-specremotewritesigv4secretkey) + * [`fn withKey(key)`](#fn-specremotewritesigv4secretkeywithkey) + * [`fn withName(name)`](#fn-specremotewritesigv4secretkeywithname) + * [`fn withOptional(optional)`](#fn-specremotewritesigv4secretkeywithoptional) + * [`obj spec.remoteWrite.tlsConfig`](#obj-specremotewritetlsconfig) + * [`fn withCaFile(caFile)`](#fn-specremotewritetlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specremotewritetlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specremotewritetlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specremotewritetlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specremotewritetlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specremotewritetlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specremotewritetlsconfigwithservername) + * [`obj spec.remoteWrite.tlsConfig.ca`](#obj-specremotewritetlsconfigca) + * [`obj spec.remoteWrite.tlsConfig.ca.configMap`](#obj-specremotewritetlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigcaconfigmapwithoptional) + * [`obj spec.remoteWrite.tlsConfig.ca.secret`](#obj-specremotewritetlsconfigcasecret) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigcasecretwithoptional) + * [`obj spec.remoteWrite.tlsConfig.cert`](#obj-specremotewritetlsconfigcert) + * [`obj spec.remoteWrite.tlsConfig.cert.configMap`](#obj-specremotewritetlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigcertconfigmapwithoptional) + * [`obj spec.remoteWrite.tlsConfig.cert.secret`](#obj-specremotewritetlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigcertsecretwithoptional) + * [`obj spec.remoteWrite.tlsConfig.keySecret`](#obj-specremotewritetlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigkeysecretwithoptional) + * [`obj spec.remoteWrite.writeRelabelConfigs`](#obj-specremotewritewriterelabelconfigs) + * [`fn withAction(action)`](#fn-specremotewritewriterelabelconfigswithaction) + * [`fn withModulus(modulus)`](#fn-specremotewritewriterelabelconfigswithmodulus) + * [`fn withRegex(regex)`](#fn-specremotewritewriterelabelconfigswithregex) + * [`fn withReplacement(replacement)`](#fn-specremotewritewriterelabelconfigswithreplacement) + * [`fn withSeparator(separator)`](#fn-specremotewritewriterelabelconfigswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specremotewritewriterelabelconfigswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specremotewritewriterelabelconfigswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specremotewritewriterelabelconfigswithtargetlabel) + * [`obj spec.resources`](#obj-specresources) + * [`fn withClaims(claims)`](#fn-specresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specresourceswithrequestsmixin) + * [`obj spec.resources.claims`](#obj-specresourcesclaims) + * [`fn withName(name)`](#fn-specresourcesclaimswithname) + * [`obj spec.ruleNamespaceSelector`](#obj-specrulenamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specrulenamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specrulenamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specrulenamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specrulenamespaceselectorwithmatchlabelsmixin) + * [`obj spec.ruleNamespaceSelector.matchExpressions`](#obj-specrulenamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specrulenamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specrulenamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specrulenamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specrulenamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.ruleSelector`](#obj-specruleselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specruleselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specruleselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specruleselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specruleselectorwithmatchlabelsmixin) + * [`obj spec.ruleSelector.matchExpressions`](#obj-specruleselectormatchexpressions) + * [`fn withKey(key)`](#fn-specruleselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specruleselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specruleselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specruleselectormatchexpressionswithvaluesmixin) + * [`obj spec.rules`](#obj-specrules) + * [`obj spec.rules.alert`](#obj-specrulesalert) + * [`fn withForGracePeriod(forGracePeriod)`](#fn-specrulesalertwithforgraceperiod) + * [`fn withForOutageTolerance(forOutageTolerance)`](#fn-specrulesalertwithforoutagetolerance) + * [`fn withResendDelay(resendDelay)`](#fn-specrulesalertwithresenddelay) + * [`obj spec.scrapeClasses`](#obj-specscrapeclasses) + * [`fn withDefault(default)`](#fn-specscrapeclasseswithdefault) + * [`fn withMetricRelabelings(metricRelabelings)`](#fn-specscrapeclasseswithmetricrelabelings) + * [`fn withMetricRelabelingsMixin(metricRelabelings)`](#fn-specscrapeclasseswithmetricrelabelingsmixin) + * [`fn withName(name)`](#fn-specscrapeclasseswithname) + * [`fn withRelabelings(relabelings)`](#fn-specscrapeclasseswithrelabelings) + * [`fn withRelabelingsMixin(relabelings)`](#fn-specscrapeclasseswithrelabelingsmixin) + * [`obj spec.scrapeClasses.attachMetadata`](#obj-specscrapeclassesattachmetadata) + * [`fn withNode(node)`](#fn-specscrapeclassesattachmetadatawithnode) + * [`obj spec.scrapeClasses.metricRelabelings`](#obj-specscrapeclassesmetricrelabelings) + * [`fn withAction(action)`](#fn-specscrapeclassesmetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specscrapeclassesmetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specscrapeclassesmetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specscrapeclassesmetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specscrapeclassesmetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specscrapeclassesmetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specscrapeclassesmetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specscrapeclassesmetricrelabelingswithtargetlabel) + * [`obj spec.scrapeClasses.relabelings`](#obj-specscrapeclassesrelabelings) + * [`fn withAction(action)`](#fn-specscrapeclassesrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specscrapeclassesrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specscrapeclassesrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specscrapeclassesrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specscrapeclassesrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specscrapeclassesrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specscrapeclassesrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specscrapeclassesrelabelingswithtargetlabel) + * [`obj spec.scrapeClasses.tlsConfig`](#obj-specscrapeclassestlsconfig) + * [`fn withCaFile(caFile)`](#fn-specscrapeclassestlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specscrapeclassestlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specscrapeclassestlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specscrapeclassestlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specscrapeclassestlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specscrapeclassestlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specscrapeclassestlsconfigwithservername) + * [`obj spec.scrapeClasses.tlsConfig.ca`](#obj-specscrapeclassestlsconfigca) + * [`obj spec.scrapeClasses.tlsConfig.ca.configMap`](#obj-specscrapeclassestlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigcaconfigmapwithoptional) + * [`obj spec.scrapeClasses.tlsConfig.ca.secret`](#obj-specscrapeclassestlsconfigcasecret) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigcasecretwithoptional) + * [`obj spec.scrapeClasses.tlsConfig.cert`](#obj-specscrapeclassestlsconfigcert) + * [`obj spec.scrapeClasses.tlsConfig.cert.configMap`](#obj-specscrapeclassestlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigcertconfigmapwithoptional) + * [`obj spec.scrapeClasses.tlsConfig.cert.secret`](#obj-specscrapeclassestlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigcertsecretwithoptional) + * [`obj spec.scrapeClasses.tlsConfig.keySecret`](#obj-specscrapeclassestlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigkeysecretwithoptional) + * [`obj spec.scrapeConfigNamespaceSelector`](#obj-specscrapeconfignamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specscrapeconfignamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specscrapeconfignamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specscrapeconfignamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specscrapeconfignamespaceselectorwithmatchlabelsmixin) + * [`obj spec.scrapeConfigNamespaceSelector.matchExpressions`](#obj-specscrapeconfignamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specscrapeconfignamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specscrapeconfignamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specscrapeconfignamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specscrapeconfignamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.scrapeConfigSelector`](#obj-specscrapeconfigselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specscrapeconfigselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specscrapeconfigselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specscrapeconfigselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specscrapeconfigselectorwithmatchlabelsmixin) + * [`obj spec.scrapeConfigSelector.matchExpressions`](#obj-specscrapeconfigselectormatchexpressions) + * [`fn withKey(key)`](#fn-specscrapeconfigselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specscrapeconfigselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specscrapeconfigselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specscrapeconfigselectormatchexpressionswithvaluesmixin) + * [`obj spec.securityContext`](#obj-specsecuritycontext) + * [`fn withFsGroup(fsGroup)`](#fn-specsecuritycontextwithfsgroup) + * [`fn withFsGroupChangePolicy(fsGroupChangePolicy)`](#fn-specsecuritycontextwithfsgroupchangepolicy) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specsecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specsecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specsecuritycontextwithrunasuser) + * [`fn withSupplementalGroups(supplementalGroups)`](#fn-specsecuritycontextwithsupplementalgroups) + * [`fn withSupplementalGroupsMixin(supplementalGroups)`](#fn-specsecuritycontextwithsupplementalgroupsmixin) + * [`fn withSysctls(sysctls)`](#fn-specsecuritycontextwithsysctls) + * [`fn withSysctlsMixin(sysctls)`](#fn-specsecuritycontextwithsysctlsmixin) + * [`obj spec.securityContext.appArmorProfile`](#obj-specsecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specsecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specsecuritycontextapparmorprofilewithtype) + * [`obj spec.securityContext.seLinuxOptions`](#obj-specsecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specsecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specsecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specsecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specsecuritycontextselinuxoptionswithuser) + * [`obj spec.securityContext.seccompProfile`](#obj-specsecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specsecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specsecuritycontextseccompprofilewithtype) + * [`obj spec.securityContext.sysctls`](#obj-specsecuritycontextsysctls) + * [`fn withName(name)`](#fn-specsecuritycontextsysctlswithname) + * [`fn withValue(value)`](#fn-specsecuritycontextsysctlswithvalue) + * [`obj spec.securityContext.windowsOptions`](#obj-specsecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specsecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specsecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specsecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specsecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.serviceMonitorNamespaceSelector`](#obj-specservicemonitornamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specservicemonitornamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specservicemonitornamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specservicemonitornamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specservicemonitornamespaceselectorwithmatchlabelsmixin) + * [`obj spec.serviceMonitorNamespaceSelector.matchExpressions`](#obj-specservicemonitornamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specservicemonitornamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specservicemonitornamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specservicemonitornamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specservicemonitornamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.serviceMonitorSelector`](#obj-specservicemonitorselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specservicemonitorselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specservicemonitorselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specservicemonitorselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specservicemonitorselectorwithmatchlabelsmixin) + * [`obj spec.serviceMonitorSelector.matchExpressions`](#obj-specservicemonitorselectormatchexpressions) + * [`fn withKey(key)`](#fn-specservicemonitorselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specservicemonitorselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specservicemonitorselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specservicemonitorselectormatchexpressionswithvaluesmixin) + * [`obj spec.storage`](#obj-specstorage) + * [`fn withDisableMountSubPath(disableMountSubPath)`](#fn-specstoragewithdisablemountsubpath) + * [`obj spec.storage.emptyDir`](#obj-specstorageemptydir) + * [`fn withMedium(medium)`](#fn-specstorageemptydirwithmedium) + * [`fn withSizeLimit(sizeLimit)`](#fn-specstorageemptydirwithsizelimit) + * [`obj spec.storage.ephemeral`](#obj-specstorageephemeral) + * [`obj spec.storage.ephemeral.volumeClaimTemplate`](#obj-specstorageephemeralvolumeclaimtemplate) + * [`fn withMetadata(metadata)`](#fn-specstorageephemeralvolumeclaimtemplatewithmetadata) + * [`fn withMetadataMixin(metadata)`](#fn-specstorageephemeralvolumeclaimtemplatewithmetadatamixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec`](#obj-specstorageephemeralvolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumename) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource`](#obj-specstorageephemeralvolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef`](#obj-specstorageephemeralvolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.resources`](#obj-specstorageephemeralvolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector`](#obj-specstorageephemeralvolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.storage.volumeClaimTemplate`](#obj-specstoragevolumeclaimtemplate) + * [`fn withApiVersion(apiVersion)`](#fn-specstoragevolumeclaimtemplatewithapiversion) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatewithkind) + * [`obj spec.storage.volumeClaimTemplate.metadata`](#obj-specstoragevolumeclaimtemplatemetadata) + * [`fn withAnnotations(annotations)`](#fn-specstoragevolumeclaimtemplatemetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specstoragevolumeclaimtemplatemetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specstoragevolumeclaimtemplatemetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specstoragevolumeclaimtemplatemetadatawithlabelsmixin) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatemetadatawithname) + * [`obj spec.storage.volumeClaimTemplate.spec`](#obj-specstoragevolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specstoragevolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specstoragevolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specstoragevolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specstoragevolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specstoragevolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specstoragevolumeclaimtemplatespecwithvolumename) + * [`obj spec.storage.volumeClaimTemplate.spec.dataSource`](#obj-specstoragevolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.storage.volumeClaimTemplate.spec.dataSourceRef`](#obj-specstoragevolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.storage.volumeClaimTemplate.spec.resources`](#obj-specstoragevolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specstoragevolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specstoragevolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specstoragevolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specstoragevolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.storage.volumeClaimTemplate.spec.selector`](#obj-specstoragevolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.storage.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specstoragevolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.thanos`](#obj-specthanos) + * [`fn withAdditionalArgs(additionalArgs)`](#fn-specthanoswithadditionalargs) + * [`fn withAdditionalArgsMixin(additionalArgs)`](#fn-specthanoswithadditionalargsmixin) + * [`fn withBaseImage(baseImage)`](#fn-specthanoswithbaseimage) + * [`fn withBlockSize(blockSize)`](#fn-specthanoswithblocksize) + * [`fn withGetConfigInterval(getConfigInterval)`](#fn-specthanoswithgetconfiginterval) + * [`fn withGetConfigTimeout(getConfigTimeout)`](#fn-specthanoswithgetconfigtimeout) + * [`fn withGrpcListenLocal(grpcListenLocal)`](#fn-specthanoswithgrpclistenlocal) + * [`fn withHttpListenLocal(httpListenLocal)`](#fn-specthanoswithhttplistenlocal) + * [`fn withImage(image)`](#fn-specthanoswithimage) + * [`fn withListenLocal(listenLocal)`](#fn-specthanoswithlistenlocal) + * [`fn withLogFormat(logFormat)`](#fn-specthanoswithlogformat) + * [`fn withLogLevel(logLevel)`](#fn-specthanoswithloglevel) + * [`fn withMinTime(minTime)`](#fn-specthanoswithmintime) + * [`fn withObjectStorageConfigFile(objectStorageConfigFile)`](#fn-specthanoswithobjectstorageconfigfile) + * [`fn withReadyTimeout(readyTimeout)`](#fn-specthanoswithreadytimeout) + * [`fn withSha(sha)`](#fn-specthanoswithsha) + * [`fn withTag(tag)`](#fn-specthanoswithtag) + * [`fn withTracingConfigFile(tracingConfigFile)`](#fn-specthanoswithtracingconfigfile) + * [`fn withVersion(version)`](#fn-specthanoswithversion) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specthanoswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specthanoswithvolumemountsmixin) + * [`obj spec.thanos.additionalArgs`](#obj-specthanosadditionalargs) + * [`fn withName(name)`](#fn-specthanosadditionalargswithname) + * [`fn withValue(value)`](#fn-specthanosadditionalargswithvalue) + * [`obj spec.thanos.grpcServerTlsConfig`](#obj-specthanosgrpcservertlsconfig) + * [`fn withCaFile(caFile)`](#fn-specthanosgrpcservertlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specthanosgrpcservertlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specthanosgrpcservertlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specthanosgrpcservertlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specthanosgrpcservertlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specthanosgrpcservertlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specthanosgrpcservertlsconfigwithservername) + * [`obj spec.thanos.grpcServerTlsConfig.ca`](#obj-specthanosgrpcservertlsconfigca) + * [`obj spec.thanos.grpcServerTlsConfig.ca.configMap`](#obj-specthanosgrpcservertlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specthanosgrpcservertlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specthanosgrpcservertlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specthanosgrpcservertlsconfigcaconfigmapwithoptional) + * [`obj spec.thanos.grpcServerTlsConfig.ca.secret`](#obj-specthanosgrpcservertlsconfigcasecret) + * [`fn withKey(key)`](#fn-specthanosgrpcservertlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specthanosgrpcservertlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specthanosgrpcservertlsconfigcasecretwithoptional) + * [`obj spec.thanos.grpcServerTlsConfig.cert`](#obj-specthanosgrpcservertlsconfigcert) + * [`obj spec.thanos.grpcServerTlsConfig.cert.configMap`](#obj-specthanosgrpcservertlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specthanosgrpcservertlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specthanosgrpcservertlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specthanosgrpcservertlsconfigcertconfigmapwithoptional) + * [`obj spec.thanos.grpcServerTlsConfig.cert.secret`](#obj-specthanosgrpcservertlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specthanosgrpcservertlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specthanosgrpcservertlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specthanosgrpcservertlsconfigcertsecretwithoptional) + * [`obj spec.thanos.grpcServerTlsConfig.keySecret`](#obj-specthanosgrpcservertlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specthanosgrpcservertlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specthanosgrpcservertlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specthanosgrpcservertlsconfigkeysecretwithoptional) + * [`obj spec.thanos.objectStorageConfig`](#obj-specthanosobjectstorageconfig) + * [`fn withKey(key)`](#fn-specthanosobjectstorageconfigwithkey) + * [`fn withName(name)`](#fn-specthanosobjectstorageconfigwithname) + * [`fn withOptional(optional)`](#fn-specthanosobjectstorageconfigwithoptional) + * [`obj spec.thanos.resources`](#obj-specthanosresources) + * [`fn withClaims(claims)`](#fn-specthanosresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specthanosresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specthanosresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specthanosresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specthanosresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specthanosresourceswithrequestsmixin) + * [`obj spec.thanos.resources.claims`](#obj-specthanosresourcesclaims) + * [`fn withName(name)`](#fn-specthanosresourcesclaimswithname) + * [`obj spec.thanos.tracingConfig`](#obj-specthanostracingconfig) + * [`fn withKey(key)`](#fn-specthanostracingconfigwithkey) + * [`fn withName(name)`](#fn-specthanostracingconfigwithname) + * [`fn withOptional(optional)`](#fn-specthanostracingconfigwithoptional) + * [`obj spec.thanos.volumeMounts`](#obj-specthanosvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specthanosvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specthanosvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specthanosvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specthanosvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-specthanosvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-specthanosvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specthanosvolumemountswithsubpathexpr) + * [`obj spec.tolerations`](#obj-spectolerations) + * [`fn withEffect(effect)`](#fn-spectolerationswitheffect) + * [`fn withKey(key)`](#fn-spectolerationswithkey) + * [`fn withOperator(operator)`](#fn-spectolerationswithoperator) + * [`fn withTolerationSeconds(tolerationSeconds)`](#fn-spectolerationswithtolerationseconds) + * [`fn withValue(value)`](#fn-spectolerationswithvalue) + * [`obj spec.topologySpreadConstraints`](#obj-spectopologyspreadconstraints) + * [`fn withAdditionalLabelSelectors(additionalLabelSelectors)`](#fn-spectopologyspreadconstraintswithadditionallabelselectors) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeysmixin) + * [`fn withMaxSkew(maxSkew)`](#fn-spectopologyspreadconstraintswithmaxskew) + * [`fn withMinDomains(minDomains)`](#fn-spectopologyspreadconstraintswithmindomains) + * [`fn withNodeAffinityPolicy(nodeAffinityPolicy)`](#fn-spectopologyspreadconstraintswithnodeaffinitypolicy) + * [`fn withNodeTaintsPolicy(nodeTaintsPolicy)`](#fn-spectopologyspreadconstraintswithnodetaintspolicy) + * [`fn withTopologyKey(topologyKey)`](#fn-spectopologyspreadconstraintswithtopologykey) + * [`fn withWhenUnsatisfiable(whenUnsatisfiable)`](#fn-spectopologyspreadconstraintswithwhenunsatisfiable) + * [`obj spec.topologySpreadConstraints.labelSelector`](#obj-spectopologyspreadconstraintslabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchlabelsmixin) + * [`obj spec.topologySpreadConstraints.labelSelector.matchExpressions`](#obj-spectopologyspreadconstraintslabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.tracingConfig`](#obj-spectracingconfig) + * [`fn withClientType(clientType)`](#fn-spectracingconfigwithclienttype) + * [`fn withCompression(compression)`](#fn-spectracingconfigwithcompression) + * [`fn withEndpoint(endpoint)`](#fn-spectracingconfigwithendpoint) + * [`fn withHeaders(headers)`](#fn-spectracingconfigwithheaders) + * [`fn withHeadersMixin(headers)`](#fn-spectracingconfigwithheadersmixin) + * [`fn withInsecure(insecure)`](#fn-spectracingconfigwithinsecure) + * [`fn withSamplingFraction(samplingFraction)`](#fn-spectracingconfigwithsamplingfraction) + * [`fn withTimeout(timeout)`](#fn-spectracingconfigwithtimeout) + * [`obj spec.tracingConfig.tlsConfig`](#obj-spectracingconfigtlsconfig) + * [`fn withCaFile(caFile)`](#fn-spectracingconfigtlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-spectracingconfigtlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-spectracingconfigtlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-spectracingconfigtlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-spectracingconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-spectracingconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-spectracingconfigtlsconfigwithservername) + * [`obj spec.tracingConfig.tlsConfig.ca`](#obj-spectracingconfigtlsconfigca) + * [`obj spec.tracingConfig.tlsConfig.ca.configMap`](#obj-spectracingconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.tracingConfig.tlsConfig.ca.secret`](#obj-spectracingconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigcasecretwithoptional) + * [`obj spec.tracingConfig.tlsConfig.cert`](#obj-spectracingconfigtlsconfigcert) + * [`obj spec.tracingConfig.tlsConfig.cert.configMap`](#obj-spectracingconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.tracingConfig.tlsConfig.cert.secret`](#obj-spectracingconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigcertsecretwithoptional) + * [`obj spec.tracingConfig.tlsConfig.keySecret`](#obj-spectracingconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigkeysecretwithoptional) + * [`obj spec.tsdb`](#obj-spectsdb) + * [`fn withOutOfOrderTimeWindow(outOfOrderTimeWindow)`](#fn-spectsdbwithoutofordertimewindow) + * [`obj spec.volumeMounts`](#obj-specvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-specvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-specvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specvolumemountswithsubpathexpr) + * [`obj spec.volumes`](#obj-specvolumes) + * [`fn withName(name)`](#fn-specvolumeswithname) + * [`obj spec.volumes.awsElasticBlockStore`](#obj-specvolumesawselasticblockstore) + * [`fn withFsType(fsType)`](#fn-specvolumesawselasticblockstorewithfstype) + * [`fn withPartition(partition)`](#fn-specvolumesawselasticblockstorewithpartition) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesawselasticblockstorewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumesawselasticblockstorewithvolumeid) + * [`obj spec.volumes.azureDisk`](#obj-specvolumesazuredisk) + * [`fn withCachingMode(cachingMode)`](#fn-specvolumesazurediskwithcachingmode) + * [`fn withDiskName(diskName)`](#fn-specvolumesazurediskwithdiskname) + * [`fn withDiskURI(diskURI)`](#fn-specvolumesazurediskwithdiskuri) + * [`fn withFsType(fsType)`](#fn-specvolumesazurediskwithfstype) + * [`fn withKind(kind)`](#fn-specvolumesazurediskwithkind) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesazurediskwithreadonly) + * [`obj spec.volumes.azureFile`](#obj-specvolumesazurefile) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesazurefilewithreadonly) + * [`fn withSecretName(secretName)`](#fn-specvolumesazurefilewithsecretname) + * [`fn withShareName(shareName)`](#fn-specvolumesazurefilewithsharename) + * [`obj spec.volumes.cephfs`](#obj-specvolumescephfs) + * [`fn withMonitors(monitors)`](#fn-specvolumescephfswithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specvolumescephfswithmonitorsmixin) + * [`fn withPath(path)`](#fn-specvolumescephfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescephfswithreadonly) + * [`fn withSecretFile(secretFile)`](#fn-specvolumescephfswithsecretfile) + * [`fn withUser(user)`](#fn-specvolumescephfswithuser) + * [`obj spec.volumes.cephfs.secretRef`](#obj-specvolumescephfssecretref) + * [`fn withName(name)`](#fn-specvolumescephfssecretrefwithname) + * [`obj spec.volumes.cinder`](#obj-specvolumescinder) + * [`fn withFsType(fsType)`](#fn-specvolumescinderwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescinderwithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumescinderwithvolumeid) + * [`obj spec.volumes.cinder.secretRef`](#obj-specvolumescindersecretref) + * [`fn withName(name)`](#fn-specvolumescindersecretrefwithname) + * [`obj spec.volumes.configMap`](#obj-specvolumesconfigmap) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesconfigmapwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specvolumesconfigmapwithoptional) + * [`obj spec.volumes.configMap.items`](#obj-specvolumesconfigmapitems) + * [`fn withKey(key)`](#fn-specvolumesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesconfigmapitemswithpath) + * [`obj spec.volumes.csi`](#obj-specvolumescsi) + * [`fn withDriver(driver)`](#fn-specvolumescsiwithdriver) + * [`fn withFsType(fsType)`](#fn-specvolumescsiwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescsiwithreadonly) + * [`fn withVolumeAttributes(volumeAttributes)`](#fn-specvolumescsiwithvolumeattributes) + * [`fn withVolumeAttributesMixin(volumeAttributes)`](#fn-specvolumescsiwithvolumeattributesmixin) + * [`obj spec.volumes.csi.nodePublishSecretRef`](#obj-specvolumescsinodepublishsecretref) + * [`fn withName(name)`](#fn-specvolumescsinodepublishsecretrefwithname) + * [`obj spec.volumes.downwardAPI`](#obj-specvolumesdownwardapi) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesdownwardapiwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesdownwardapiwithitemsmixin) + * [`obj spec.volumes.downwardAPI.items`](#obj-specvolumesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specvolumesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesdownwardapiitemswithpath) + * [`obj spec.volumes.downwardAPI.items.fieldRef`](#obj-specvolumesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specvolumesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specvolumesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.volumes.downwardAPI.items.resourceFieldRef`](#obj-specvolumesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.volumes.emptyDir`](#obj-specvolumesemptydir) + * [`fn withMedium(medium)`](#fn-specvolumesemptydirwithmedium) + * [`fn withSizeLimit(sizeLimit)`](#fn-specvolumesemptydirwithsizelimit) + * [`obj spec.volumes.ephemeral`](#obj-specvolumesephemeral) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate`](#obj-specvolumesephemeralvolumeclaimtemplate) + * [`fn withMetadata(metadata)`](#fn-specvolumesephemeralvolumeclaimtemplatewithmetadata) + * [`fn withMetadataMixin(metadata)`](#fn-specvolumesephemeralvolumeclaimtemplatewithmetadatamixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec`](#obj-specvolumesephemeralvolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumename) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource`](#obj-specvolumesephemeralvolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef`](#obj-specvolumesephemeralvolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.resources`](#obj-specvolumesephemeralvolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector`](#obj-specvolumesephemeralvolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.volumes.fc`](#obj-specvolumesfc) + * [`fn withFsType(fsType)`](#fn-specvolumesfcwithfstype) + * [`fn withLun(lun)`](#fn-specvolumesfcwithlun) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesfcwithreadonly) + * [`fn withTargetWWNs(targetWWNs)`](#fn-specvolumesfcwithtargetwwns) + * [`fn withTargetWWNsMixin(targetWWNs)`](#fn-specvolumesfcwithtargetwwnsmixin) + * [`fn withWwids(wwids)`](#fn-specvolumesfcwithwwids) + * [`fn withWwidsMixin(wwids)`](#fn-specvolumesfcwithwwidsmixin) + * [`obj spec.volumes.flexVolume`](#obj-specvolumesflexvolume) + * [`fn withDriver(driver)`](#fn-specvolumesflexvolumewithdriver) + * [`fn withFsType(fsType)`](#fn-specvolumesflexvolumewithfstype) + * [`fn withOptions(options)`](#fn-specvolumesflexvolumewithoptions) + * [`fn withOptionsMixin(options)`](#fn-specvolumesflexvolumewithoptionsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesflexvolumewithreadonly) + * [`obj spec.volumes.flexVolume.secretRef`](#obj-specvolumesflexvolumesecretref) + * [`fn withName(name)`](#fn-specvolumesflexvolumesecretrefwithname) + * [`obj spec.volumes.flocker`](#obj-specvolumesflocker) + * [`fn withDatasetName(datasetName)`](#fn-specvolumesflockerwithdatasetname) + * [`fn withDatasetUUID(datasetUUID)`](#fn-specvolumesflockerwithdatasetuuid) + * [`obj spec.volumes.gcePersistentDisk`](#obj-specvolumesgcepersistentdisk) + * [`fn withFsType(fsType)`](#fn-specvolumesgcepersistentdiskwithfstype) + * [`fn withPartition(partition)`](#fn-specvolumesgcepersistentdiskwithpartition) + * [`fn withPdName(pdName)`](#fn-specvolumesgcepersistentdiskwithpdname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesgcepersistentdiskwithreadonly) + * [`obj spec.volumes.gitRepo`](#obj-specvolumesgitrepo) + * [`fn withDirectory(directory)`](#fn-specvolumesgitrepowithdirectory) + * [`fn withRepository(repository)`](#fn-specvolumesgitrepowithrepository) + * [`fn withRevision(revision)`](#fn-specvolumesgitrepowithrevision) + * [`obj spec.volumes.glusterfs`](#obj-specvolumesglusterfs) + * [`fn withEndpoints(endpoints)`](#fn-specvolumesglusterfswithendpoints) + * [`fn withPath(path)`](#fn-specvolumesglusterfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesglusterfswithreadonly) + * [`obj spec.volumes.hostPath`](#obj-specvolumeshostpath) + * [`fn withPath(path)`](#fn-specvolumeshostpathwithpath) + * [`fn withType(type)`](#fn-specvolumeshostpathwithtype) + * [`obj spec.volumes.iscsi`](#obj-specvolumesiscsi) + * [`fn withChapAuthDiscovery(chapAuthDiscovery)`](#fn-specvolumesiscsiwithchapauthdiscovery) + * [`fn withChapAuthSession(chapAuthSession)`](#fn-specvolumesiscsiwithchapauthsession) + * [`fn withFsType(fsType)`](#fn-specvolumesiscsiwithfstype) + * [`fn withInitiatorName(initiatorName)`](#fn-specvolumesiscsiwithinitiatorname) + * [`fn withIqn(iqn)`](#fn-specvolumesiscsiwithiqn) + * [`fn withIscsiInterface(iscsiInterface)`](#fn-specvolumesiscsiwithiscsiinterface) + * [`fn withLun(lun)`](#fn-specvolumesiscsiwithlun) + * [`fn withPortals(portals)`](#fn-specvolumesiscsiwithportals) + * [`fn withPortalsMixin(portals)`](#fn-specvolumesiscsiwithportalsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesiscsiwithreadonly) + * [`fn withTargetPortal(targetPortal)`](#fn-specvolumesiscsiwithtargetportal) + * [`obj spec.volumes.iscsi.secretRef`](#obj-specvolumesiscsisecretref) + * [`fn withName(name)`](#fn-specvolumesiscsisecretrefwithname) + * [`obj spec.volumes.nfs`](#obj-specvolumesnfs) + * [`fn withPath(path)`](#fn-specvolumesnfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesnfswithreadonly) + * [`fn withServer(server)`](#fn-specvolumesnfswithserver) + * [`obj spec.volumes.persistentVolumeClaim`](#obj-specvolumespersistentvolumeclaim) + * [`fn withClaimName(claimName)`](#fn-specvolumespersistentvolumeclaimwithclaimname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumespersistentvolumeclaimwithreadonly) + * [`obj spec.volumes.photonPersistentDisk`](#obj-specvolumesphotonpersistentdisk) + * [`fn withFsType(fsType)`](#fn-specvolumesphotonpersistentdiskwithfstype) + * [`fn withPdID(pdID)`](#fn-specvolumesphotonpersistentdiskwithpdid) + * [`obj spec.volumes.portworxVolume`](#obj-specvolumesportworxvolume) + * [`fn withFsType(fsType)`](#fn-specvolumesportworxvolumewithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesportworxvolumewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumesportworxvolumewithvolumeid) + * [`obj spec.volumes.projected`](#obj-specvolumesprojected) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesprojectedwithdefaultmode) + * [`fn withSources(sources)`](#fn-specvolumesprojectedwithsources) + * [`fn withSourcesMixin(sources)`](#fn-specvolumesprojectedwithsourcesmixin) + * [`obj spec.volumes.projected.sources`](#obj-specvolumesprojectedsources) + * [`obj spec.volumes.projected.sources.clusterTrustBundle`](#obj-specvolumesprojectedsourcesclustertrustbundle) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithoptional) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithpath) + * [`fn withSignerName(signerName)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithsignername) + * [`obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector`](#obj-specvolumesprojectedsourcesclustertrustbundlelabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchlabelsmixin) + * [`obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions`](#obj-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.volumes.projected.sources.configMap`](#obj-specvolumesprojectedsourcesconfigmap) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcesconfigmapwithoptional) + * [`obj spec.volumes.projected.sources.configMap.items`](#obj-specvolumesprojectedsourcesconfigmapitems) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesconfigmapitemswithpath) + * [`obj spec.volumes.projected.sources.downwardAPI`](#obj-specvolumesprojectedsourcesdownwardapi) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcesdownwardapiwithitemsmixin) + * [`obj spec.volumes.projected.sources.downwardAPI.items`](#obj-specvolumesprojectedsourcesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesdownwardapiitemswithpath) + * [`obj spec.volumes.projected.sources.downwardAPI.items.fieldRef`](#obj-specvolumesprojectedsourcesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specvolumesprojectedsourcesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specvolumesprojectedsourcesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef`](#obj-specvolumesprojectedsourcesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.volumes.projected.sources.secret`](#obj-specvolumesprojectedsourcessecret) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcessecretwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcessecretwithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcessecretwithoptional) + * [`obj spec.volumes.projected.sources.secret.items`](#obj-specvolumesprojectedsourcessecretitems) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcessecretitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcessecretitemswithpath) + * [`obj spec.volumes.projected.sources.serviceAccountToken`](#obj-specvolumesprojectedsourcesserviceaccounttoken) + * [`fn withAudience(audience)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithaudience) + * [`fn withExpirationSeconds(expirationSeconds)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithexpirationseconds) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithpath) + * [`obj spec.volumes.quobyte`](#obj-specvolumesquobyte) + * [`fn withGroup(group)`](#fn-specvolumesquobytewithgroup) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesquobytewithreadonly) + * [`fn withRegistry(registry)`](#fn-specvolumesquobytewithregistry) + * [`fn withTenant(tenant)`](#fn-specvolumesquobytewithtenant) + * [`fn withUser(user)`](#fn-specvolumesquobytewithuser) + * [`fn withVolume(volume)`](#fn-specvolumesquobytewithvolume) + * [`obj spec.volumes.rbd`](#obj-specvolumesrbd) + * [`fn withFsType(fsType)`](#fn-specvolumesrbdwithfstype) + * [`fn withImage(image)`](#fn-specvolumesrbdwithimage) + * [`fn withKeyring(keyring)`](#fn-specvolumesrbdwithkeyring) + * [`fn withMonitors(monitors)`](#fn-specvolumesrbdwithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specvolumesrbdwithmonitorsmixin) + * [`fn withPool(pool)`](#fn-specvolumesrbdwithpool) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesrbdwithreadonly) + * [`fn withUser(user)`](#fn-specvolumesrbdwithuser) + * [`obj spec.volumes.rbd.secretRef`](#obj-specvolumesrbdsecretref) + * [`fn withName(name)`](#fn-specvolumesrbdsecretrefwithname) + * [`obj spec.volumes.scaleIO`](#obj-specvolumesscaleio) + * [`fn withFsType(fsType)`](#fn-specvolumesscaleiowithfstype) + * [`fn withGateway(gateway)`](#fn-specvolumesscaleiowithgateway) + * [`fn withProtectionDomain(protectionDomain)`](#fn-specvolumesscaleiowithprotectiondomain) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesscaleiowithreadonly) + * [`fn withSslEnabled(sslEnabled)`](#fn-specvolumesscaleiowithsslenabled) + * [`fn withStorageMode(storageMode)`](#fn-specvolumesscaleiowithstoragemode) + * [`fn withStoragePool(storagePool)`](#fn-specvolumesscaleiowithstoragepool) + * [`fn withSystem(system)`](#fn-specvolumesscaleiowithsystem) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesscaleiowithvolumename) + * [`obj spec.volumes.scaleIO.secretRef`](#obj-specvolumesscaleiosecretref) + * [`fn withName(name)`](#fn-specvolumesscaleiosecretrefwithname) + * [`obj spec.volumes.secret`](#obj-specvolumessecret) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumessecretwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumessecretwithitemsmixin) + * [`fn withOptional(optional)`](#fn-specvolumessecretwithoptional) + * [`fn withSecretName(secretName)`](#fn-specvolumessecretwithsecretname) + * [`obj spec.volumes.secret.items`](#obj-specvolumessecretitems) + * [`fn withKey(key)`](#fn-specvolumessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumessecretitemswithmode) + * [`fn withPath(path)`](#fn-specvolumessecretitemswithpath) + * [`obj spec.volumes.storageos`](#obj-specvolumesstorageos) + * [`fn withFsType(fsType)`](#fn-specvolumesstorageoswithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesstorageoswithreadonly) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesstorageoswithvolumename) + * [`fn withVolumeNamespace(volumeNamespace)`](#fn-specvolumesstorageoswithvolumenamespace) + * [`obj spec.volumes.storageos.secretRef`](#obj-specvolumesstorageossecretref) + * [`fn withName(name)`](#fn-specvolumesstorageossecretrefwithname) + * [`obj spec.volumes.vsphereVolume`](#obj-specvolumesvspherevolume) + * [`fn withFsType(fsType)`](#fn-specvolumesvspherevolumewithfstype) + * [`fn withStoragePolicyID(storagePolicyID)`](#fn-specvolumesvspherevolumewithstoragepolicyid) + * [`fn withStoragePolicyName(storagePolicyName)`](#fn-specvolumesvspherevolumewithstoragepolicyname) + * [`fn withVolumePath(volumePath)`](#fn-specvolumesvspherevolumewithvolumepath) + * [`obj spec.web`](#obj-specweb) + * [`fn withMaxConnections(maxConnections)`](#fn-specwebwithmaxconnections) + * [`fn withPageTitle(pageTitle)`](#fn-specwebwithpagetitle) + * [`obj spec.web.httpConfig`](#obj-specwebhttpconfig) + * [`fn withHttp2(http2)`](#fn-specwebhttpconfigwithhttp2) + * [`obj spec.web.httpConfig.headers`](#obj-specwebhttpconfigheaders) + * [`fn withContentSecurityPolicy(contentSecurityPolicy)`](#fn-specwebhttpconfigheaderswithcontentsecuritypolicy) + * [`fn withStrictTransportSecurity(strictTransportSecurity)`](#fn-specwebhttpconfigheaderswithstricttransportsecurity) + * [`fn withXContentTypeOptions(xContentTypeOptions)`](#fn-specwebhttpconfigheaderswithxcontenttypeoptions) + * [`fn withXFrameOptions(xFrameOptions)`](#fn-specwebhttpconfigheaderswithxframeoptions) + * [`fn withXXSSProtection(xXSSProtection)`](#fn-specwebhttpconfigheaderswithxxssprotection) + * [`obj spec.web.tlsConfig`](#obj-specwebtlsconfig) + * [`fn withCipherSuites(cipherSuites)`](#fn-specwebtlsconfigwithciphersuites) + * [`fn withCipherSuitesMixin(cipherSuites)`](#fn-specwebtlsconfigwithciphersuitesmixin) + * [`fn withClientAuthType(clientAuthType)`](#fn-specwebtlsconfigwithclientauthtype) + * [`fn withCurvePreferences(curvePreferences)`](#fn-specwebtlsconfigwithcurvepreferences) + * [`fn withCurvePreferencesMixin(curvePreferences)`](#fn-specwebtlsconfigwithcurvepreferencesmixin) + * [`fn withMaxVersion(maxVersion)`](#fn-specwebtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specwebtlsconfigwithminversion) + * [`fn withPreferServerCipherSuites(preferServerCipherSuites)`](#fn-specwebtlsconfigwithpreferserverciphersuites) + * [`obj spec.web.tlsConfig.cert`](#obj-specwebtlsconfigcert) + * [`obj spec.web.tlsConfig.cert.configMap`](#obj-specwebtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specwebtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigcertconfigmapwithoptional) + * [`obj spec.web.tlsConfig.cert.secret`](#obj-specwebtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigcertsecretwithoptional) + * [`obj spec.web.tlsConfig.client_ca`](#obj-specwebtlsconfigclient_ca) + * [`obj spec.web.tlsConfig.client_ca.configMap`](#obj-specwebtlsconfigclient_caconfigmap) + * [`fn withKey(key)`](#fn-specwebtlsconfigclient_caconfigmapwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigclient_caconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigclient_caconfigmapwithoptional) + * [`obj spec.web.tlsConfig.client_ca.secret`](#obj-specwebtlsconfigclient_casecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigclient_casecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigclient_casecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigclient_casecretwithoptional) + * [`obj spec.web.tlsConfig.keySecret`](#obj-specwebtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigkeysecretwithoptional) + +## Fields + +### fn new + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" + +### fn spec.withAdditionalArgs + +```ts +withAdditionalArgs(additionalArgs) +``` + +"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\n\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged." + +### fn spec.withAdditionalArgsMixin + +```ts +withAdditionalArgsMixin(additionalArgs) +``` + +"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\n\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged." + +**Note:** This function appends passed data to existing values + +### fn spec.withAllowOverlappingBlocks + +```ts +withAllowOverlappingBlocks(allowOverlappingBlocks) +``` + +"AllowOverlappingBlocks enables vertical compaction and vertical query\nmerge in Prometheus.\n\n\nDeprecated: this flag has no effect for Prometheus >= 2.39.0 where overlapping blocks are enabled by default." + +### fn spec.withAutomountServiceAccountToken + +```ts +withAutomountServiceAccountToken(automountServiceAccountToken) +``` + +"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\nIf the field isn't set, the operator mounts the service account token by default.\n\n\n**Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery.\nIt is possible to use strategic merge patch to project the service account token into the 'prometheus' container." + +### fn spec.withBaseImage + +```ts +withBaseImage(baseImage) +``` + +"Deprecated: use 'spec.image' instead." + +### fn spec.withBodySizeLimit + +```ts +withBodySizeLimit(bodySizeLimit) +``` + +"BodySizeLimit defines per-scrape on response body size.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit." + +### fn spec.withConfigMaps + +```ts +withConfigMaps(configMaps) +``` + +"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container." + +### fn spec.withConfigMapsMixin + +```ts +withConfigMapsMixin(configMaps) +``` + +"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container." + +**Note:** This function appends passed data to existing values + +### fn spec.withContainers + +```ts +withContainers(containers) +``` + +"Containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +### fn spec.withContainersMixin + +```ts +withContainersMixin(containers) +``` + +"Containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +**Note:** This function appends passed data to existing values + +### fn spec.withDisableCompaction + +```ts +withDisableCompaction(disableCompaction) +``` + +"When true, the Prometheus compaction is disabled." + +### fn spec.withEnableAdminAPI + +```ts +withEnableAdminAPI(enableAdminAPI) +``` + +"Enables access to the Prometheus web admin API.\n\n\nWARNING: Enabling the admin APIs enables mutating endpoints, to delete data,\nshutdown Prometheus, and more. Enabling this should be done with care and the\nuser is advised to add additional authentication authorization via a proxy to\nensure only clients authorized to perform these actions can do so.\n\n\nFor more information:\nhttps://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis" + +### fn spec.withEnableFeatures + +```ts +withEnableFeatures(enableFeatures) +``` + +"Enable access to Prometheus feature flags. By default, no features are enabled.\n\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\n\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/" + +### fn spec.withEnableFeaturesMixin + +```ts +withEnableFeaturesMixin(enableFeatures) +``` + +"Enable access to Prometheus feature flags. By default, no features are enabled.\n\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\n\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/" + +**Note:** This function appends passed data to existing values + +### fn spec.withEnableRemoteWriteReceiver + +```ts +withEnableRemoteWriteReceiver(enableRemoteWriteReceiver) +``` + +"Enable Prometheus to be used as a receiver for the Prometheus remote\nwrite protocol.\n\n\nWARNING: This is not considered an efficient way of ingesting samples.\nUse it with caution for specific low-volume use cases.\nIt is not suitable for replacing the ingestion via scraping and turning\nPrometheus into a push-based metrics collection system.\nFor more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver\n\n\nIt requires Prometheus >= v2.33.0." + +### fn spec.withEnforcedBodySizeLimit + +```ts +withEnforcedBodySizeLimit(enforcedBodySizeLimit) +``` + +"When defined, enforcedBodySizeLimit specifies a global limit on the size\nof uncompressed response body that will be accepted by Prometheus.\nTargets responding with a body larger than this many bytes will cause\nthe scrape to fail.\n\n\nIt requires Prometheus >= v2.28.0.\n\n\nWhen both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.\n* Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value.\n* Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit." + +### fn spec.withEnforcedKeepDroppedTargets + +```ts +withEnforcedKeepDroppedTargets(enforcedKeepDroppedTargets) +``` + +"When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets\ndropped by relabeling that will be kept in memory. The value overrides\nany `spec.keepDroppedTargets` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is\ngreater than zero and less than `spec.enforcedKeepDroppedTargets`.\n\n\nIt requires Prometheus >= v2.47.0.\n\n\nWhen both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.\n* Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value.\n* Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets." + +### fn spec.withEnforcedLabelLimit + +```ts +withEnforcedLabelLimit(enforcedLabelLimit) +``` + +"When defined, enforcedLabelLimit specifies a global limit on the number\nof labels per sample. The value overrides any `spec.labelLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is\ngreater than zero and less than `spec.enforcedLabelLimit`.\n\n\nIt requires Prometheus >= v2.27.0.\n\n\nWhen both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.\n* Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value.\n* Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit." + +### fn spec.withEnforcedLabelNameLengthLimit + +```ts +withEnforcedLabelNameLengthLimit(enforcedLabelNameLengthLimit) +``` + +"When defined, enforcedLabelNameLengthLimit specifies a global limit on the length\nof labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelNameLengthLimit`.\n\n\nIt requires Prometheus >= v2.27.0.\n\n\nWhen both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.\n* Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value.\n* Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit." + +### fn spec.withEnforcedLabelValueLengthLimit + +```ts +withEnforcedLabelValueLengthLimit(enforcedLabelValueLengthLimit) +``` + +"When not null, enforcedLabelValueLengthLimit defines a global limit on the length\nof labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelValueLengthLimit`.\n\n\nIt requires Prometheus >= v2.27.0.\n\n\nWhen both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.\n* Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value.\n* Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit." + +### fn spec.withEnforcedNamespaceLabel + +```ts +withEnforcedNamespaceLabel(enforcedNamespaceLabel) +``` + +"When not empty, a label will be added to:\n\n\n1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects.\n2. All metrics generated from recording rules defined in `PrometheusRule` objects.\n3. All alerts generated from alerting rules defined in `PrometheusRule` objects.\n4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.\n\n\nThe label will not added for objects referenced in `spec.excludedFromEnforcement`.\n\n\nThe label's name is this field's value.\nThe label's value is the namespace of the `ServiceMonitor`,\n`PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object." + +### fn spec.withEnforcedSampleLimit + +```ts +withEnforcedSampleLimit(enforcedSampleLimit) +``` + +"When defined, enforcedSampleLimit specifies a global limit on the number\nof scraped samples that will be accepted. This overrides any\n`spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects\nunless `spec.sampleLimit` is greater than zero and less than\n`spec.enforcedSampleLimit`.\n\n\nIt is meant to be used by admins to keep the overall number of\nsamples/series under a desired limit.\n\n\nWhen both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.\n* Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value.\n* Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit." + +### fn spec.withEnforcedTargetLimit + +```ts +withEnforcedTargetLimit(enforcedTargetLimit) +``` + +"When defined, enforcedTargetLimit specifies a global limit on the number\nof scraped targets. The value overrides any `spec.targetLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is\ngreater than zero and less than `spec.enforcedTargetLimit`.\n\n\nIt is meant to be used by admins to to keep the overall number of\ntargets under a desired limit.\n\n\nWhen both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.\n* Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value.\n* Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit." + +### fn spec.withEvaluationInterval + +```ts +withEvaluationInterval(evaluationInterval) +``` + +"Interval between rule evaluations.\nDefault: \"30s\ + +### fn spec.withExcludedFromEnforcement + +```ts +withExcludedFromEnforcement(excludedFromEnforcement) +``` + +"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true." + +### fn spec.withExcludedFromEnforcementMixin + +```ts +withExcludedFromEnforcementMixin(excludedFromEnforcement) +``` + +"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true." + +**Note:** This function appends passed data to existing values + +### fn spec.withExternalLabels + +```ts +withExternalLabels(externalLabels) +``` + +"The labels to add to any time series or alerts when communicating with\nexternal systems (federation, remote storage, Alertmanager).\nLabels defined by `spec.replicaExternalLabelName` and\n`spec.prometheusExternalLabelName` take precedence over this list." + +### fn spec.withExternalLabelsMixin + +```ts +withExternalLabelsMixin(externalLabels) +``` + +"The labels to add to any time series or alerts when communicating with\nexternal systems (federation, remote storage, Alertmanager).\nLabels defined by `spec.replicaExternalLabelName` and\n`spec.prometheusExternalLabelName` take precedence over this list." + +**Note:** This function appends passed data to existing values + +### fn spec.withExternalUrl + +```ts +withExternalUrl(externalUrl) +``` + +"The external URL under which the Prometheus service is externally\navailable. This is necessary to generate correct URLs (for instance if\nPrometheus is accessible behind an Ingress resource)." + +### fn spec.withHostAliases + +```ts +withHostAliases(hostAliases) +``` + +"Optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified." + +### fn spec.withHostAliasesMixin + +```ts +withHostAliasesMixin(hostAliases) +``` + +"Optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified." + +**Note:** This function appends passed data to existing values + +### fn spec.withHostNetwork + +```ts +withHostNetwork(hostNetwork) +``` + +"Use the host's network namespace if true.\n\n\nMake sure to understand the security implications if you want to enable\nit (https://kubernetes.io/docs/concepts/configuration/overview/).\n\n\nWhen hostNetwork is enabled, this will set the DNS policy to\n`ClusterFirstWithHostNet` automatically." + +### fn spec.withIgnoreNamespaceSelectors + +```ts +withIgnoreNamespaceSelectors(ignoreNamespaceSelectors) +``` + +"When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor\nand Probe objects will be ignored. They will only discover targets\nwithin the namespace of the PodMonitor, ServiceMonitor and Probe\nobject." + +### fn spec.withImage + +```ts +withImage(image) +``` + +"Container image name for Prometheus. If specified, it takes precedence\nover the `spec.baseImage`, `spec.tag` and `spec.sha` fields.\n\n\nSpecifying `spec.version` is still necessary to ensure the Prometheus\nOperator knows which version of Prometheus is being configured.\n\n\nIf neither `spec.image` nor `spec.baseImage` are defined, the operator\nwill use the latest upstream version of Prometheus available at the time\nwhen the operator was released." + +### fn spec.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details." + +### fn spec.withImagePullSecrets + +```ts +withImagePullSecrets(imagePullSecrets) +``` + +"An optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +### fn spec.withImagePullSecretsMixin + +```ts +withImagePullSecretsMixin(imagePullSecrets) +``` + +"An optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +**Note:** This function appends passed data to existing values + +### fn spec.withInitContainers + +```ts +withInitContainers(initContainers) +``` + +"InitContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +### fn spec.withInitContainersMixin + +```ts +withInitContainersMixin(initContainers) +``` + +"InitContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +**Note:** This function appends passed data to existing values + +### fn spec.withKeepDroppedTargets + +```ts +withKeepDroppedTargets(keepDroppedTargets) +``` + +"Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\n\nIt requires Prometheus >= v2.47.0.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets." + +### fn spec.withLabelLimit + +```ts +withLabelLimit(labelLimit) +``` + +"Per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit." + +### fn spec.withLabelNameLengthLimit + +```ts +withLabelNameLengthLimit(labelNameLengthLimit) +``` + +"Per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit." + +### fn spec.withLabelValueLengthLimit + +```ts +withLabelValueLengthLimit(labelValueLengthLimit) +``` + +"Per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit." + +### fn spec.withListenLocal + +```ts +withListenLocal(listenLocal) +``` + +"When true, the Prometheus server listens on the loopback address\ninstead of the Pod IP's address." + +### fn spec.withLogFormat + +```ts +withLogFormat(logFormat) +``` + +"Log format for Log level for Prometheus and the config-reloader sidecar." + +### fn spec.withLogLevel + +```ts +withLogLevel(logLevel) +``` + +"Log level for Prometheus and the config-reloader sidecar." + +### fn spec.withMaximumStartupDurationSeconds + +```ts +withMaximumStartupDurationSeconds(maximumStartupDurationSeconds) +``` + +"Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete.\nIf set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes)." + +### fn spec.withMinReadySeconds + +```ts +withMinReadySeconds(minReadySeconds) +``` + +"Minimum number of seconds for which a newly created Pod should be ready\nwithout any of its container crashing for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\n\n\nThis is an alpha field from kubernetes 1.22 until 1.24 which requires\nenabling the StatefulSetMinReadySeconds feature gate." + +### fn spec.withNodeSelector + +```ts +withNodeSelector(nodeSelector) +``` + +"Defines on which Nodes the Pods are scheduled." + +### fn spec.withNodeSelectorMixin + +```ts +withNodeSelectorMixin(nodeSelector) +``` + +"Defines on which Nodes the Pods are scheduled." + +**Note:** This function appends passed data to existing values + +### fn spec.withOverrideHonorLabels + +```ts +withOverrideHonorLabels(overrideHonorLabels) +``` + +"When true, Prometheus resolves label conflicts by renaming the labels in the scraped data\n to “exported_” for all targets created from ServiceMonitor, PodMonitor and\nScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies.\nIn practice,`overrideHonorLaels:true` enforces `honorLabels:false`\nfor all ServiceMonitor, PodMonitor and ScrapeConfig objects." + +### fn spec.withOverrideHonorTimestamps + +```ts +withOverrideHonorTimestamps(overrideHonorTimestamps) +``` + +"When true, Prometheus ignores the timestamps for all the targets created\nfrom service and pod monitors.\nOtherwise the HonorTimestamps field of the service or pod monitor applies." + +### fn spec.withPaused + +```ts +withPaused(paused) +``` + +"When a Prometheus deployment is paused, no actions except for deletion\nwill be performed on the underlying objects." + +### fn spec.withPodTargetLabels + +```ts +withPodTargetLabels(podTargetLabels) +``` + +"PodTargetLabels are appended to the `spec.podTargetLabels` field of all\nPodMonitor and ServiceMonitor objects." + +### fn spec.withPodTargetLabelsMixin + +```ts +withPodTargetLabelsMixin(podTargetLabels) +``` + +"PodTargetLabels are appended to the `spec.podTargetLabels` field of all\nPodMonitor and ServiceMonitor objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withPortName + +```ts +withPortName(portName) +``` + +"Port name used for the pods and governing service.\nDefault: \"web\ + +### fn spec.withPriorityClassName + +```ts +withPriorityClassName(priorityClassName) +``` + +"Priority class assigned to the Pods." + +### fn spec.withPrometheusExternalLabelName + +```ts +withPrometheusExternalLabelName(prometheusExternalLabelName) +``` + +"Name of Prometheus external label used to denote the Prometheus instance\nname. The external label will _not_ be added when the field is set to\nthe empty string (`\"\"`).\n\n\nDefault: \"prometheus\ + +### fn spec.withPrometheusRulesExcludedFromEnforce + +```ts +withPrometheusRulesExcludedFromEnforce(prometheusRulesExcludedFromEnforce) +``` + +"Defines the list of PrometheusRule objects to which the namespace label\nenforcement doesn't apply.\nThis is only relevant when `spec.enforcedNamespaceLabel` is set to true.\nDeprecated: use `spec.excludedFromEnforcement` instead." + +### fn spec.withPrometheusRulesExcludedFromEnforceMixin + +```ts +withPrometheusRulesExcludedFromEnforceMixin(prometheusRulesExcludedFromEnforce) +``` + +"Defines the list of PrometheusRule objects to which the namespace label\nenforcement doesn't apply.\nThis is only relevant when `spec.enforcedNamespaceLabel` is set to true.\nDeprecated: use `spec.excludedFromEnforcement` instead." + +**Note:** This function appends passed data to existing values + +### fn spec.withQueryLogFile + +```ts +withQueryLogFile(queryLogFile) +``` + +"queryLogFile specifies where the file to which PromQL queries are logged.\n\n\nIf the filename has an empty path, e.g. 'query.log', The Prometheus Pods\nwill mount the file into an emptyDir volume at `/var/log/prometheus`.\nIf a full path is provided, e.g. '/var/log/prometheus/query.log', you\nmust mount a volume in the specified directory and it must be writable.\nThis is because the prometheus container runs with a read-only root\nfilesystem for security reasons.\nAlternatively, the location can be set to a standard I/O stream, e.g.\n`/dev/stdout`, to log query information to the default Prometheus log\nstream." + +### fn spec.withReloadStrategy + +```ts +withReloadStrategy(reloadStrategy) +``` + +"Defines the strategy used to reload the Prometheus configuration.\nIf not specified, the configuration is reloaded using the /-/reload HTTP endpoint." + +### fn spec.withRemoteRead + +```ts +withRemoteRead(remoteRead) +``` + +"Defines the list of remote read configurations." + +### fn spec.withRemoteReadMixin + +```ts +withRemoteReadMixin(remoteRead) +``` + +"Defines the list of remote read configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withRemoteWrite + +```ts +withRemoteWrite(remoteWrite) +``` + +"Defines the list of remote write configurations." + +### fn spec.withRemoteWriteMixin + +```ts +withRemoteWriteMixin(remoteWrite) +``` + +"Defines the list of remote write configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withReplicaExternalLabelName + +```ts +withReplicaExternalLabelName(replicaExternalLabelName) +``` + +"Name of Prometheus external label used to denote the replica name.\nThe external label will _not_ be added when the field is set to the\nempty string (`\"\"`).\n\n\nDefault: \"prometheus_replica\ + +### fn spec.withReplicas + +```ts +withReplicas(replicas) +``` + +"Number of replicas of each shard to deploy for a Prometheus deployment.\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\ncreated.\n\n\nDefault: 1" + +### fn spec.withRetention + +```ts +withRetention(retention) +``` + +"How long to retain the Prometheus data.\n\n\nDefault: \"24h\" if `spec.retention` and `spec.retentionSize` are empty." + +### fn spec.withRetentionSize + +```ts +withRetentionSize(retentionSize) +``` + +"Maximum number of bytes used by the Prometheus data." + +### fn spec.withRoutePrefix + +```ts +withRoutePrefix(routePrefix) +``` + +"The route prefix Prometheus registers HTTP handlers for.\n\n\nThis is useful when using `spec.externalURL`, and a proxy is rewriting\nHTTP routes of a request, and the actual ExternalURL is still true, but\nthe server serves requests under a different route prefix. For example\nfor use with `kubectl proxy`." + +### fn spec.withSampleLimit + +```ts +withSampleLimit(sampleLimit) +``` + +"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit." + +### fn spec.withScrapeClasses + +```ts +withScrapeClasses(scrapeClasses) +``` + +"List of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.withScrapeClassesMixin + +```ts +withScrapeClassesMixin(scrapeClasses) +``` + +"List of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +**Note:** This function appends passed data to existing values + +### fn spec.withScrapeInterval + +```ts +withScrapeInterval(scrapeInterval) +``` + +"Interval between consecutive scrapes.\n\n\nDefault: \"30s\ + +### fn spec.withScrapeProtocols + +```ts +withScrapeProtocols(scrapeProtocols) +``` + +"The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +### fn spec.withScrapeProtocolsMixin + +```ts +withScrapeProtocolsMixin(scrapeProtocols) +``` + +"The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +**Note:** This function appends passed data to existing values + +### fn spec.withScrapeTimeout + +```ts +withScrapeTimeout(scrapeTimeout) +``` + +"Number of seconds to wait until a scrape request times out." + +### fn spec.withSecrets + +```ts +withSecrets(secrets) +``` + +"Secrets is a list of Secrets in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container." + +### fn spec.withSecretsMixin + +```ts +withSecretsMixin(secrets) +``` + +"Secrets is a list of Secrets in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container." + +**Note:** This function appends passed data to existing values + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"ServiceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods." + +### fn spec.withServiceDiscoveryRole + +```ts +withServiceDiscoveryRole(serviceDiscoveryRole) +``` + +"Defines the service discovery role used to discover targets from\n`ServiceMonitor` objects and Alertmanager endpoints.\n\n\nIf set, the value should be either \"Endpoints\" or \"EndpointSlice\".\nIf unset, the operator assumes the \"Endpoints\" role." + +### fn spec.withSha + +```ts +withSha(sha) +``` + +"Deprecated: use 'spec.image' instead. The image's digest can be specified as part of the image name." + +### fn spec.withShards + +```ts +withShards(shards) +``` + +"Number of shards to distribute targets onto. `spec.replicas`\nmultiplied by `spec.shards` is the total number of Pods created.\n\n\nNote that scaling down shards will not reshard data onto remaining\ninstances, it must be manually moved. Increasing shards will not reshard\ndata either but it will continue to be available from the same\ninstances. To query globally, use Thanos sidecar and Thanos querier or\nremote write data to a central location.\n\n\nSharding is performed on the content of the `__address__` target meta-label\nfor PodMonitors and ServiceMonitors and `__param_target__` for Probes.\n\n\nDefault: 1" + +### fn spec.withTag + +```ts +withTag(tag) +``` + +"Deprecated: use 'spec.image' instead. The image's tag can be specified as part of the image name." + +### fn spec.withTargetLimit + +```ts +withTargetLimit(targetLimit) +``` + +"TargetLimit defines a limit on the number of scraped targets that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit." + +### fn spec.withTolerations + +```ts +withTolerations(tolerations) +``` + +"Defines the Pods' tolerations if specified." + +### fn spec.withTolerationsMixin + +```ts +withTolerationsMixin(tolerations) +``` + +"Defines the Pods' tolerations if specified." + +**Note:** This function appends passed data to existing values + +### fn spec.withTopologySpreadConstraints + +```ts +withTopologySpreadConstraints(topologySpreadConstraints) +``` + +"Defines the pod's topology spread constraints if specified." + +### fn spec.withTopologySpreadConstraintsMixin + +```ts +withTopologySpreadConstraintsMixin(topologySpreadConstraints) +``` + +"Defines the pod's topology spread constraints if specified." + +**Note:** This function appends passed data to existing values + +### fn spec.withVersion + +```ts +withVersion(version) +``` + +"Version of Prometheus being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\n\nIf not specified, the operator assumes the latest upstream version of\nPrometheus available at the time when the version of the operator was\nreleased." + +### fn spec.withVolumeMounts + +```ts +withVolumeMounts(volumeMounts) +``` + +"VolumeMounts allows the configuration of additional VolumeMounts.\n\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects." + +### fn spec.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"VolumeMounts allows the configuration of additional VolumeMounts.\n\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withVolumes + +```ts +withVolumes(volumes) +``` + +"Volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects." + +### fn spec.withVolumesMixin + +```ts +withVolumesMixin(volumes) +``` + +"Volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withWalCompression + +```ts +withWalCompression(walCompression) +``` + +"Configures compression of the write-ahead log (WAL) using Snappy.\n\n\nWAL compression is enabled by default for Prometheus >= 2.20.0\n\n\nRequires Prometheus v2.11.0 and above." + +## obj spec.additionalAlertManagerConfigs + +"AdditionalAlertManagerConfigs specifies a key of a Secret containing\nadditional Prometheus Alertmanager configurations. The Alertmanager\nconfigurations are appended to the configuration generated by the\nPrometheus Operator. They must be formatted according to the official\nPrometheus documentation:\n\n\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config\n\n\nThe user is responsible for making sure that the configurations are valid\n\n\nNote that using this feature may expose the possibility to break\nupgrades of Prometheus. It is advised to review Prometheus release notes\nto ensure that no incompatible AlertManager configs are going to break\nPrometheus after the upgrade." + +### fn spec.additionalAlertManagerConfigs.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.additionalAlertManagerConfigs.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.additionalAlertManagerConfigs.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.additionalAlertRelabelConfigs + +"AdditionalAlertRelabelConfigs specifies a key of a Secret containing\nadditional Prometheus alert relabel configurations. The alert relabel\nconfigurations are appended to the configuration generated by the\nPrometheus Operator. They must be formatted according to the official\nPrometheus documentation:\n\n\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\n\n\nThe user is responsible for making sure that the configurations are valid\n\n\nNote that using this feature may expose the possibility to break\nupgrades of Prometheus. It is advised to review Prometheus release notes\nto ensure that no incompatible alert relabel configs are going to break\nPrometheus after the upgrade." + +### fn spec.additionalAlertRelabelConfigs.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.additionalAlertRelabelConfigs.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.additionalAlertRelabelConfigs.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.additionalArgs + +"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\n\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged." + +### fn spec.additionalArgs.withName + +```ts +withName(name) +``` + +"Name of the argument, e.g. \"scrape.discovery-reload-interval\"." + +### fn spec.additionalArgs.withValue + +```ts +withValue(value) +``` + +"Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)" + +## obj spec.additionalScrapeConfigs + +"AdditionalScrapeConfigs allows specifying a key of a Secret containing\nadditional Prometheus scrape configurations. Scrape configurations\nspecified are appended to the configurations generated by the Prometheus\nOperator. Job configurations specified must have the form as specified\nin the official Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.\nAs scrape configs are appended, the user is responsible to make sure it\nis valid. Note that using this feature may expose the possibility to\nbreak upgrades of Prometheus. It is advised to review Prometheus release\nnotes to ensure that no incompatible scrape configs are going to break\nPrometheus after the upgrade." + +### fn spec.additionalScrapeConfigs.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.additionalScrapeConfigs.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.additionalScrapeConfigs.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.affinity + +"Defines the Pods' affinity scheduling rules if specified." + +## obj spec.affinity.nodeAffinity + +"Describes node affinity scheduling rules for the pod." + +### fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(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\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +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 + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin + +```ts +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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms + +```ts +withNodeSelectorTerms(nodeSelectorTerms) +``` + +"Required. A list of node selector terms. The terms are ORed." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin + +```ts +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 + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin + +```ts +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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm 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\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm,\nin 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.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm 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\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm,\nin 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.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.alerting + +"Defines the settings related to Alertmanager." + +### fn spec.alerting.withAlertmanagers + +```ts +withAlertmanagers(alertmanagers) +``` + +"Alertmanager endpoints where Prometheus should send alerts to." + +### fn spec.alerting.withAlertmanagersMixin + +```ts +withAlertmanagersMixin(alertmanagers) +``` + +"Alertmanager endpoints where Prometheus should send alerts to." + +**Note:** This function appends passed data to existing values + +## obj spec.alerting.alertmanagers + +"Alertmanager endpoints where Prometheus should send alerts to." + +### fn spec.alerting.alertmanagers.withAlertRelabelings + +```ts +withAlertRelabelings(alertRelabelings) +``` + +"Relabeling configs applied before sending alerts to a specific Alertmanager.\nIt requires Prometheus >= v2.51.0." + +### fn spec.alerting.alertmanagers.withAlertRelabelingsMixin + +```ts +withAlertRelabelingsMixin(alertRelabelings) +``` + +"Relabeling configs applied before sending alerts to a specific Alertmanager.\nIt requires Prometheus >= v2.51.0." + +**Note:** This function appends passed data to existing values + +### fn spec.alerting.alertmanagers.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the Alertmanager API that Prometheus uses to send alerts.\nIt can be \"v1\" or \"v2\"." + +### fn spec.alerting.alertmanagers.withBearerTokenFile + +```ts +withBearerTokenFile(bearerTokenFile) +``` + +"File to read bearer token for Alertmanager.\n\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `sigv4`.\n\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`." + +### fn spec.alerting.alertmanagers.withEnableHttp2 + +```ts +withEnableHttp2(enableHttp2) +``` + +"Whether to enable HTTP2." + +### fn spec.alerting.alertmanagers.withName + +```ts +withName(name) +``` + +"Name of the Endpoints object in the namespace." + +### fn spec.alerting.alertmanagers.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the Endpoints object.\n\n\nIf not set, the object will be discovered in the namespace of the\nPrometheus object." + +### fn spec.alerting.alertmanagers.withPathPrefix + +```ts +withPathPrefix(pathPrefix) +``` + +"Prefix for the HTTP path alerts are pushed to." + +### fn spec.alerting.alertmanagers.withPort + +```ts +withPort(port) +``` + +"Port on which the Alertmanager API is exposed." + +### fn spec.alerting.alertmanagers.withRelabelings + +```ts +withRelabelings(relabelings) +``` + +"Relabel configuration applied to the discovered Alertmanagers." + +### fn spec.alerting.alertmanagers.withRelabelingsMixin + +```ts +withRelabelingsMixin(relabelings) +``` + +"Relabel configuration applied to the discovered Alertmanagers." + +**Note:** This function appends passed data to existing values + +### fn spec.alerting.alertmanagers.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use when firing alerts." + +### fn spec.alerting.alertmanagers.withTimeout + +```ts +withTimeout(timeout) +``` + +"Timeout is a per-target Alertmanager timeout when pushing alerts." + +## obj spec.alerting.alertmanagers.alertRelabelings + +"Relabeling configs applied before sending alerts to a specific Alertmanager.\nIt requires Prometheus >= v2.51.0." + +### fn spec.alerting.alertmanagers.alertRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.alerting.alertmanagers.alertRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.alerting.alertmanagers.alertRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.alerting.alertmanagers.alertRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.alerting.alertmanagers.alertRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.alerting.alertmanagers.alertRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.alerting.alertmanagers.alertRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.alerting.alertmanagers.alertRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.alerting.alertmanagers.authorization + +"Authorization section for Alertmanager.\n\n\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `sigv4`." + +### fn spec.alerting.alertmanagers.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.alerting.alertmanagers.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.alerting.alertmanagers.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alerting.alertmanagers.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alerting.alertmanagers.basicAuth + +"BasicAuth configuration for Alertmanager.\n\n\nCannot be set at the same time as `bearerTokenFile`, `authorization` or `sigv4`." + +## obj spec.alerting.alertmanagers.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.alerting.alertmanagers.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alerting.alertmanagers.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alerting.alertmanagers.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.alerting.alertmanagers.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alerting.alertmanagers.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alerting.alertmanagers.relabelings + +"Relabel configuration applied to the discovered Alertmanagers." + +### fn spec.alerting.alertmanagers.relabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.alerting.alertmanagers.relabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.alerting.alertmanagers.relabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.alerting.alertmanagers.relabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.alerting.alertmanagers.relabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.alerting.alertmanagers.relabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.alerting.alertmanagers.relabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.alerting.alertmanagers.relabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.alerting.alertmanagers.sigv4 + +"Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\n\n\nIt requires Prometheus >= v2.48.0.\n\n\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `authorization`." + +### fn spec.alerting.alertmanagers.sigv4.withProfile + +```ts +withProfile(profile) +``` + +"Profile is the named AWS profile used to authenticate." + +### fn spec.alerting.alertmanagers.sigv4.withRegion + +```ts +withRegion(region) +``` + +"Region is the AWS region. If blank, the region from the default credentials chain used." + +### fn spec.alerting.alertmanagers.sigv4.withRoleArn + +```ts +withRoleArn(roleArn) +``` + +"RoleArn is the named AWS profile used to authenticate." + +## obj spec.alerting.alertmanagers.sigv4.accessKey + +"AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used." + +### fn spec.alerting.alertmanagers.sigv4.accessKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alerting.alertmanagers.sigv4.accessKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.sigv4.accessKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alerting.alertmanagers.sigv4.secretKey + +"SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used." + +### fn spec.alerting.alertmanagers.sigv4.secretKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alerting.alertmanagers.sigv4.secretKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.sigv4.secretKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alerting.alertmanagers.tlsConfig + +"TLS Config to use for Alertmanager." + +### fn spec.alerting.alertmanagers.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.alerting.alertmanagers.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.alerting.alertmanagers.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.alerting.alertmanagers.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.alerting.alertmanagers.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.alerting.alertmanagers.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.alerting.alertmanagers.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.alerting.alertmanagers.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.alerting.alertmanagers.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.alerting.alertmanagers.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.alerting.alertmanagers.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.tlsConfig.ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alerting.alertmanagers.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alerting.alertmanagers.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.alerting.alertmanagers.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.alerting.alertmanagers.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.alerting.alertmanagers.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alerting.alertmanagers.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alerting.alertmanagers.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alerting.alertmanagers.tlsConfig.keySecret.withOptional + +```ts +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 the\nKuberntees API server.\nIf null, Prometheus is assumed to run inside of the cluster: it will\ndiscover the API servers automatically and use the Pod's CA certificate\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/." + +### fn spec.apiserverConfig.withBearerToken + +```ts +withBearerToken(bearerToken) +``` + +"*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\n\nDeprecated: this will be removed in a future release." + +### fn spec.apiserverConfig.withBearerTokenFile + +```ts +withBearerTokenFile(bearerTokenFile) +``` + +"File to read bearer token for accessing apiserver.\n\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`.\n\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`." + +### fn spec.apiserverConfig.withHost + +```ts +withHost(host) +``` + +"Kubernetes API address consisting of a hostname or IP address followed\nby an optional port number." + +## obj spec.apiserverConfig.authorization + +"Authorization section for the API server.\n\n\nCannot be set at the same time as `basicAuth`, `bearerToken`, or\n`bearerTokenFile`." + +### fn spec.apiserverConfig.authorization.withCredentialsFile + +```ts +withCredentialsFile(credentialsFile) +``` + +"File to read a secret from, mutually exclusive with `credentials`." + +### fn spec.apiserverConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.apiserverConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.apiserverConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.apiserverConfig.basicAuth + +"BasicAuth configuration for the API server.\n\n\nCannot be set at the same time as `authorization`, `bearerToken`, or\n`bearerTokenFile`." + +## obj spec.apiserverConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.apiserverConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.apiserverConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.apiserverConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.apiserverConfig.tlsConfig + +"TLS Config to use for the API server." + +### fn spec.apiserverConfig.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.apiserverConfig.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.apiserverConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.apiserverConfig.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.apiserverConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.apiserverConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.apiserverConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.apiserverConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.apiserverConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.apiserverConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.apiserverConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.apiserverConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.apiserverConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.apiserverConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.apiserverConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.arbitraryFSAccessThroughSMs + +"When true, ServiceMonitor, PodMonitor and Probe object are forbidden to\nreference arbitrary files on the file system of the 'prometheus'\ncontainer.\nWhen a ServiceMonitor's endpoint specifies a `bearerTokenFile` value\n(e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a\nmalicious target can get access to the Prometheus service account's\ntoken in the Prometheus' scrape request. Setting\n`spec.arbitraryFSAccessThroughSM` to 'true' would prevent the attack.\nUsers should instead provide the credentials using the\n`spec.bearerTokenSecret` field." + +### fn spec.arbitraryFSAccessThroughSMs.withDeny + +```ts +withDeny(deny) +``` + + + +## obj spec.containers + +"Containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +### fn spec.containers.withArgs + +```ts +withArgs(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.containers.withArgsMixin + +```ts +withArgsMixin(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withCommand(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.containers.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.containers.withEnvFrom + +```ts +withEnvFrom(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.containers.withEnvFromMixin + +```ts +withEnvFromMixin(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withImage + +```ts +withImage(image) +``` + +"Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets." + +### fn spec.containers.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + +### fn spec.containers.withName + +```ts +withName(name) +``` + +"Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + +### fn spec.containers.withPorts + +```ts +withPorts(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.containers.withPortsMixin + +```ts +withPortsMixin(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withResizePolicy + +```ts +withResizePolicy(resizePolicy) +``` + +"Resources resize policy for the container." + +### fn spec.containers.withResizePolicyMixin + +```ts +withResizePolicyMixin(resizePolicy) +``` + +"Resources resize policy for the container." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted." + +### fn spec.containers.withStdin + +```ts +withStdin(stdin) +``` + +"Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false." + +### fn spec.containers.withStdinOnce + +```ts +withStdinOnce(stdinOnce) +``` + +"Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false" + +### fn spec.containers.withTerminationMessagePath + +```ts +withTerminationMessagePath(terminationMessagePath) +``` + +"Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated." + +### fn spec.containers.withTerminationMessagePolicy + +```ts +withTerminationMessagePolicy(terminationMessagePolicy) +``` + +"Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated." + +### fn spec.containers.withTty + +```ts +withTty(tty) +``` + +"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false." + +### fn spec.containers.withVolumeDevices + +```ts +withVolumeDevices(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.containers.withVolumeDevicesMixin + +```ts +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 + +```ts +withVolumeMounts(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +### fn spec.containers.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withWorkingDir + +```ts +withWorkingDir(workingDir) +``` + +"Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated." + +## obj spec.containers.env + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.containers.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.containers.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"." + +## obj spec.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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.containers.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.env.valueFrom.configMapKeyRef.withOptional + +```ts +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['']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.containers.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.containers.env.valueFrom.fieldRef.withFieldPath + +```ts +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\n(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 + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.containers.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.containers.env.valueFrom.resourceFieldRef.withResource + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.containers.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.env.valueFrom.secretKeyRef.withOptional + +```ts +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.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.containers.envFrom.withPrefix + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.envFrom.configMapRef.withOptional + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.envFrom.secretRef.withOptional + +```ts +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.\nCannot be updated." + +## obj spec.containers.lifecycle.postStart + +"PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.containers.lifecycle.postStart.exec + +"Exec specifies the action to take." + +### fn spec.containers.lifecycle.postStart.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.lifecycle.postStart.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.lifecycle.postStart.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.lifecycle.postStart.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.lifecycle.postStart.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.lifecycle.postStart.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.lifecycle.postStart.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.lifecycle.postStart.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.containers.lifecycle.postStart.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.containers.lifecycle.postStart.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.containers.lifecycle.postStart.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.lifecycle.postStart.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.lifecycle.preStop + +"PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.containers.lifecycle.preStop.exec + +"Exec specifies the action to take." + +### fn spec.containers.lifecycle.preStop.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.lifecycle.preStop.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.lifecycle.preStop.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.lifecycle.preStop.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.lifecycle.preStop.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.lifecycle.preStop.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.lifecycle.preStop.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.lifecycle.preStop.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.containers.lifecycle.preStop.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.containers.lifecycle.preStop.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.containers.lifecycle.preStop.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.lifecycle.preStop.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.livenessProbe + +"Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.livenessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.livenessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.livenessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.livenessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.livenessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.livenessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.livenessProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.livenessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.livenessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.livenessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.livenessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.livenessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.livenessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.livenessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.livenessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.livenessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.livenessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.livenessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.livenessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.livenessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.livenessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.ports + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.containers.ports.withContainerPort + +```ts +withContainerPort(containerPort) +``` + +"Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536." + +### fn spec.containers.ports.withHostIP + +```ts +withHostIP(hostIP) +``` + +"What host IP to bind the external port to." + +### fn spec.containers.ports.withHostPort + +```ts +withHostPort(hostPort) +``` + +"Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this." + +### fn spec.containers.ports.withName + +```ts +withName(name) +``` + +"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services." + +### fn spec.containers.ports.withProtocol + +```ts +withProtocol(protocol) +``` + +"Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\"." + +## obj spec.containers.readinessProbe + +"Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.readinessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.readinessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.readinessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.readinessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.readinessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.readinessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.readinessProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.readinessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.readinessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.readinessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.readinessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.readinessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.readinessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.readinessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.readinessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.readinessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.readinessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.readinessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.readinessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.readinessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.readinessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.resizePolicy + +"Resources resize policy for the container." + +### fn spec.containers.resizePolicy.withResourceName + +```ts +withResourceName(resourceName) +``` + +"Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + +### fn spec.containers.resizePolicy.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + +## obj spec.containers.resources + +"Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.containers.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.containers.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.containers.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.containers.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.containers.securityContext + +"SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.containers.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.containers.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +## obj spec.containers.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.containers.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.containers.securityContext.capabilities + +"The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.containers.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.containers.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.containers.securityContext.capabilities.withDropMixin + +```ts +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.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.containers.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.containers.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.containers.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.containers.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.containers.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.containers.startupProbe + +"StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.startupProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.startupProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.startupProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.startupProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.startupProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.startupProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.startupProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.startupProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.startupProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.startupProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.startupProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.startupProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.startupProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.startupProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.startupProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.startupProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.startupProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.startupProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.startupProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.startupProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.startupProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName 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 + +```ts +withDevicePath(devicePath) +``` + +"devicePath is the path inside of the container that the device will be mapped to." + +### fn spec.containers.volumeDevices.withName + +```ts +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.\nCannot be updated." + +### fn spec.containers.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.containers.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.containers.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.containers.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.containers.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.containers.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.containers.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.excludedFromEnforcement + +"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true." + +### fn spec.excludedFromEnforcement.withGroup + +```ts +withGroup(group) +``` + +"Group of the referent. When not specified, it defaults to `monitoring.coreos.com`" + +### fn spec.excludedFromEnforcement.withName + +```ts +withName(name) +``` + +"Name of the referent. When not set, all resources in the namespace are matched." + +### fn spec.excludedFromEnforcement.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/" + +### fn spec.excludedFromEnforcement.withResource + +```ts +withResource(resource) +``` + +"Resource of the referent." + +## obj spec.exemplars + +"Exemplars related settings that are runtime reloadable.\nIt requires to enable the `exemplar-storage` feature flag to be effective." + +### fn spec.exemplars.withMaxSize + +```ts +withMaxSize(maxSize) +``` + +"Maximum number of exemplars stored in memory for all series.\n\n\nexemplar-storage itself must be enabled using the `spec.enableFeature`\noption for exemplars to be scraped in the first place.\n\n\nIf not set, Prometheus uses its default value. A value of zero or less\nthan zero disables the storage." + +## obj spec.hostAliases + +"Optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified." + +### fn spec.hostAliases.withHostnames + +```ts +withHostnames(hostnames) +``` + +"Hostnames for the above IP address." + +### fn spec.hostAliases.withHostnamesMixin + +```ts +withHostnamesMixin(hostnames) +``` + +"Hostnames for the above IP address." + +**Note:** This function appends passed data to existing values + +### fn spec.hostAliases.withIp + +```ts +withIp(ip) +``` + +"IP address of the host file entry." + +## obj spec.imagePullSecrets + +"An optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +### fn spec.imagePullSecrets.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.initContainers + +"InitContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +### fn spec.initContainers.withArgs + +```ts +withArgs(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.initContainers.withArgsMixin + +```ts +withArgsMixin(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withCommand(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.initContainers.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.initContainers.withEnvFrom + +```ts +withEnvFrom(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.initContainers.withEnvFromMixin + +```ts +withEnvFromMixin(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withImage + +```ts +withImage(image) +``` + +"Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets." + +### fn spec.initContainers.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + +### fn spec.initContainers.withName + +```ts +withName(name) +``` + +"Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + +### fn spec.initContainers.withPorts + +```ts +withPorts(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.initContainers.withPortsMixin + +```ts +withPortsMixin(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withResizePolicy + +```ts +withResizePolicy(resizePolicy) +``` + +"Resources resize policy for the container." + +### fn spec.initContainers.withResizePolicyMixin + +```ts +withResizePolicyMixin(resizePolicy) +``` + +"Resources resize policy for the container." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted." + +### fn spec.initContainers.withStdin + +```ts +withStdin(stdin) +``` + +"Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false." + +### fn spec.initContainers.withStdinOnce + +```ts +withStdinOnce(stdinOnce) +``` + +"Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false" + +### fn spec.initContainers.withTerminationMessagePath + +```ts +withTerminationMessagePath(terminationMessagePath) +``` + +"Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated." + +### fn spec.initContainers.withTerminationMessagePolicy + +```ts +withTerminationMessagePolicy(terminationMessagePolicy) +``` + +"Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated." + +### fn spec.initContainers.withTty + +```ts +withTty(tty) +``` + +"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false." + +### fn spec.initContainers.withVolumeDevices + +```ts +withVolumeDevices(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.initContainers.withVolumeDevicesMixin + +```ts +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 + +```ts +withVolumeMounts(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +### fn spec.initContainers.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withWorkingDir + +```ts +withWorkingDir(workingDir) +``` + +"Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated." + +## obj spec.initContainers.env + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.initContainers.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.initContainers.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"." + +## obj spec.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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.initContainers.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.env.valueFrom.configMapKeyRef.withOptional + +```ts +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['']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.initContainers.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.initContainers.env.valueFrom.fieldRef.withFieldPath + +```ts +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\n(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 + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.initContainers.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.initContainers.env.valueFrom.resourceFieldRef.withResource + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.initContainers.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.env.valueFrom.secretKeyRef.withOptional + +```ts +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.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.initContainers.envFrom.withPrefix + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.envFrom.configMapRef.withOptional + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.envFrom.secretRef.withOptional + +```ts +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.\nCannot be updated." + +## obj spec.initContainers.lifecycle.postStart + +"PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.initContainers.lifecycle.postStart.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.lifecycle.postStart.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.lifecycle.postStart.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.lifecycle.postStart.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.lifecycle.postStart.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.initContainers.lifecycle.postStart.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.initContainers.lifecycle.postStart.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.initContainers.lifecycle.postStart.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.lifecycle.postStart.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.lifecycle.preStop + +"PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.initContainers.lifecycle.preStop.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.lifecycle.preStop.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.lifecycle.preStop.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.lifecycle.preStop.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.lifecycle.preStop.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.initContainers.lifecycle.preStop.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.initContainers.lifecycle.preStop.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.initContainers.lifecycle.preStop.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.lifecycle.preStop.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.livenessProbe + +"Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.livenessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.livenessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.livenessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.livenessProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.livenessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.livenessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.livenessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.livenessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.livenessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.livenessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.livenessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.livenessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.livenessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.livenessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.livenessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.livenessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.livenessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.livenessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.ports + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.initContainers.ports.withContainerPort + +```ts +withContainerPort(containerPort) +``` + +"Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536." + +### fn spec.initContainers.ports.withHostIP + +```ts +withHostIP(hostIP) +``` + +"What host IP to bind the external port to." + +### fn spec.initContainers.ports.withHostPort + +```ts +withHostPort(hostPort) +``` + +"Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this." + +### fn spec.initContainers.ports.withName + +```ts +withName(name) +``` + +"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services." + +### fn spec.initContainers.ports.withProtocol + +```ts +withProtocol(protocol) +``` + +"Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\"." + +## obj spec.initContainers.readinessProbe + +"Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.readinessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.readinessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.readinessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.readinessProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.readinessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.readinessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.readinessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.readinessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.readinessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.readinessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.readinessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.readinessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.readinessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.readinessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.readinessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.readinessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.readinessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.readinessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.resizePolicy + +"Resources resize policy for the container." + +### fn spec.initContainers.resizePolicy.withResourceName + +```ts +withResourceName(resourceName) +``` + +"Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + +### fn spec.initContainers.resizePolicy.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + +## obj spec.initContainers.resources + +"Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.initContainers.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.initContainers.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.initContainers.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.initContainers.securityContext + +"SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.initContainers.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.initContainers.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +## obj spec.initContainers.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.initContainers.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.initContainers.securityContext.capabilities + +"The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.initContainers.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.initContainers.securityContext.capabilities.withDropMixin + +```ts +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.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.initContainers.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.initContainers.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.initContainers.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.initContainers.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.initContainers.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.initContainers.startupProbe + +"StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.startupProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.startupProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.startupProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.startupProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.startupProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.startupProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.startupProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.startupProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.startupProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.startupProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.startupProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.startupProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.startupProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.startupProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.startupProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.startupProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.startupProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.startupProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName 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 + +```ts +withDevicePath(devicePath) +``` + +"devicePath is the path inside of the container that the device will be mapped to." + +### fn spec.initContainers.volumeDevices.withName + +```ts +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.\nCannot be updated." + +### fn spec.initContainers.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.initContainers.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.initContainers.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.initContainers.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.initContainers.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.initContainers.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.initContainers.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.persistentVolumeClaimRetentionPolicy + +"The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\nThe default behavior is all PVCs are retained.\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\nIt requires enabling the StatefulSetAutoDeletePVC feature gate." + +### fn spec.persistentVolumeClaimRetentionPolicy.withWhenDeleted + +```ts +withWhenDeleted(whenDeleted) +``` + +"WhenDeleted specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is deleted. The default policy\nof `Retain` causes PVCs to not be affected by StatefulSet deletion. The\n`Delete` policy causes those PVCs to be deleted." + +### fn spec.persistentVolumeClaimRetentionPolicy.withWhenScaled + +```ts +withWhenScaled(whenScaled) +``` + +"WhenScaled specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is scaled down. The default\npolicy of `Retain` causes PVCs to not be affected by a scaledown. The\n`Delete` policy causes the associated PVCs for any excess pods above\nthe replica count to be deleted." + +## obj spec.podMetadata + +"PodMetadata configures labels and annotations which are propagated to the Prometheus pods.\n\n\nThe following items are reserved and cannot be overridden:\n* \"prometheus\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/instance\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"prometheus\".\n* \"app.kubernetes.io/version\" label, set to the Prometheus version.\n* \"operator.prometheus.io/name\" label, set to the name of the Prometheus object.\n* \"operator.prometheus.io/shard\" label, set to the shard number of the Prometheus object.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"prometheus\"." + +### fn spec.podMetadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +### fn spec.podMetadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn spec.podMetadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +### fn spec.podMetadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn spec.podMetadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + +## obj spec.podMonitorNamespaceSelector + +"Namespaces to match for PodMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only." + +### fn spec.podMonitorNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.podMonitorNamespaceSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.podMonitorNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.podMonitorNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.podMonitorNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.podMonitorNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.podMonitorNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.podMonitorNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.podMonitorSelector + +"PodMonitors to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead." + +### fn spec.podMonitorSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.podMonitorSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.podMonitorSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.podMonitorSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.podMonitorSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.podMonitorSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.podMonitorSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.podMonitorSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.probeNamespaceSelector + +"Namespaces to match for Probe discovery. An empty label\nselector matches all namespaces. A null label selector matches the\ncurrent namespace only." + +### fn spec.probeNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.probeNamespaceSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.probeNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.probeNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.probeNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.probeNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.probeNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.probeNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.probeSelector + +"Probes to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead." + +### fn spec.probeSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.probeSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.probeSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.probeSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.probeSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.probeSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.probeSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.probeSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.prometheusRulesExcludedFromEnforce + +"Defines the list of PrometheusRule objects to which the namespace label\nenforcement doesn't apply.\nThis is only relevant when `spec.enforcedNamespaceLabel` is set to true.\nDeprecated: use `spec.excludedFromEnforcement` instead." + +### fn spec.prometheusRulesExcludedFromEnforce.withRuleName + +```ts +withRuleName(ruleName) +``` + +"Name of the excluded PrometheusRule object." + +### fn spec.prometheusRulesExcludedFromEnforce.withRuleNamespace + +```ts +withRuleNamespace(ruleNamespace) +``` + +"Namespace of the excluded PrometheusRule object." + +## obj spec.query + +"QuerySpec defines the configuration of the Promethus query service." + +### fn spec.query.withLookbackDelta + +```ts +withLookbackDelta(lookbackDelta) +``` + +"The delta difference allowed for retrieving metrics during expression evaluations." + +### fn spec.query.withMaxConcurrency + +```ts +withMaxConcurrency(maxConcurrency) +``` + +"Number of concurrent queries that can be run at once." + +### fn spec.query.withMaxSamples + +```ts +withMaxSamples(maxSamples) +``` + +"Maximum number of samples a single query can load into memory. Note that\nqueries will fail if they would load more samples than this into memory,\nso this also limits the number of samples a query can return." + +### fn spec.query.withTimeout + +```ts +withTimeout(timeout) +``` + +"Maximum time a query may take before being aborted." + +## obj spec.remoteRead + +"Defines the list of remote read configurations." + +### fn spec.remoteRead.withBearerToken + +```ts +withBearerToken(bearerToken) +``` + +"*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\n\nDeprecated: this will be removed in a future release." + +### fn spec.remoteRead.withBearerTokenFile + +```ts +withBearerTokenFile(bearerTokenFile) +``` + +"File from which to read the bearer token for the URL.\n\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`." + +### fn spec.remoteRead.withFilterExternalLabels + +```ts +withFilterExternalLabels(filterExternalLabels) +``` + +"Whether to use the external labels as selectors for the remote read endpoint.\n\n\nIt requires Prometheus >= v2.34.0." + +### fn spec.remoteRead.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects.\n\n\nIt requires Prometheus >= v2.26.0." + +### fn spec.remoteRead.withHeaders + +```ts +withHeaders(headers) +``` + +"Custom HTTP headers to be sent along with each remote read request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\nOnly valid in Prometheus versions 2.26.0 and newer." + +### fn spec.remoteRead.withHeadersMixin + +```ts +withHeadersMixin(headers) +``` + +"Custom HTTP headers to be sent along with each remote read request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\nOnly valid in Prometheus versions 2.26.0 and newer." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteRead.withName + +```ts +withName(name) +``` + +"The name of the remote read queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate read\nconfigurations.\n\n\nIt requires Prometheus >= v2.15.0." + +### fn spec.remoteRead.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteRead.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteRead.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteRead.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteRead.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteRead.withReadRecent + +```ts +withReadRecent(readRecent) +``` + +"Whether reads should be made for queries for time ranges that\nthe local storage should have complete data for." + +### fn spec.remoteRead.withRemoteTimeout + +```ts +withRemoteTimeout(remoteTimeout) +``` + +"Timeout for requests to the remote read endpoint." + +### fn spec.remoteRead.withRequiredMatchers + +```ts +withRequiredMatchers(requiredMatchers) +``` + +"An optional list of equality matchers which have to be present\nin a selector to query the remote read endpoint." + +### fn spec.remoteRead.withRequiredMatchersMixin + +```ts +withRequiredMatchersMixin(requiredMatchers) +``` + +"An optional list of equality matchers which have to be present\nin a selector to query the remote read endpoint." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteRead.withUrl + +```ts +withUrl(url) +``` + +"The URL of the endpoint to query from." + +## obj spec.remoteRead.authorization + +"Authorization section for the URL.\n\n\nIt requires Prometheus >= v2.26.0.\n\n\nCannot be set at the same time as `basicAuth`, or `oauth2`." + +### fn spec.remoteRead.authorization.withCredentialsFile + +```ts +withCredentialsFile(credentialsFile) +``` + +"File to read a secret from, mutually exclusive with `credentials`." + +### fn spec.remoteRead.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.remoteRead.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.remoteRead.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteRead.basicAuth + +"BasicAuth configuration for the URL.\n\n\nCannot be set at the same time as `authorization`, or `oauth2`." + +## obj spec.remoteRead.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.remoteRead.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteRead.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.remoteRead.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteRead.oauth2 + +"OAuth2 configuration for the URL.\n\n\nIt requires Prometheus >= v2.27.0.\n\n\nCannot be set at the same time as `authorization`, or `basicAuth`." + +### fn spec.remoteRead.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.remoteRead.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteRead.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteRead.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteRead.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteRead.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteRead.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteRead.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.remoteRead.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteRead.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.remoteRead.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.remoteRead.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteRead.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteRead.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.oauth2.clientId.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteRead.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.remoteRead.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteRead.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteRead.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.remoteRead.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.remoteRead.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.remoteRead.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.remoteRead.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.remoteRead.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteRead.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteRead.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.remoteRead.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.remoteRead.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteRead.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.remoteRead.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteRead.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteRead.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.remoteRead.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.remoteRead.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteRead.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.remoteRead.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteRead.tlsConfig + +"TLS Config to use for the URL." + +### fn spec.remoteRead.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.remoteRead.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.remoteRead.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.remoteRead.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.remoteRead.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.remoteRead.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.remoteRead.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.remoteRead.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.remoteRead.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteRead.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteRead.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.tlsConfig.ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteRead.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.remoteRead.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteRead.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteRead.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteRead.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteRead.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite + +"Defines the list of remote write configurations." + +### fn spec.remoteWrite.withBearerToken + +```ts +withBearerToken(bearerToken) +``` + +"*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\n\nDeprecated: this will be removed in a future release." + +### fn spec.remoteWrite.withBearerTokenFile + +```ts +withBearerTokenFile(bearerTokenFile) +``` + +"File from which to read bearer token for the URL.\n\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`." + +### fn spec.remoteWrite.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.remoteWrite.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects.\n\n\nIt requires Prometheus >= v2.26.0." + +### fn spec.remoteWrite.withHeaders + +```ts +withHeaders(headers) +``` + +"Custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\n\nIt requires Prometheus >= v2.25.0." + +### fn spec.remoteWrite.withHeadersMixin + +```ts +withHeadersMixin(headers) +``` + +"Custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\n\nIt requires Prometheus >= v2.25.0." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.withName + +```ts +withName(name) +``` + +"The name of the remote write queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate queues.\n\n\nIt requires Prometheus >= v2.15.0." + +### fn spec.remoteWrite.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.withRemoteTimeout + +```ts +withRemoteTimeout(remoteTimeout) +``` + +"Timeout for requests to the remote write endpoint." + +### fn spec.remoteWrite.withSendExemplars + +```ts +withSendExemplars(sendExemplars) +``` + +"Enables sending of exemplars over remote write. Note that\nexemplar-storage itself must be enabled using the `spec.enableFeature`\noption for exemplars to be scraped in the first place.\n\n\nIt requires Prometheus >= v2.27.0." + +### fn spec.remoteWrite.withSendNativeHistograms + +```ts +withSendNativeHistograms(sendNativeHistograms) +``` + +"Enables sending of native histograms, also known as sparse histograms\nover remote write.\n\n\nIt requires Prometheus >= v2.40.0." + +### fn spec.remoteWrite.withUrl + +```ts +withUrl(url) +``` + +"The URL of the endpoint to send samples to." + +### fn spec.remoteWrite.withWriteRelabelConfigs + +```ts +withWriteRelabelConfigs(writeRelabelConfigs) +``` + +"The list of remote write relabel configurations." + +### fn spec.remoteWrite.withWriteRelabelConfigsMixin + +```ts +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 the URL.\n\n\nIt requires Prometheus >= v2.26.0.\n\n\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`." + +### fn spec.remoteWrite.authorization.withCredentialsFile + +```ts +withCredentialsFile(credentialsFile) +``` + +"File to read a secret from, mutually exclusive with `credentials`." + +### fn spec.remoteWrite.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.remoteWrite.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.remoteWrite.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.azureAd + +"AzureAD for the URL.\n\n\nIt requires Prometheus >= v2.45.0.\n\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`." + +### fn spec.remoteWrite.azureAd.withCloud + +```ts +withCloud(cloud) +``` + +"The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'." + +## obj spec.remoteWrite.azureAd.managedIdentity + +"ManagedIdentity defines the Azure User-assigned Managed identity.\nCannot be set at the same time as `oauth` or `sdk`." + +### fn spec.remoteWrite.azureAd.managedIdentity.withClientId + +```ts +withClientId(clientId) +``` + +"The client id" + +## obj spec.remoteWrite.azureAd.oauth + +"OAuth defines the oauth config that is being used to authenticate.\nCannot be set at the same time as `managedIdentity` or `sdk`.\n\n\nIt requires Prometheus >= v2.48.0." + +### fn spec.remoteWrite.azureAd.oauth.withClientId + +```ts +withClientId(clientId) +``` + +"`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate." + +### fn spec.remoteWrite.azureAd.oauth.withTenantId + +```ts +withTenantId(tenantId) +``` + +"`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate." + +## obj spec.remoteWrite.azureAd.oauth.clientSecret + +"`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate." + +### fn spec.remoteWrite.azureAd.oauth.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.azureAd.oauth.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.azureAd.oauth.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.azureAd.sdk + +"SDK defines the Azure SDK config that is being used to authenticate.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\nCannot be set at the same time as `oauth` or `managedIdentity`.\n\n\nIt requires Prometheus >= 2.52.0." + +### fn spec.remoteWrite.azureAd.sdk.withTenantId + +```ts +withTenantId(tenantId) +``` + +"`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate." + +## obj spec.remoteWrite.basicAuth + +"BasicAuth configuration for the URL.\n\n\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`." + +## obj spec.remoteWrite.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.remoteWrite.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.remoteWrite.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.metadataConfig + +"MetadataConfig configures the sending of series metadata to the remote storage." + +### fn spec.remoteWrite.metadataConfig.withSend + +```ts +withSend(send) +``` + +"Defines whether metric metadata is sent to the remote storage or not." + +### fn spec.remoteWrite.metadataConfig.withSendInterval + +```ts +withSendInterval(sendInterval) +``` + +"Defines how frequently metric metadata is sent to the remote storage." + +## obj spec.remoteWrite.oauth2 + +"OAuth2 configuration for the URL.\n\n\nIt requires Prometheus >= v2.27.0.\n\n\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`." + +### fn spec.remoteWrite.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.remoteWrite.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.remoteWrite.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.remoteWrite.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.remoteWrite.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.clientId.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.remoteWrite.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.remoteWrite.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.remoteWrite.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.remoteWrite.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.remoteWrite.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.remoteWrite.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.remoteWrite.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.keySecret.withOptional + +```ts +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 + +```ts +withBatchSendDeadline(batchSendDeadline) +``` + +"BatchSendDeadline is the maximum time a sample will wait in buffer." + +### fn spec.remoteWrite.queueConfig.withCapacity + +```ts +withCapacity(capacity) +``` + +"Capacity is the number of samples to buffer per shard before we start\ndropping them." + +### fn spec.remoteWrite.queueConfig.withMaxBackoff + +```ts +withMaxBackoff(maxBackoff) +``` + +"MaxBackoff is the maximum retry delay." + +### fn spec.remoteWrite.queueConfig.withMaxRetries + +```ts +withMaxRetries(maxRetries) +``` + +"MaxRetries is the maximum number of times to retry a batch on recoverable errors." + +### fn spec.remoteWrite.queueConfig.withMaxSamplesPerSend + +```ts +withMaxSamplesPerSend(maxSamplesPerSend) +``` + +"MaxSamplesPerSend is the maximum number of samples per send." + +### fn spec.remoteWrite.queueConfig.withMaxShards + +```ts +withMaxShards(maxShards) +``` + +"MaxShards is the maximum number of shards, i.e. amount of concurrency." + +### fn spec.remoteWrite.queueConfig.withMinBackoff + +```ts +withMinBackoff(minBackoff) +``` + +"MinBackoff is the initial retry delay. Gets doubled for every retry." + +### fn spec.remoteWrite.queueConfig.withMinShards + +```ts +withMinShards(minShards) +``` + +"MinShards is the minimum number of shards, i.e. amount of concurrency." + +### fn spec.remoteWrite.queueConfig.withRetryOnRateLimit + +```ts +withRetryOnRateLimit(retryOnRateLimit) +``` + +"Retry upon receiving a 429 status code from the remote-write storage.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.remoteWrite.queueConfig.withSampleAgeLimit + +```ts +withSampleAgeLimit(sampleAgeLimit) +``` + +"SampleAgeLimit drops samples older than the limit.\nIt requires Prometheus >= v2.50.0." + +## obj spec.remoteWrite.sigv4 + +"Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\n\n\nIt requires Prometheus >= v2.26.0.\n\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`." + +### fn spec.remoteWrite.sigv4.withProfile + +```ts +withProfile(profile) +``` + +"Profile is the named AWS profile used to authenticate." + +### fn spec.remoteWrite.sigv4.withRegion + +```ts +withRegion(region) +``` + +"Region is the AWS region. If blank, the region from the default credentials chain used." + +### fn spec.remoteWrite.sigv4.withRoleArn + +```ts +withRoleArn(roleArn) +``` + +"RoleArn is the named AWS profile used to authenticate." + +## obj spec.remoteWrite.sigv4.accessKey + +"AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used." + +### fn spec.remoteWrite.sigv4.accessKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.sigv4.accessKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.sigv4.accessKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.sigv4.secretKey + +"SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used." + +### fn spec.remoteWrite.sigv4.secretKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.sigv4.secretKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.sigv4.secretKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.tlsConfig + +"TLS Config to use for the URL." + +### fn spec.remoteWrite.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.remoteWrite.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.remoteWrite.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.remoteWrite.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.remoteWrite.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.remoteWrite.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.remoteWrite.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.remoteWrite.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.remoteWrite.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.remoteWrite.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.keySecret.withOptional + +```ts +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 + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.remoteWrite.writeRelabelConfigs.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.remoteWrite.writeRelabelConfigs.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.remoteWrite.writeRelabelConfigs.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.remoteWrite.writeRelabelConfigs.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.remoteWrite.writeRelabelConfigs.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.remoteWrite.writeRelabelConfigs.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.writeRelabelConfigs.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.resources + +"Defines the resources requests and limits of the 'prometheus' container." + +### fn spec.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.ruleNamespaceSelector + +"Namespaces to match for PrometheusRule discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only." + +### fn spec.ruleNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.ruleNamespaceSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.ruleNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.ruleNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.ruleNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.ruleNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.ruleNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.ruleNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.ruleSelector + +"PrometheusRule objects to be selected for rule evaluation. An empty\nlabel selector matches all objects. A null label selector matches no\nobjects." + +### fn spec.ruleSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.ruleSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.ruleSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.ruleSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.ruleSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.ruleSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.ruleSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.ruleSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.rules + +"Defines the configuration of the Prometheus rules' engine." + +## obj spec.rules.alert + +"Defines the parameters of the Prometheus rules' engine.\n\n\nAny update to these parameters trigger a restart of the pods." + +### fn spec.rules.alert.withForGracePeriod + +```ts +withForGracePeriod(forGracePeriod) +``` + +"Minimum duration between alert and restored 'for' state.\n\n\nThis is maintained only for alerts with a configured 'for' time greater\nthan the grace period." + +### fn spec.rules.alert.withForOutageTolerance + +```ts +withForOutageTolerance(forOutageTolerance) +``` + +"Max time to tolerate prometheus outage for restoring 'for' state of\nalert." + +### fn spec.rules.alert.withResendDelay + +```ts +withResendDelay(resendDelay) +``` + +"Minimum amount of time to wait before resending an alert to\nAlertmanager." + +## obj spec.scrapeClasses + +"List of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.scrapeClasses.withDefault + +```ts +withDefault(default) +``` + +"Default indicates that the scrape applies to all scrape objects that\ndon't configure an explicit scrape class name.\n\n\nOnly one scrape class can be set as the default." + +### fn spec.scrapeClasses.withMetricRelabelings + +```ts +withMetricRelabelings(metricRelabelings) +``` + +"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\n\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs" + +### fn spec.scrapeClasses.withMetricRelabelingsMixin + +```ts +withMetricRelabelingsMixin(metricRelabelings) +``` + +"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\n\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs" + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeClasses.withName + +```ts +withName(name) +``` + +"Name of the scrape class." + +### fn spec.scrapeClasses.withRelabelings + +```ts +withRelabelings(relabelings) +``` + +"Relabelings configures the relabeling rules to apply to all scrape targets.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.scrapeClasses.withRelabelingsMixin + +```ts +withRelabelingsMixin(relabelings) +``` + +"Relabelings configures the relabeling rules to apply to all scrape targets.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +**Note:** This function appends passed data to existing values + +## obj spec.scrapeClasses.attachMetadata + +"AttachMetadata configures additional metadata to the discovered targets.\nWhen the scrape object defines its own configuration, it takes\nprecedence over the scrape class configuration." + +### fn spec.scrapeClasses.attachMetadata.withNode + +```ts +withNode(node) +``` + +"When set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects." + +## obj spec.scrapeClasses.metricRelabelings + +"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\n\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs" + +### fn spec.scrapeClasses.metricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.scrapeClasses.metricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.scrapeClasses.metricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.scrapeClasses.metricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.scrapeClasses.metricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.scrapeClasses.metricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.scrapeClasses.metricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeClasses.metricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.scrapeClasses.relabelings + +"Relabelings configures the relabeling rules to apply to all scrape targets.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.scrapeClasses.relabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.scrapeClasses.relabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.scrapeClasses.relabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.scrapeClasses.relabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.scrapeClasses.relabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.scrapeClasses.relabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.scrapeClasses.relabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeClasses.relabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.scrapeClasses.tlsConfig + +"TLSConfig defines the TLS settings to use for the scrape. When the\nscrape objects define their own CA, certificate and/or key, they take\nprecedence over the corresponding scrape class fields.\n\n\nFor now only the `caFile`, `certFile` and `keyFile` fields are supported." + +### fn spec.scrapeClasses.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.scrapeClasses.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.scrapeClasses.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.scrapeClasses.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.scrapeClasses.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.scrapeClasses.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.scrapeClasses.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.scrapeClasses.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.scrapeClasses.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.scrapeClasses.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scrapeClasses.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.scrapeClasses.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.scrapeClasses.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.scrapeClasses.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.scrapeClasses.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scrapeClasses.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.scrapeClasses.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.scrapeClasses.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scrapeClasses.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.scrapeConfigNamespaceSelector + +"Namespaces to match for ScrapeConfig discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.\n\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level." + +### fn spec.scrapeConfigNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.scrapeConfigNamespaceSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeConfigNamespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.scrapeConfigNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.scrapeConfigNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.scrapeConfigNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.scrapeConfigNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.scrapeConfigNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.scrapeConfigNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.scrapeConfigSelector + +"ScrapeConfigs to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.\n\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level." + +### fn spec.scrapeConfigSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.scrapeConfigSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeConfigSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.scrapeConfigSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.scrapeConfigSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.scrapeConfigSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.scrapeConfigSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.scrapeConfigSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.scrapeConfigSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.securityContext + +"SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext." + +### fn spec.securityContext.withFsGroup + +```ts +withFsGroup(fsGroup) +``` + +"A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withFsGroupChangePolicy + +```ts +withFsGroupChangePolicy(fsGroupChangePolicy) +``` + +"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSupplementalGroups + +```ts +withSupplementalGroups(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSupplementalGroupsMixin + +```ts +withSupplementalGroupsMixin(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +### fn spec.securityContext.withSysctls + +```ts +withSysctls(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSysctlsMixin + +```ts +withSysctlsMixin(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +## obj spec.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.securityContext.seLinuxOptions + +"The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.securityContext.seccompProfile + +"The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.securityContext.sysctls + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.sysctls.withName + +```ts +withName(name) +``` + +"Name of a property to set" + +### fn spec.securityContext.sysctls.withValue + +```ts +withValue(value) +``` + +"Value of a property to set" + +## obj spec.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.serviceMonitorNamespaceSelector + +"Namespaces to match for ServicedMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only." + +### fn spec.serviceMonitorNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.serviceMonitorNamespaceSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.serviceMonitorNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.serviceMonitorNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.serviceMonitorNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.serviceMonitorNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.serviceMonitorNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.serviceMonitorNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.serviceMonitorSelector + +"ServiceMonitors to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead." + +### fn spec.serviceMonitorSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.serviceMonitorSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.serviceMonitorSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.serviceMonitorSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.serviceMonitorSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.serviceMonitorSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.serviceMonitorSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.serviceMonitorSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.storage + +"Storage defines the storage used by Prometheus." + +### fn spec.storage.withDisableMountSubPath + +```ts +withDisableMountSubPath(disableMountSubPath) +``` + +"Deprecated: subPath usage will be removed in a future release." + +## obj spec.storage.emptyDir + +"EmptyDirVolumeSource to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir" + +### fn spec.storage.emptyDir.withMedium + +```ts +withMedium(medium) +``` + +"medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.storage.emptyDir.withSizeLimit + +```ts +withSizeLimit(sizeLimit) +``` + +"sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +## obj spec.storage.ephemeral + +"EphemeralVolumeSource to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes" + +## obj spec.storage.ephemeral.volumeClaimTemplate + +"Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\n\nRequired, must not be nil." + +### fn spec.storage.ephemeral.volumeClaimTemplate.withMetadata + +```ts +withMetadata(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +### fn spec.storage.ephemeral.volumeClaimTemplate.withMetadataMixin + +```ts +withMetadataMixin(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec + +"The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate + +"Defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes." + +### fn spec.storage.volumeClaimTemplate.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources" + +### fn spec.storage.volumeClaimTemplate.withKind + +```ts +withKind(kind) +``` + +"Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + +## obj spec.storage.volumeClaimTemplate.metadata + +"EmbeddedMetadata contains metadata relevant to an EmbeddedResource." + +### fn spec.storage.volumeClaimTemplate.metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +### fn spec.storage.volumeClaimTemplate.metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +### fn spec.storage.volumeClaimTemplate.metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + +## obj spec.storage.volumeClaimTemplate.spec + +"Defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.storage.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.storage.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.storage.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.storage.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.storage.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.thanos + +"Defines the configuration of the optional Thanos sidecar." + +### fn spec.thanos.withAdditionalArgs + +```ts +withAdditionalArgs(additionalArgs) +``` + +"AdditionalArgs allows setting additional arguments for the Thanos container.\nThe arguments are passed as-is to the Thanos container which may cause issues\nif they are invalid or not supported the given Thanos version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged." + +### fn spec.thanos.withAdditionalArgsMixin + +```ts +withAdditionalArgsMixin(additionalArgs) +``` + +"AdditionalArgs allows setting additional arguments for the Thanos container.\nThe arguments are passed as-is to the Thanos container which may cause issues\nif they are invalid or not supported the given Thanos version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged." + +**Note:** This function appends passed data to existing values + +### fn spec.thanos.withBaseImage + +```ts +withBaseImage(baseImage) +``` + +"Deprecated: use 'image' instead." + +### fn spec.thanos.withBlockSize + +```ts +withBlockSize(blockSize) +``` + +"BlockDuration controls the size of TSDB blocks produced by Prometheus.\nThe default value is 2h to match the upstream Prometheus defaults.\n\n\nWARNING: Changing the block duration can impact the performance and\nefficiency of the entire Prometheus/Thanos stack due to how it interacts\nwith memory and Thanos compactors. It is recommended to keep this value\nset to a multiple of 120 times your longest scrape or rule interval. For\nexample, 30s * 120 = 1h." + +### fn spec.thanos.withGetConfigInterval + +```ts +withGetConfigInterval(getConfigInterval) +``` + +"How often to retrieve the Prometheus configuration." + +### fn spec.thanos.withGetConfigTimeout + +```ts +withGetConfigTimeout(getConfigTimeout) +``` + +"Maximum time to wait when retrieving the Prometheus configuration." + +### fn spec.thanos.withGrpcListenLocal + +```ts +withGrpcListenLocal(grpcListenLocal) +``` + +"When true, the Thanos sidecar listens on the loopback interface instead\nof the Pod IP's address for the gRPC endpoints.\n\n\nIt has no effect if `listenLocal` is true." + +### fn spec.thanos.withHttpListenLocal + +```ts +withHttpListenLocal(httpListenLocal) +``` + +"When true, the Thanos sidecar listens on the loopback interface instead\nof the Pod IP's address for the HTTP endpoints.\n\n\nIt has no effect if `listenLocal` is true." + +### fn spec.thanos.withImage + +```ts +withImage(image) +``` + +"Container image name for Thanos. If specified, it takes precedence over\nthe `spec.thanos.baseImage`, `spec.thanos.tag` and `spec.thanos.sha`\nfields.\n\n\nSpecifying `spec.thanos.version` is still necessary to ensure the\nPrometheus Operator knows which version of Thanos is being configured.\n\n\nIf neither `spec.thanos.image` nor `spec.thanos.baseImage` are defined,\nthe operator will use the latest upstream version of Thanos available at\nthe time when the operator was released." + +### fn spec.thanos.withListenLocal + +```ts +withListenLocal(listenLocal) +``` + +"Deprecated: use `grpcListenLocal` and `httpListenLocal` instead." + +### fn spec.thanos.withLogFormat + +```ts +withLogFormat(logFormat) +``` + +"Log format for the Thanos sidecar." + +### fn spec.thanos.withLogLevel + +```ts +withLogLevel(logLevel) +``` + +"Log level for the Thanos sidecar." + +### fn spec.thanos.withMinTime + +```ts +withMinTime(minTime) +``` + +"Defines the start of time range limit served by the Thanos sidecar's StoreAPI.\nThe field's value should be a constant time in RFC3339 format or a time\nduration relative to current time, such as -1d or 2h45m. Valid duration\nunits are ms, s, m, h, d, w, y." + +### fn spec.thanos.withObjectStorageConfigFile + +```ts +withObjectStorageConfigFile(objectStorageConfigFile) +``` + +"Defines the Thanos sidecar's configuration file to upload TSDB blocks to object storage.\n\n\nMore info: https://thanos.io/tip/thanos/storage.md/\n\n\nThis field takes precedence over objectStorageConfig." + +### fn spec.thanos.withReadyTimeout + +```ts +withReadyTimeout(readyTimeout) +``` + +"ReadyTimeout is the maximum time that the Thanos sidecar will wait for\nPrometheus to start." + +### fn spec.thanos.withSha + +```ts +withSha(sha) +``` + +"Deprecated: use 'image' instead. The image digest can be specified as part of the image name." + +### fn spec.thanos.withTag + +```ts +withTag(tag) +``` + +"Deprecated: use 'image' instead. The image's tag can be specified as as part of the image name." + +### fn spec.thanos.withTracingConfigFile + +```ts +withTracingConfigFile(tracingConfigFile) +``` + +"Defines the tracing configuration file for the Thanos sidecar.\n\n\nThis field takes precedence over `tracingConfig`.\n\n\nMore info: https://thanos.io/tip/thanos/tracing.md/\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.thanos.withVersion + +```ts +withVersion(version) +``` + +"Version of Thanos being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\n\nIf not specified, the operator assumes the latest upstream release of\nThanos available at the time when the version of the operator was\nreleased." + +### fn spec.thanos.withVolumeMounts + +```ts +withVolumeMounts(volumeMounts) +``` + +"VolumeMounts allows configuration of additional VolumeMounts for Thanos.\nVolumeMounts specified will be appended to other VolumeMounts in the\n'thanos-sidecar' container." + +### fn spec.thanos.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"VolumeMounts allows configuration of additional VolumeMounts for Thanos.\nVolumeMounts specified will be appended to other VolumeMounts in the\n'thanos-sidecar' container." + +**Note:** This function appends passed data to existing values + +## obj spec.thanos.additionalArgs + +"AdditionalArgs allows setting additional arguments for the Thanos container.\nThe arguments are passed as-is to the Thanos container which may cause issues\nif they are invalid or not supported the given Thanos version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged." + +### fn spec.thanos.additionalArgs.withName + +```ts +withName(name) +``` + +"Name of the argument, e.g. \"scrape.discovery-reload-interval\"." + +### fn spec.thanos.additionalArgs.withValue + +```ts +withValue(value) +``` + +"Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)" + +## obj spec.thanos.grpcServerTlsConfig + +"Configures the TLS parameters for the gRPC server providing the StoreAPI.\n\n\nNote: Currently only the `caFile`, `certFile`, and `keyFile` fields are supported." + +### fn spec.thanos.grpcServerTlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.thanos.grpcServerTlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.thanos.grpcServerTlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.thanos.grpcServerTlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.thanos.grpcServerTlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.thanos.grpcServerTlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.thanos.grpcServerTlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.thanos.grpcServerTlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.thanos.grpcServerTlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.thanos.grpcServerTlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.thanos.grpcServerTlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.thanos.grpcServerTlsConfig.ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.thanos.grpcServerTlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.thanos.grpcServerTlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.thanos.grpcServerTlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.thanos.grpcServerTlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.thanos.grpcServerTlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.thanos.grpcServerTlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.thanos.grpcServerTlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.thanos.grpcServerTlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.thanos.grpcServerTlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.thanos.grpcServerTlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.thanos.grpcServerTlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.thanos.objectStorageConfig + +"Defines the Thanos sidecar's configuration to upload TSDB blocks to object storage.\n\n\nMore info: https://thanos.io/tip/thanos/storage.md/\n\n\nobjectStorageConfigFile takes precedence over this field." + +### fn spec.thanos.objectStorageConfig.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.thanos.objectStorageConfig.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.thanos.objectStorageConfig.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.thanos.resources + +"Defines the resources requests and limits of the Thanos sidecar." + +### fn spec.thanos.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.thanos.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.thanos.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.thanos.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.thanos.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.thanos.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.thanos.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.thanos.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.thanos.tracingConfig + +"Defines the tracing configuration for the Thanos sidecar.\n\n\n`tracingConfigFile` takes precedence over this field.\n\n\nMore info: https://thanos.io/tip/thanos/tracing.md/\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.thanos.tracingConfig.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.thanos.tracingConfig.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.thanos.tracingConfig.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.thanos.volumeMounts + +"VolumeMounts allows configuration of additional VolumeMounts for Thanos.\nVolumeMounts specified will be appended to other VolumeMounts in the\n'thanos-sidecar' container." + +### fn spec.thanos.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.thanos.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.thanos.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.thanos.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.thanos.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.thanos.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.thanos.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.tolerations + +"Defines the Pods' tolerations if specified." + +### fn spec.tolerations.withEffect + +```ts +withEffect(effect) +``` + +"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute." + +### fn spec.tolerations.withKey + +```ts +withKey(key) +``` + +"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys." + +### fn spec.tolerations.withOperator + +```ts +withOperator(operator) +``` + +"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category." + +### fn spec.tolerations.withTolerationSeconds + +```ts +withTolerationSeconds(tolerationSeconds) +``` + +"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system." + +### fn spec.tolerations.withValue + +```ts +withValue(value) +``` + +"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string." + +## obj spec.topologySpreadConstraints + +"Defines the pod's topology spread constraints if specified." + +### fn spec.topologySpreadConstraints.withAdditionalLabelSelectors + +```ts +withAdditionalLabelSelectors(additionalLabelSelectors) +``` + +"Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint." + +### fn spec.topologySpreadConstraints.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default)." + +### fn spec.topologySpreadConstraints.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default)." + +**Note:** This function appends passed data to existing values + +### fn spec.topologySpreadConstraints.withMaxSkew + +```ts +withMaxSkew(maxSkew) +``` + +"MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n| zone1 | zone2 | zone3 |\n| P P | P P | P |\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed." + +### fn spec.topologySpreadConstraints.withMinDomains + +```ts +withMinDomains(minDomains) +``` + +"MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n| zone1 | zone2 | zone3 |\n| P P | P P | P P |\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew." + +### fn spec.topologySpreadConstraints.withNodeAffinityPolicy + +```ts +withNodeAffinityPolicy(nodeAffinityPolicy) +``` + +"NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\nwhen calculating pod topology spread skew. Options are:\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\n\nIf this value is nil, the behavior is equivalent to the Honor policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag." + +### fn spec.topologySpreadConstraints.withNodeTaintsPolicy + +```ts +withNodeTaintsPolicy(nodeTaintsPolicy) +``` + +"NodeTaintsPolicy indicates how we will treat node taints when calculating\npod topology spread skew. Options are:\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\nhas a toleration, are included.\n- Ignore: node taints are ignored. All nodes are included.\n\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag." + +### fn spec.topologySpreadConstraints.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field." + +### fn spec.topologySpreadConstraints.withWhenUnsatisfiable + +```ts +withWhenUnsatisfiable(whenUnsatisfiable) +``` + +"WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it.\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod\nif and only if every possible node assignment for that pod would violate\n\"MaxSkew\" on some topology.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n| zone1 | zone2 | zone3 |\n| P P P | P | P |\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field." + +## obj spec.topologySpreadConstraints.labelSelector + +"LabelSelector is used to find matching pods.\nPods that match this label selector are counted to determine the number of pods\nin their corresponding topology domain." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.topologySpreadConstraints.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.tracingConfig + +"TracingConfig configures tracing in Prometheus.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.tracingConfig.withClientType + +```ts +withClientType(clientType) +``` + +"Client used to export the traces. Supported values are `http` or `grpc`." + +### fn spec.tracingConfig.withCompression + +```ts +withCompression(compression) +``` + +"Compression key for supported compression types. The only supported value is `gzip`." + +### fn spec.tracingConfig.withEndpoint + +```ts +withEndpoint(endpoint) +``` + +"Endpoint to send the traces to. Should be provided in format :." + +### fn spec.tracingConfig.withHeaders + +```ts +withHeaders(headers) +``` + +"Key-value pairs to be used as headers associated with gRPC or HTTP requests." + +### fn spec.tracingConfig.withHeadersMixin + +```ts +withHeadersMixin(headers) +``` + +"Key-value pairs to be used as headers associated with gRPC or HTTP requests." + +**Note:** This function appends passed data to existing values + +### fn spec.tracingConfig.withInsecure + +```ts +withInsecure(insecure) +``` + +"If disabled, the client will use a secure connection." + +### fn spec.tracingConfig.withSamplingFraction + +```ts +withSamplingFraction(samplingFraction) +``` + +"Sets the probability a given trace will be sampled. Must be a float from 0 through 1." + +### fn spec.tracingConfig.withTimeout + +```ts +withTimeout(timeout) +``` + +"Maximum time the exporter will wait for each batch export." + +## obj spec.tracingConfig.tlsConfig + +"TLS Config to use when sending traces." + +### fn spec.tracingConfig.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.tracingConfig.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.tracingConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.tracingConfig.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.tracingConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.tracingConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.tracingConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.tracingConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.tracingConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.tracingConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.tracingConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.tracingConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.tracingConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tracingConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.tracingConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.tracingConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.tracingConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.tracingConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.tracingConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.tracingConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tracingConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.tracingConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.tracingConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tracingConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.tsdb + +"Defines the runtime reloadable configuration of the timeseries database\n(TSDB)." + +### fn spec.tsdb.withOutOfOrderTimeWindow + +```ts +withOutOfOrderTimeWindow(outOfOrderTimeWindow) +``` + +"Configures how old an out-of-order/out-of-bounds sample can be with\nrespect to the TSDB max time.\n\n\nAn out-of-order/out-of-bounds sample is ingested into the TSDB as long as\nthe timestamp of the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow).\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\n\nIt requires Prometheus >= v2.39.0." + +## obj spec.volumeMounts + +"VolumeMounts allows the configuration of additional VolumeMounts.\n\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects." + +### fn spec.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.volumes + +"Volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects." + +### fn spec.volumes.withName + +```ts +withName(name) +``` + +"name of the volume.\nMust be a DNS_LABEL and unique within the pod.\nMore 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\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.volumes.awsElasticBlockStore.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.awsElasticBlockStore.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)." + +### fn spec.volumes.awsElasticBlockStore.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly value true will force the readOnly setting in VolumeMounts.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.volumes.awsElasticBlockStore.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore 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 + +```ts +withCachingMode(cachingMode) +``` + +"cachingMode is the Host Caching mode: None, Read Only, Read Write." + +### fn spec.volumes.azureDisk.withDiskName + +```ts +withDiskName(diskName) +``` + +"diskName is the Name of the data disk in the blob storage" + +### fn spec.volumes.azureDisk.withDiskURI + +```ts +withDiskURI(diskURI) +``` + +"diskURI is the URI of data disk in the blob storage" + +### fn spec.volumes.azureDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.azureDisk.withKind + +```ts +withKind(kind) +``` + +"kind expected values are 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 + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force\nthe 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 + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.azureFile.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of secret that contains Azure Storage Account Name and Key" + +### fn spec.volumes.azureFile.withShareName + +```ts +withShareName(shareName) +``` + +"shareName is the azure 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 + +```ts +withMonitors(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors\nMore 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 + +```ts +withPath(path) +``` + +"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /" + +### fn spec.volumes.cephfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withSecretFile + +```ts +withSecretFile(secretFile) +``` + +"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withUser + +```ts +withUser(user) +``` + +"user is optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +## obj spec.volumes.cephfs.secretRef + +"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.cinder + +"cinder represents a cinder volume attached and mounted on kubelets host machine.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +## obj spec.volumes.cinder.secretRef + +"secretRef is optional: points to a secret object containing parameters used to connect\nto OpenStack." + +### fn spec.volumes.cinder.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.configMap + +"configMap represents a configMap that should populate this volume" + +### fn spec.volumes.configMap.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.volumes.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.csi + +"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)." + +### fn spec.volumes.csi.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster." + +### fn spec.volumes.csi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply." + +### fn spec.volumes.csi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write)." + +### fn spec.volumes.csi.withVolumeAttributes + +```ts +withVolumeAttributes(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values." + +### fn spec.volumes.csi.withVolumeAttributesMixin + +```ts +withVolumeAttributesMixin(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. 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\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed." + +### fn spec.volumes.csi.nodePublishSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.downwardAPI + +"downwardAPI represents downward API about the pod that should populate this volume" + +### fn spec.volumes.downwardAPI.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of downward API volume file" + +### fn spec.volumes.downwardAPI.withItemsMixin + +```ts +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 + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.downwardAPI.items.withPath + +```ts +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, namespace and uid are supported." + +### fn spec.volumes.downwardAPI.items.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.volumes.downwardAPI.items.fieldRef.withFieldPath + +```ts +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\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.volumes.emptyDir + +"emptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.volumes.emptyDir.withMedium + +```ts +withMedium(medium) +``` + +"medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.volumes.emptyDir.withSizeLimit + +```ts +withSizeLimit(sizeLimit) +``` + +"sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +## obj spec.volumes.ephemeral + +"ephemeral represents a volume that is handled by a cluster storage driver.\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\nand deleted when the pod is removed.\n\n\nUse this if:\na) the volume is only needed while the pod runs,\nb) features of normal volumes like restoring from snapshot or capacity\n tracking are needed,\nc) the storage driver is specified through a storage class, and\nd) the storage driver supports dynamic volume provisioning through\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\n information on the connection between this volume type\n and PersistentVolumeClaim).\n\n\nUse PersistentVolumeClaim or one of the vendor-specific\nAPIs for volumes that persist for longer than the lifecycle\nof an individual pod.\n\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\nbe used that way - see the documentation of the driver for\nmore information.\n\n\nA pod can use both types of ephemeral volumes and\npersistent volumes at the same time." + +## obj spec.volumes.ephemeral.volumeClaimTemplate + +"Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\n\nRequired, must not be nil." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.withMetadata + +```ts +withMetadata(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.withMetadataMixin + +```ts +withMetadataMixin(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec + +"The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.fc.withLun + +```ts +withLun(lun) +``` + +"lun is Optional: FC target lun number" + +### fn spec.volumes.fc.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.fc.withTargetWWNs + +```ts +withTargetWWNs(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +### fn spec.volumes.fc.withTargetWWNsMixin + +```ts +withTargetWWNsMixin(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.fc.withWwids + +```ts +withWwids(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously." + +### fn spec.volumes.fc.withWwidsMixin + +```ts +withWwidsMixin(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids)\nEither 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\nprovisioned/attached using an exec based plugin." + +### fn spec.volumes.flexVolume.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the driver to use for this volume." + +### fn spec.volumes.flexVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script." + +### fn spec.volumes.flexVolume.withOptions + +```ts +withOptions(options) +``` + +"options is Optional: this field holds extra command options if any." + +### fn spec.volumes.flexVolume.withOptionsMixin + +```ts +withOptionsMixin(options) +``` + +"options is Optional: this field holds extra command options if any." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.flexVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +## obj spec.volumes.flexVolume.secretRef + +"secretRef is Optional: secretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts." + +### fn spec.volumes.flexVolume.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.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 + +```ts +withDatasetName(datasetName) +``` + +"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\nshould be considered as deprecated" + +### fn spec.volumes.flocker.withDatasetUUID + +```ts +withDatasetUUID(datasetUUID) +``` + +"datasetUUID is the 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\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.gcePersistentDisk.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withPdName + +```ts +withPdName(pdName) +``` + +"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +## obj spec.volumes.gitRepo + +"gitRepo represents a git repository at a particular revision.\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container." + +### fn spec.volumes.gitRepo.withDirectory + +```ts +withDirectory(directory) +``` + +"directory is the target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name." + +### fn spec.volumes.gitRepo.withRepository + +```ts +withRepository(repository) +``` + +"repository is the URL" + +### fn spec.volumes.gitRepo.withRevision + +```ts +withRevision(revision) +``` + +"revision is the commit hash for the specified revision." + +## obj spec.volumes.glusterfs + +"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md" + +### fn spec.volumes.glusterfs.withEndpoints + +```ts +withEndpoints(endpoints) +``` + +"endpoints is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.volumes.glusterfs.withPath + +```ts +withPath(path) +``` + +"path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.volumes.glusterfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore 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\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n---\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\nmount host directories as read/write." + +### fn spec.volumes.hostPath.withPath + +```ts +withPath(path) +``` + +"path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +### fn spec.volumes.hostPath.withType + +```ts +withType(type) +``` + +"type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +## obj spec.volumes.iscsi + +"iscsi represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://examples.k8s.io/volumes/iscsi/README.md" + +### fn spec.volumes.iscsi.withChapAuthDiscovery + +```ts +withChapAuthDiscovery(chapAuthDiscovery) +``` + +"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication" + +### fn spec.volumes.iscsi.withChapAuthSession + +```ts +withChapAuthSession(chapAuthSession) +``` + +"chapAuthSession defines whether support iSCSI Session CHAP authentication" + +### fn spec.volumes.iscsi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.iscsi.withInitiatorName + +```ts +withInitiatorName(initiatorName) +``` + +"initiatorName is the custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n: will be created for the connection." + +### fn spec.volumes.iscsi.withIqn + +```ts +withIqn(iqn) +``` + +"iqn is the target iSCSI Qualified Name." + +### fn spec.volumes.iscsi.withIscsiInterface + +```ts +withIscsiInterface(iscsiInterface) +``` + +"iscsiInterface is the interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp)." + +### fn spec.volumes.iscsi.withLun + +```ts +withLun(lun) +``` + +"lun represents iSCSI Target Lun number." + +### fn spec.volumes.iscsi.withPortals + +```ts +withPortals(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +### fn spec.volumes.iscsi.withPortalsMixin + +```ts +withPortalsMixin(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.iscsi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false." + +### fn spec.volumes.iscsi.withTargetPortal + +```ts +withTargetPortal(targetPortal) +``` + +"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +## obj spec.volumes.iscsi.secretRef + +"secretRef is the CHAP Secret for iSCSI target and initiator authentication" + +### fn spec.volumes.iscsi.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.nfs + +"nfs represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withPath + +```ts +withPath(path) +``` + +"path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withServer + +```ts +withServer(server) +``` + +"server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +## obj spec.volumes.persistentVolumeClaim + +"persistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.volumes.persistentVolumeClaim.withClaimName + +```ts +withClaimName(claimName) +``` + +"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.volumes.persistentVolumeClaim.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Will force the ReadOnly setting in VolumeMounts.\nDefault false." + +## obj spec.volumes.photonPersistentDisk + +"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine" + +### fn spec.volumes.photonPersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.photonPersistentDisk.withPdID + +```ts +withPdID(pdID) +``` + +"pdID is the 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 + +```ts +withFsType(fsType) +``` + +"fSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.portworxVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.portworxVolume.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID uniquely identifies a Portworx volume" + +## obj spec.volumes.projected + +"projected items for all in one resources secrets, configmaps, and downward API" + +### fn spec.volumes.projected.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode are the mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.withSources + +```ts +withSources(sources) +``` + +"sources is the list of volume projections" + +### fn spec.volumes.projected.withSourcesMixin + +```ts +withSourcesMixin(sources) +``` + +"sources is the list of volume projections" + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources + +"sources is the list of volume projections" + +## obj spec.volumes.projected.sources.clusterTrustBundle + +"ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\nof ClusterTrustBundle objects in an auto-updating file.\n\n\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\n\n\nClusterTrustBundle objects can either be selected by name, or by the\ncombination of signer name and a label selector.\n\n\nKubelet performs aggressive normalization of the PEM contents written\ninto the pod filesystem. Esoteric PEM features such as inter-block\ncomments and block headers are stripped. Certificates are deduplicated.\nThe ordering of certificates within the file is arbitrary, and Kubelet\nmay change the order over time." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withName + +```ts +withName(name) +``` + +"Select a single ClusterTrustBundle by object name. Mutually-exclusive\nwith signerName and labelSelector." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withOptional + +```ts +withOptional(optional) +``` + +"If true, don't block pod startup if the referenced ClusterTrustBundle(s)\naren't available. If using name, then the named ClusterTrustBundle is\nallowed not to exist. If using signerName, then the combination of\nsignerName and labelSelector is allowed to match zero\nClusterTrustBundles." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withPath + +```ts +withPath(path) +``` + +"Relative path from the volume root to write the bundle." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withSignerName + +```ts +withSignerName(signerName) +``` + +"Select all ClusterTrustBundles that match this signer name.\nMutually-exclusive with name. The contents of all selected\nClusterTrustBundles will be unified and deduplicated." + +## obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector + +"Select all ClusterTrustBundles that match this label selector. Only has\neffect if signerName is set. Mutually-exclusive with name. If unset,\ninterpreted as \"match nothing\". If set but empty, interpreted as \"match\neverything\"." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchExpressionsMixin + +```ts +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.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources.configMap + +"configMap information about the configMap data to project" + +### fn spec.volumes.projected.sources.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative 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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.projected.sources.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.volumes.projected.sources.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.projected.sources.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.projected.sources.downwardAPI + +"downwardAPI information about the downwardAPI data to project" + +### fn spec.volumes.projected.sources.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of DownwardAPIVolume file" + +### fn spec.volumes.projected.sources.downwardAPI.withItemsMixin + +```ts +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 + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.downwardAPI.items.withPath + +```ts +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, namespace and uid are supported." + +### fn spec.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion + +```ts +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 + +```ts +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\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.volumes.projected.sources.secret + +"secret information about the secret data to project" + +### fn spec.volumes.projected.sources.secret.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative 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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.projected.sources.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its key must be defined" + +## obj spec.volumes.projected.sources.secret.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.projected.sources.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.projected.sources.serviceAccountToken + +"serviceAccountToken is information about the serviceAccountToken data to project" + +### fn spec.volumes.projected.sources.serviceAccountToken.withAudience + +```ts +withAudience(audience) +``` + +"audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver." + +### fn spec.volumes.projected.sources.serviceAccountToken.withExpirationSeconds + +```ts +withExpirationSeconds(expirationSeconds) +``` + +"expirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes." + +### fn spec.volumes.projected.sources.serviceAccountToken.withPath + +```ts +withPath(path) +``` + +"path is the path relative to the mount point of the file to project the\ntoken into." + +## obj spec.volumes.quobyte + +"quobyte represents a Quobyte mount on the host that shares a pod's lifetime" + +### fn spec.volumes.quobyte.withGroup + +```ts +withGroup(group) +``` + +"group to map volume access to\nDefault is no group" + +### fn spec.volumes.quobyte.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false." + +### fn spec.volumes.quobyte.withRegistry + +```ts +withRegistry(registry) +``` + +"registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes" + +### fn spec.volumes.quobyte.withTenant + +```ts +withTenant(tenant) +``` + +"tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin" + +### fn spec.volumes.quobyte.withUser + +```ts +withUser(user) +``` + +"user to map volume access to\nDefaults to serivceaccount user" + +### fn spec.volumes.quobyte.withVolume + +```ts +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.\nMore info: https://examples.k8s.io/volumes/rbd/README.md" + +### fn spec.volumes.rbd.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.rbd.withImage + +```ts +withImage(image) +``` + +"image is the rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withKeyring + +```ts +withKeyring(keyring) +``` + +"keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withMonitors + +```ts +withMonitors(monitors) +``` + +"monitors is a collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is a collection of Ceph monitors.\nMore 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 + +```ts +withPool(pool) +``` + +"pool is the rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withUser + +```ts +withUser(user) +``` + +"user is the rados user name.\nDefault is admin.\nMore 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\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.scaleIO + +"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes." + +### fn spec.volumes.scaleIO.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\"." + +### fn spec.volumes.scaleIO.withGateway + +```ts +withGateway(gateway) +``` + +"gateway is the host address of the ScaleIO API Gateway." + +### fn spec.volumes.scaleIO.withProtectionDomain + +```ts +withProtectionDomain(protectionDomain) +``` + +"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage." + +### fn spec.volumes.scaleIO.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.scaleIO.withSslEnabled + +```ts +withSslEnabled(sslEnabled) +``` + +"sslEnabled Flag enable/disable SSL communication with Gateway, default false" + +### fn spec.volumes.scaleIO.withStorageMode + +```ts +withStorageMode(storageMode) +``` + +"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned." + +### fn spec.volumes.scaleIO.withStoragePool + +```ts +withStoragePool(storagePool) +``` + +"storagePool is the ScaleIO Storage Pool associated with the protection domain." + +### fn spec.volumes.scaleIO.withSystem + +```ts +withSystem(system) +``` + +"system is the name of the storage system as configured in ScaleIO." + +### fn spec.volumes.scaleIO.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the name of a volume already created in the ScaleIO system\nthat is associated with this volume source." + +## obj spec.volumes.scaleIO.secretRef + +"secretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail." + +### fn spec.volumes.scaleIO.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.secret + +"secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +### fn spec.volumes.secret.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.secret.withItems + +```ts +withItems(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its keys must be defined" + +### fn spec.volumes.secret.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +## obj spec.volumes.secret.items + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay 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 + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.storageos.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.storageos.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace." + +### fn spec.volumes.storageos.withVolumeNamespace + +```ts +withVolumeNamespace(volumeNamespace) +``` + +"volumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces 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\ncredentials. If not specified, default values will be attempted." + +### fn spec.volumes.storageos.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.vsphereVolume + +"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine" + +### fn spec.volumes.vsphereVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.vsphereVolume.withStoragePolicyID + +```ts +withStoragePolicyID(storagePolicyID) +``` + +"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName." + +### fn spec.volumes.vsphereVolume.withStoragePolicyName + +```ts +withStoragePolicyName(storagePolicyName) +``` + +"storagePolicyName is the storage Policy Based Management (SPBM) profile name." + +### fn spec.volumes.vsphereVolume.withVolumePath + +```ts +withVolumePath(volumePath) +``` + +"volumePath is the path that identifies vSphere volume vmdk" + +## obj spec.web + +"Defines the configuration of the Prometheus web server." + +### fn spec.web.withMaxConnections + +```ts +withMaxConnections(maxConnections) +``` + +"Defines the maximum number of simultaneous connections\nA zero value means that Prometheus doesn't accept any incoming connection." + +### fn spec.web.withPageTitle + +```ts +withPageTitle(pageTitle) +``` + +"The prometheus web page title." + +## obj spec.web.httpConfig + +"Defines HTTP parameters for web server." + +### fn spec.web.httpConfig.withHttp2 + +```ts +withHttp2(http2) +``` + +"Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered." + +## obj spec.web.httpConfig.headers + +"List of headers that can be added to HTTP responses." + +### fn spec.web.httpConfig.headers.withContentSecurityPolicy + +```ts +withContentSecurityPolicy(contentSecurityPolicy) +``` + +"Set the Content-Security-Policy header to HTTP responses.\nUnset if blank." + +### fn spec.web.httpConfig.headers.withStrictTransportSecurity + +```ts +withStrictTransportSecurity(strictTransportSecurity) +``` + +"Set the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security" + +### fn spec.web.httpConfig.headers.withXContentTypeOptions + +```ts +withXContentTypeOptions(xContentTypeOptions) +``` + +"Set the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options" + +### fn spec.web.httpConfig.headers.withXFrameOptions + +```ts +withXFrameOptions(xFrameOptions) +``` + +"Set the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options" + +### fn spec.web.httpConfig.headers.withXXSSProtection + +```ts +withXXSSProtection(xXSSProtection) +``` + +"Set the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection" + +## obj spec.web.tlsConfig + +"Defines the TLS parameters for HTTPS." + +### fn spec.web.tlsConfig.withCipherSuites + +```ts +withCipherSuites(cipherSuites) +``` + +"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\nGo default cipher suites are used. Available cipher suites are documented\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants" + +### fn spec.web.tlsConfig.withCipherSuitesMixin + +```ts +withCipherSuitesMixin(cipherSuites) +``` + +"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\nGo default cipher suites are used. Available cipher suites are documented\nin 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 + +```ts +withClientAuthType(clientAuthType) +``` + +"Server policy for client authentication. Maps to ClientAuth Policies.\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType" + +### fn spec.web.tlsConfig.withCurvePreferences + +```ts +withCurvePreferences(curvePreferences) +``` + +"Elliptic curves that will be used in an ECDHE handshake, in preference\norder. Available curves are documented in the go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID" + +### fn spec.web.tlsConfig.withCurvePreferencesMixin + +```ts +withCurvePreferencesMixin(curvePreferences) +``` + +"Elliptic curves that will be used in an ECDHE handshake, in preference\norder. Available curves are documented in the go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID" + +**Note:** This function appends passed data to existing values + +### fn spec.web.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum TLS version that is acceptable. Defaults to TLS13." + +### fn spec.web.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum TLS version that is acceptable. Defaults to TLS12." + +### fn spec.web.tlsConfig.withPreferServerCipherSuites + +```ts +withPreferServerCipherSuites(preferServerCipherSuites) +``` + +"Controls whether the server selects the\nclient's most preferred cipher suite, or the server's most preferred\ncipher suite. If true then the server's preference, as expressed in\nthe 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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.web.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.web.tlsConfig.client_ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.client_ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.client_ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.client_ca.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/prometheusRule.md b/docs/0.14/monitoring/v1/prometheusRule.md new file mode 100644 index 0000000..49c83c6 --- /dev/null +++ b/docs/0.14/monitoring/v1/prometheusRule.md @@ -0,0 +1,381 @@ +--- +permalink: /0.14/monitoring/v1/prometheusRule/ +--- + +# monitoring.v1.prometheusRule + +"The `PrometheusRule` custom resource definition (CRD) defines [alerting](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) and [recording](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/) rules to be evaluated by `Prometheus` or `ThanosRuler` objects.\n\n\n`Prometheus` and `ThanosRuler` objects select `PrometheusRule` objects using label and namespace selectors." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withGroups(groups)`](#fn-specwithgroups) + * [`fn withGroupsMixin(groups)`](#fn-specwithgroupsmixin) + * [`obj spec.groups`](#obj-specgroups) + * [`fn withInterval(interval)`](#fn-specgroupswithinterval) + * [`fn withLimit(limit)`](#fn-specgroupswithlimit) + * [`fn withName(name)`](#fn-specgroupswithname) + * [`fn withPartial_response_strategy(partial_response_strategy)`](#fn-specgroupswithpartial_response_strategy) + * [`fn withRules(rules)`](#fn-specgroupswithrules) + * [`fn withRulesMixin(rules)`](#fn-specgroupswithrulesmixin) + * [`obj spec.groups.rules`](#obj-specgroupsrules) + * [`fn withAlert(alert)`](#fn-specgroupsruleswithalert) + * [`fn withAnnotations(annotations)`](#fn-specgroupsruleswithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specgroupsruleswithannotationsmixin) + * [`fn withExpr(expr)`](#fn-specgroupsruleswithexpr) + * [`fn withFor(For)`](#fn-specgroupsruleswithfor) + * [`fn withKeep_firing_for(keep_firing_for)`](#fn-specgroupsruleswithkeep_firing_for) + * [`fn withLabels(labels)`](#fn-specgroupsruleswithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specgroupsruleswithlabelsmixin) + * [`fn withRecord(record)`](#fn-specgroupsruleswithrecord) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of PrometheusRule + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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 desired alerting rule definitions for Prometheus." + +### fn spec.withGroups + +```ts +withGroups(groups) +``` + +"Content of Prometheus rule file" + +### fn spec.withGroupsMixin + +```ts +withGroupsMixin(groups) +``` + +"Content of Prometheus rule file" + +**Note:** This function appends passed data to existing values + +## obj spec.groups + +"Content of Prometheus rule file" + +### fn spec.groups.withInterval + +```ts +withInterval(interval) +``` + +"Interval determines how often rules in the group are evaluated." + +### fn spec.groups.withLimit + +```ts +withLimit(limit) +``` + +"Limit the number of alerts an alerting rule and series a recording\nrule can produce.\nLimit is supported starting with Prometheus >= 2.31 and Thanos Ruler >= 0.24." + +### fn spec.groups.withName + +```ts +withName(name) +``` + +"Name of the rule group." + +### fn spec.groups.withPartial_response_strategy + +```ts +withPartial_response_strategy(partial_response_strategy) +``` + +"PartialResponseStrategy is only used by ThanosRuler and will\nbe ignored by Prometheus instances.\nMore info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response" + +### fn spec.groups.withRules + +```ts +withRules(rules) +``` + +"List of alerting and recording rules." + +### fn spec.groups.withRulesMixin + +```ts +withRulesMixin(rules) +``` + +"List of alerting and recording rules." + +**Note:** This function appends passed data to existing values + +## obj spec.groups.rules + +"List of alerting and recording rules." + +### fn spec.groups.rules.withAlert + +```ts +withAlert(alert) +``` + +"Name of the alert. Must be a valid label value.\nOnly one of `record` and `alert` must be set." + +### fn spec.groups.rules.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations to add to each alert.\nOnly valid for alerting rules." + +### fn spec.groups.rules.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations to add to each alert.\nOnly valid for alerting rules." + +**Note:** This function appends passed data to existing values + +### fn spec.groups.rules.withExpr + +```ts +withExpr(expr) +``` + +"PromQL expression to evaluate." + +### fn spec.groups.rules.withFor + +```ts +withFor(For) +``` + +"Alerts are considered firing once they have been returned for this long." + +### fn spec.groups.rules.withKeep_firing_for + +```ts +withKeep_firing_for(keep_firing_for) +``` + +"KeepFiringFor defines how long an alert will continue firing after the condition that triggered it has cleared." + +### fn spec.groups.rules.withLabels + +```ts +withLabels(labels) +``` + +"Labels to add or overwrite." + +### fn spec.groups.rules.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Labels to add or overwrite." + +**Note:** This function appends passed data to existing values + +### fn spec.groups.rules.withRecord + +```ts +withRecord(record) +``` + +"Name of the time series to output to. Must be a valid metric name.\nOnly one of `record` and `alert` must be set." \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/relabelConfig.md b/docs/0.14/monitoring/v1/relabelConfig.md new file mode 100644 index 0000000..6017aa2 --- /dev/null +++ b/docs/0.14/monitoring/v1/relabelConfig.md @@ -0,0 +1,75 @@ +--- +permalink: /0.14/monitoring/v1/relabelConfig/ +--- + +# monitoring.v1.relabelConfig + +RelabelConfig is a help to build RelabelConfig objects for ServiceMonitors and PodMonitors + +## Index + +* [`fn withAction(separator)`](#fn-withaction) +* [`fn withModulus(modulus)`](#fn-withmodulus) +* [`fn withRegex(separator)`](#fn-withregex) +* [`fn withReplacement(separator)`](#fn-withreplacement) +* [`fn withSeparator(separator)`](#fn-withseparator) +* [`fn withSourceLabels(labels)`](#fn-withsourcelabels) +* [`fn withTargetLabel(separator)`](#fn-withtargetlabel) + +## Fields + +### fn withAction + +```ts +withAction(separator) +``` + +Action to perform based on regex matching. Default is ‘replace’ + +### fn withModulus + +```ts +withModulus(modulus) +``` + +Modulus to take of the hash of the source label values. + +### fn withRegex + +```ts +withRegex(separator) +``` + +Regular expression against which the extracted value is matched. Default is ‘(.*)’ + +### fn withReplacement + +```ts +withReplacement(separator) +``` + +Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is ‘$1’ + +### fn withSeparator + +```ts +withSeparator(separator) +``` + +Separator placed between concatenated source label values. default is ‘;’. + +### fn withSourceLabels + +```ts +withSourceLabels(labels) +``` + +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 withTargetLabel + +```ts +withTargetLabel(separator) +``` + +Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/serviceMonitor.md b/docs/0.14/monitoring/v1/serviceMonitor.md new file mode 100644 index 0000000..cb4b8aa --- /dev/null +++ b/docs/0.14/monitoring/v1/serviceMonitor.md @@ -0,0 +1,1654 @@ +--- +permalink: /0.14/monitoring/v1/serviceMonitor/ +--- + +# monitoring.v1.serviceMonitor + +"The `ServiceMonitor` custom resource definition (CRD) defines how `Prometheus` and `PrometheusAgent` can scrape metrics from a group of services.\nAmong other things, it allows to specify:\n* The services to scrape via label selectors.\n* The container ports to scrape.\n* Authentication credentials to use.\n* Target and metric relabeling.\n\n\n`Prometheus` and `PrometheusAgent` objects select `ServiceMonitor` objects using label and namespace selectors." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withBodySizeLimit(bodySizeLimit)`](#fn-specwithbodysizelimit) + * [`fn withEndpoints(endpoints)`](#fn-specwithendpoints) + * [`fn withEndpointsMixin(endpoints)`](#fn-specwithendpointsmixin) + * [`fn withJobLabel(jobLabel)`](#fn-specwithjoblabel) + * [`fn withKeepDroppedTargets(keepDroppedTargets)`](#fn-specwithkeepdroppedtargets) + * [`fn withLabelLimit(labelLimit)`](#fn-specwithlabellimit) + * [`fn withLabelNameLengthLimit(labelNameLengthLimit)`](#fn-specwithlabelnamelengthlimit) + * [`fn withLabelValueLengthLimit(labelValueLengthLimit)`](#fn-specwithlabelvaluelengthlimit) + * [`fn withPodTargetLabels(podTargetLabels)`](#fn-specwithpodtargetlabels) + * [`fn withPodTargetLabelsMixin(podTargetLabels)`](#fn-specwithpodtargetlabelsmixin) + * [`fn withSampleLimit(sampleLimit)`](#fn-specwithsamplelimit) + * [`fn withScrapeClass(scrapeClass)`](#fn-specwithscrapeclass) + * [`fn withScrapeProtocols(scrapeProtocols)`](#fn-specwithscrapeprotocols) + * [`fn withScrapeProtocolsMixin(scrapeProtocols)`](#fn-specwithscrapeprotocolsmixin) + * [`fn withTargetLabels(targetLabels)`](#fn-specwithtargetlabels) + * [`fn withTargetLabelsMixin(targetLabels)`](#fn-specwithtargetlabelsmixin) + * [`fn withTargetLimit(targetLimit)`](#fn-specwithtargetlimit) + * [`obj spec.attachMetadata`](#obj-specattachmetadata) + * [`fn withNode(node)`](#fn-specattachmetadatawithnode) + * [`obj spec.endpoints`](#obj-specendpoints) + * [`fn withBearerTokenFile(bearerTokenFile)`](#fn-specendpointswithbearertokenfile) + * [`fn withEnableHttp2(enableHttp2)`](#fn-specendpointswithenablehttp2) + * [`fn withFilterRunning(filterRunning)`](#fn-specendpointswithfilterrunning) + * [`fn withFollowRedirects(followRedirects)`](#fn-specendpointswithfollowredirects) + * [`fn withHonorLabels(honorLabels)`](#fn-specendpointswithhonorlabels) + * [`fn withHonorTimestamps(honorTimestamps)`](#fn-specendpointswithhonortimestamps) + * [`fn withInterval(interval)`](#fn-specendpointswithinterval) + * [`fn withMetricRelabelings(metricRelabelings)`](#fn-specendpointswithmetricrelabelings) + * [`fn withMetricRelabelingsMixin(metricRelabelings)`](#fn-specendpointswithmetricrelabelingsmixin) + * [`fn withParams(params)`](#fn-specendpointswithparams) + * [`fn withParamsMixin(params)`](#fn-specendpointswithparamsmixin) + * [`fn withPath(path)`](#fn-specendpointswithpath) + * [`fn withPort(port)`](#fn-specendpointswithport) + * [`fn withProxyUrl(proxyUrl)`](#fn-specendpointswithproxyurl) + * [`fn withRelabelings(relabelings)`](#fn-specendpointswithrelabelings) + * [`fn withRelabelingsMixin(relabelings)`](#fn-specendpointswithrelabelingsmixin) + * [`fn withScheme(scheme)`](#fn-specendpointswithscheme) + * [`fn withScrapeTimeout(scrapeTimeout)`](#fn-specendpointswithscrapetimeout) + * [`fn withTargetPort(targetPort)`](#fn-specendpointswithtargetport) + * [`fn withTrackTimestampsStaleness(trackTimestampsStaleness)`](#fn-specendpointswithtracktimestampsstaleness) + * [`obj spec.endpoints.authorization`](#obj-specendpointsauthorization) + * [`fn withType(type)`](#fn-specendpointsauthorizationwithtype) + * [`obj spec.endpoints.authorization.credentials`](#obj-specendpointsauthorizationcredentials) + * [`fn withKey(key)`](#fn-specendpointsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specendpointsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specendpointsauthorizationcredentialswithoptional) + * [`obj spec.endpoints.basicAuth`](#obj-specendpointsbasicauth) + * [`obj spec.endpoints.basicAuth.password`](#obj-specendpointsbasicauthpassword) + * [`fn withKey(key)`](#fn-specendpointsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specendpointsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specendpointsbasicauthpasswordwithoptional) + * [`obj spec.endpoints.basicAuth.username`](#obj-specendpointsbasicauthusername) + * [`fn withKey(key)`](#fn-specendpointsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specendpointsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specendpointsbasicauthusernamewithoptional) + * [`obj spec.endpoints.bearerTokenSecret`](#obj-specendpointsbearertokensecret) + * [`fn withKey(key)`](#fn-specendpointsbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specendpointsbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specendpointsbearertokensecretwithoptional) + * [`obj spec.endpoints.metricRelabelings`](#obj-specendpointsmetricrelabelings) + * [`fn withAction(action)`](#fn-specendpointsmetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specendpointsmetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specendpointsmetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specendpointsmetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specendpointsmetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specendpointsmetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specendpointsmetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specendpointsmetricrelabelingswithtargetlabel) + * [`obj spec.endpoints.oauth2`](#obj-specendpointsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specendpointsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specendpointsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specendpointsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specendpointsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specendpointsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specendpointsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specendpointsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specendpointsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specendpointsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specendpointsoauth2withtokenurl) + * [`obj spec.endpoints.oauth2.clientId`](#obj-specendpointsoauth2clientid) + * [`obj spec.endpoints.oauth2.clientId.configMap`](#obj-specendpointsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specendpointsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specendpointsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specendpointsoauth2clientidconfigmapwithoptional) + * [`obj spec.endpoints.oauth2.clientId.secret`](#obj-specendpointsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specendpointsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specendpointsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specendpointsoauth2clientidsecretwithoptional) + * [`obj spec.endpoints.oauth2.clientSecret`](#obj-specendpointsoauth2clientsecret) + * [`fn withKey(key)`](#fn-specendpointsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specendpointsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specendpointsoauth2clientsecretwithoptional) + * [`obj spec.endpoints.oauth2.tlsConfig`](#obj-specendpointsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specendpointsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specendpointsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specendpointsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specendpointsoauth2tlsconfigwithservername) + * [`obj spec.endpoints.oauth2.tlsConfig.ca`](#obj-specendpointsoauth2tlsconfigca) + * [`obj spec.endpoints.oauth2.tlsConfig.ca.configMap`](#obj-specendpointsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specendpointsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specendpointsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specendpointsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.endpoints.oauth2.tlsConfig.ca.secret`](#obj-specendpointsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specendpointsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specendpointsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specendpointsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.endpoints.oauth2.tlsConfig.cert`](#obj-specendpointsoauth2tlsconfigcert) + * [`obj spec.endpoints.oauth2.tlsConfig.cert.configMap`](#obj-specendpointsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specendpointsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specendpointsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specendpointsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.endpoints.oauth2.tlsConfig.cert.secret`](#obj-specendpointsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specendpointsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specendpointsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specendpointsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.endpoints.oauth2.tlsConfig.keySecret`](#obj-specendpointsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specendpointsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specendpointsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specendpointsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.endpoints.relabelings`](#obj-specendpointsrelabelings) + * [`fn withAction(action)`](#fn-specendpointsrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specendpointsrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specendpointsrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specendpointsrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specendpointsrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specendpointsrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specendpointsrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specendpointsrelabelingswithtargetlabel) + * [`obj spec.endpoints.tlsConfig`](#obj-specendpointstlsconfig) + * [`fn withCaFile(caFile)`](#fn-specendpointstlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specendpointstlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specendpointstlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specendpointstlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specendpointstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specendpointstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specendpointstlsconfigwithservername) + * [`obj spec.endpoints.tlsConfig.ca`](#obj-specendpointstlsconfigca) + * [`obj spec.endpoints.tlsConfig.ca.configMap`](#obj-specendpointstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specendpointstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specendpointstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specendpointstlsconfigcaconfigmapwithoptional) + * [`obj spec.endpoints.tlsConfig.ca.secret`](#obj-specendpointstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specendpointstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specendpointstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specendpointstlsconfigcasecretwithoptional) + * [`obj spec.endpoints.tlsConfig.cert`](#obj-specendpointstlsconfigcert) + * [`obj spec.endpoints.tlsConfig.cert.configMap`](#obj-specendpointstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specendpointstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specendpointstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specendpointstlsconfigcertconfigmapwithoptional) + * [`obj spec.endpoints.tlsConfig.cert.secret`](#obj-specendpointstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specendpointstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specendpointstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specendpointstlsconfigcertsecretwithoptional) + * [`obj spec.endpoints.tlsConfig.keySecret`](#obj-specendpointstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specendpointstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specendpointstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specendpointstlsconfigkeysecretwithoptional) + * [`obj spec.namespaceSelector`](#obj-specnamespaceselector) + * [`fn withAny(any)`](#fn-specnamespaceselectorwithany) + * [`fn withMatchNames(matchNames)`](#fn-specnamespaceselectorwithmatchnames) + * [`fn withMatchNamesMixin(matchNames)`](#fn-specnamespaceselectorwithmatchnamesmixin) + * [`obj spec.selector`](#obj-specselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specselectorwithmatchlabelsmixin) + * [`obj spec.selector.matchExpressions`](#obj-specselectormatchexpressions) + * [`fn withKey(key)`](#fn-specselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specselectormatchexpressionswithvaluesmixin) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ServiceMonitor + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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 desired Service selection for target discovery by\nPrometheus." + +### fn spec.withBodySizeLimit + +```ts +withBodySizeLimit(bodySizeLimit) +``` + +"When defined, bodySizeLimit specifies a job level limit on the size\nof uncompressed response body that will be accepted by Prometheus.\n\n\nIt requires Prometheus >= v2.28.0." + +### fn spec.withEndpoints + +```ts +withEndpoints(endpoints) +``` + +"List of endpoints part of this ServiceMonitor.\nDefines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects.\nIn most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels." + +### fn spec.withEndpointsMixin + +```ts +withEndpointsMixin(endpoints) +``` + +"List of endpoints part of this ServiceMonitor.\nDefines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects.\nIn most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels." + +**Note:** This function appends passed data to existing values + +### fn spec.withJobLabel + +```ts +withJobLabel(jobLabel) +``` + +"`jobLabel` selects the label from the associated Kubernetes `Service`\nobject which will be used as the `job` label for all metrics.\n\n\nFor example if `jobLabel` is set to `foo` and the Kubernetes `Service`\nobject is labeled with `foo: bar`, then Prometheus adds the `job=\"bar\"`\nlabel to all ingested metrics.\n\n\nIf the value of this field is empty or if the label doesn't exist for\nthe given Service, the `job` label of the metrics defaults to the name\nof the associated Kubernetes `Service`." + +### fn spec.withKeepDroppedTargets + +```ts +withKeepDroppedTargets(keepDroppedTargets) +``` + +"Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\n\nIt requires Prometheus >= v2.47.0." + +### fn spec.withLabelLimit + +```ts +withLabelLimit(labelLimit) +``` + +"Per-scrape limit on number of labels that will be accepted for a sample.\n\n\nIt requires Prometheus >= v2.27.0." + +### fn spec.withLabelNameLengthLimit + +```ts +withLabelNameLengthLimit(labelNameLengthLimit) +``` + +"Per-scrape limit on length of labels name that will be accepted for a sample.\n\n\nIt requires Prometheus >= v2.27.0." + +### fn spec.withLabelValueLengthLimit + +```ts +withLabelValueLengthLimit(labelValueLengthLimit) +``` + +"Per-scrape limit on length of labels value that will be accepted for a sample.\n\n\nIt requires Prometheus >= v2.27.0." + +### fn spec.withPodTargetLabels + +```ts +withPodTargetLabels(podTargetLabels) +``` + +"`podTargetLabels` defines the labels which are transferred from the\nassociated Kubernetes `Pod` object onto the ingested metrics." + +### fn spec.withPodTargetLabelsMixin + +```ts +withPodTargetLabelsMixin(podTargetLabels) +``` + +"`podTargetLabels` defines the labels which are transferred from the\nassociated Kubernetes `Pod` object onto the ingested metrics." + +**Note:** This function appends passed data to existing values + +### fn spec.withSampleLimit + +```ts +withSampleLimit(sampleLimit) +``` + +"`sampleLimit` defines a per-scrape limit on the number of scraped samples\nthat will be accepted." + +### fn spec.withScrapeClass + +```ts +withScrapeClass(scrapeClass) +``` + +"The scrape class to apply." + +### fn spec.withScrapeProtocols + +```ts +withScrapeProtocols(scrapeProtocols) +``` + +"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +### fn spec.withScrapeProtocolsMixin + +```ts +withScrapeProtocolsMixin(scrapeProtocols) +``` + +"`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +**Note:** This function appends passed data to existing values + +### fn spec.withTargetLabels + +```ts +withTargetLabels(targetLabels) +``` + +"`targetLabels` defines the labels which are transferred from the\nassociated Kubernetes `Service` object onto the ingested metrics." + +### fn spec.withTargetLabelsMixin + +```ts +withTargetLabelsMixin(targetLabels) +``` + +"`targetLabels` defines the labels which are transferred from the\nassociated Kubernetes `Service` object onto the ingested metrics." + +**Note:** This function appends passed data to existing values + +### fn spec.withTargetLimit + +```ts +withTargetLimit(targetLimit) +``` + +"`targetLimit` defines a limit on the number of scraped targets that will\nbe accepted." + +## obj spec.attachMetadata + +"`attachMetadata` defines additional metadata which is added to the\ndiscovered targets.\n\n\nIt requires Prometheus >= v2.37.0." + +### fn spec.attachMetadata.withNode + +```ts +withNode(node) +``` + +"When set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects." + +## obj spec.endpoints + +"List of endpoints part of this ServiceMonitor.\nDefines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects.\nIn most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels." + +### fn spec.endpoints.withBearerTokenFile + +```ts +withBearerTokenFile(bearerTokenFile) +``` + +"File to read bearer token for scraping the target.\n\n\nDeprecated: use `authorization` instead." + +### fn spec.endpoints.withEnableHttp2 + +```ts +withEnableHttp2(enableHttp2) +``` + +"`enableHttp2` can be used to disable HTTP2 when scraping the target." + +### fn spec.endpoints.withFilterRunning + +```ts +withFilterRunning(filterRunning) +``` + +"When true, the pods which are not running (e.g. either in Failed or\nSucceeded state) are dropped during the target discovery.\n\n\nIf unset, the filtering is enabled.\n\n\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase" + +### fn spec.endpoints.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"`followRedirects` defines whether the scrape requests should follow HTTP\n3xx redirects." + +### fn spec.endpoints.withHonorLabels + +```ts +withHonorLabels(honorLabels) +``` + +"When true, `honorLabels` preserves the metric's labels when they collide\nwith the target's labels." + +### fn spec.endpoints.withHonorTimestamps + +```ts +withHonorTimestamps(honorTimestamps) +``` + +"`honorTimestamps` controls whether Prometheus preserves the timestamps\nwhen exposed by the target." + +### fn spec.endpoints.withInterval + +```ts +withInterval(interval) +``` + +"Interval at which Prometheus scrapes the metrics from the target.\n\n\nIf empty, Prometheus uses the global scrape interval." + +### fn spec.endpoints.withMetricRelabelings + +```ts +withMetricRelabelings(metricRelabelings) +``` + +"`metricRelabelings` configures the relabeling rules to apply to the\nsamples before ingestion." + +### fn spec.endpoints.withMetricRelabelingsMixin + +```ts +withMetricRelabelingsMixin(metricRelabelings) +``` + +"`metricRelabelings` configures the relabeling rules to apply to the\nsamples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.endpoints.withParams + +```ts +withParams(params) +``` + +"params define optional HTTP URL parameters." + +### fn spec.endpoints.withParamsMixin + +```ts +withParamsMixin(params) +``` + +"params define optional HTTP URL parameters." + +**Note:** This function appends passed data to existing values + +### fn spec.endpoints.withPath + +```ts +withPath(path) +``` + +"HTTP path from which to scrape for metrics.\n\n\nIf empty, Prometheus uses the default value (e.g. `/metrics`)." + +### fn spec.endpoints.withPort + +```ts +withPort(port) +``` + +"Name of the Service port which this endpoint refers to.\n\n\nIt takes precedence over `targetPort`." + +### fn spec.endpoints.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` configures the HTTP Proxy URL (e.g.\n\"http://proxyserver:2195\") to go through when scraping the target." + +### fn spec.endpoints.withRelabelings + +```ts +withRelabelings(relabelings) +``` + +"`relabelings` configures the relabeling rules to apply the target's\nmetadata labels.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.endpoints.withRelabelingsMixin + +```ts +withRelabelingsMixin(relabelings) +``` + +"`relabelings` configures the relabeling rules to apply the target's\nmetadata labels.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +**Note:** This function appends passed data to existing values + +### fn spec.endpoints.withScheme + +```ts +withScheme(scheme) +``` + +"HTTP scheme to use for scraping.\n\n\n`http` and `https` are the expected values unless you rewrite the\n`__scheme__` label via relabeling.\n\n\nIf empty, Prometheus uses the default value `http`." + +### fn spec.endpoints.withScrapeTimeout + +```ts +withScrapeTimeout(scrapeTimeout) +``` + +"Timeout after which Prometheus considers the scrape to be failed.\n\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used." + +### fn spec.endpoints.withTargetPort + +```ts +withTargetPort(targetPort) +``` + +"Name or number of the target port of the `Pod` object behind the\nService. The port must be specified with the container's port property." + +### fn spec.endpoints.withTrackTimestampsStaleness + +```ts +withTrackTimestampsStaleness(trackTimestampsStaleness) +``` + +"`trackTimestampsStaleness` defines whether Prometheus tracks staleness of\nthe metrics that have an explicit timestamp present in scraped data.\nHas no effect if `honorTimestamps` is false.\n\n\nIt requires Prometheus >= v2.48.0." + +## obj spec.endpoints.authorization + +"`authorization` configures the Authorization header credentials to use when\nscraping the target.\n\n\nCannot be set at the same time as `basicAuth`, or `oauth2`." + +### fn spec.endpoints.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.endpoints.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.endpoints.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.basicAuth + +"`basicAuth` configures the Basic Authentication credentials to use when\nscraping the target.\n\n\nCannot be set at the same time as `authorization`, or `oauth2`." + +## obj spec.endpoints.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.endpoints.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.endpoints.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.bearerTokenSecret + +"`bearerTokenSecret` specifies a key of a Secret containing the bearer\ntoken for scraping targets. The secret needs to be in the same namespace\nas the ServiceMonitor object and readable by the Prometheus Operator.\n\n\nDeprecated: use `authorization` instead." + +### fn spec.endpoints.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.metricRelabelings + +"`metricRelabelings` configures the relabeling rules to apply to the\nsamples before ingestion." + +### fn spec.endpoints.metricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.endpoints.metricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.endpoints.metricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.endpoints.metricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.endpoints.metricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.endpoints.metricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.endpoints.metricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.endpoints.metricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.endpoints.oauth2 + +"`oauth2` configures the OAuth2 settings to use when scraping the target.\n\n\nIt requires Prometheus >= 2.27.0.\n\n\nCannot be set at the same time as `authorization`, or `basicAuth`." + +### fn spec.endpoints.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.endpoints.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.endpoints.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.endpoints.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.endpoints.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.endpoints.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.endpoints.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.endpoints.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.endpoints.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.endpoints.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.endpoints.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.endpoints.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.endpoints.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.endpoints.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.endpoints.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.endpoints.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.endpoints.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.endpoints.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.endpoints.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.endpoints.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.endpoints.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.endpoints.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.endpoints.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.endpoints.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.endpoints.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.endpoints.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.endpoints.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.endpoints.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.endpoints.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.endpoints.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.endpoints.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.endpoints.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.endpoints.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.relabelings + +"`relabelings` configures the relabeling rules to apply the target's\nmetadata labels.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.endpoints.relabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.endpoints.relabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.endpoints.relabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.endpoints.relabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.endpoints.relabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.endpoints.relabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.endpoints.relabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.endpoints.relabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.endpoints.tlsConfig + +"TLS configuration to use when scraping the target." + +### fn spec.endpoints.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.endpoints.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.endpoints.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.endpoints.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.endpoints.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.endpoints.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.endpoints.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.endpoints.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.endpoints.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.endpoints.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.endpoints.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.endpoints.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.endpoints.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.endpoints.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.endpoints.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.endpoints.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.endpoints.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.endpoints.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.endpoints.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.endpoints.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.endpoints.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.endpoints.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.namespaceSelector + +"`namespaceSelector` defines in which namespace(s) Prometheus should discover the services.\nBy default, the services are discovered in the same namespace as the `ServiceMonitor` object but it is possible to select pods across different/all namespaces." + +### fn spec.namespaceSelector.withAny + +```ts +withAny(any) +``` + +"Boolean describing whether all namespaces are selected in contrast to a\nlist restricting them." + +### fn spec.namespaceSelector.withMatchNames + +```ts +withMatchNames(matchNames) +``` + +"List of namespace names to select from." + +### fn spec.namespaceSelector.withMatchNamesMixin + +```ts +withMatchNamesMixin(matchNames) +``` + +"List of namespace names to select from." + +**Note:** This function appends passed data to existing values + +## obj spec.selector + +"Label selector to select the Kubernetes `Endpoints` objects to scrape metrics from." + +### fn spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.selector.withMatchExpressionsMixin + +```ts +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.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values \ No newline at end of file diff --git a/docs/0.14/monitoring/v1/thanosRuler.md b/docs/0.14/monitoring/v1/thanosRuler.md new file mode 100644 index 0000000..47b3f9d --- /dev/null +++ b/docs/0.14/monitoring/v1/thanosRuler.md @@ -0,0 +1,10577 @@ +--- +permalink: /0.14/monitoring/v1/thanosRuler/ +--- + +# monitoring.v1.thanosRuler + +"The `ThanosRuler` custom resource definition (CRD) defines a desired [Thanos Ruler](https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md) setup to run in a Kubernetes cluster.\n\n\nA `ThanosRuler` instance requires at least one compatible Prometheus API endpoint (either Thanos Querier or Prometheus services).\n\n\nThe resource defines via label and namespace selectors which `PrometheusRule` objects should be associated to the deployed Thanos Ruler instances." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withAdditionalArgs(additionalArgs)`](#fn-specwithadditionalargs) + * [`fn withAdditionalArgsMixin(additionalArgs)`](#fn-specwithadditionalargsmixin) + * [`fn withAlertDropLabels(alertDropLabels)`](#fn-specwithalertdroplabels) + * [`fn withAlertDropLabelsMixin(alertDropLabels)`](#fn-specwithalertdroplabelsmixin) + * [`fn withAlertQueryUrl(alertQueryUrl)`](#fn-specwithalertqueryurl) + * [`fn withAlertRelabelConfigFile(alertRelabelConfigFile)`](#fn-specwithalertrelabelconfigfile) + * [`fn withAlertmanagersUrl(alertmanagersUrl)`](#fn-specwithalertmanagersurl) + * [`fn withAlertmanagersUrlMixin(alertmanagersUrl)`](#fn-specwithalertmanagersurlmixin) + * [`fn withContainers(containers)`](#fn-specwithcontainers) + * [`fn withContainersMixin(containers)`](#fn-specwithcontainersmixin) + * [`fn withEnforcedNamespaceLabel(enforcedNamespaceLabel)`](#fn-specwithenforcednamespacelabel) + * [`fn withEvaluationInterval(evaluationInterval)`](#fn-specwithevaluationinterval) + * [`fn withExcludedFromEnforcement(excludedFromEnforcement)`](#fn-specwithexcludedfromenforcement) + * [`fn withExcludedFromEnforcementMixin(excludedFromEnforcement)`](#fn-specwithexcludedfromenforcementmixin) + * [`fn withExternalPrefix(externalPrefix)`](#fn-specwithexternalprefix) + * [`fn withHostAliases(hostAliases)`](#fn-specwithhostaliases) + * [`fn withHostAliasesMixin(hostAliases)`](#fn-specwithhostaliasesmixin) + * [`fn withImage(image)`](#fn-specwithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-specwithimagepullpolicy) + * [`fn withImagePullSecrets(imagePullSecrets)`](#fn-specwithimagepullsecrets) + * [`fn withImagePullSecretsMixin(imagePullSecrets)`](#fn-specwithimagepullsecretsmixin) + * [`fn withInitContainers(initContainers)`](#fn-specwithinitcontainers) + * [`fn withInitContainersMixin(initContainers)`](#fn-specwithinitcontainersmixin) + * [`fn withLabels(labels)`](#fn-specwithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specwithlabelsmixin) + * [`fn withListenLocal(listenLocal)`](#fn-specwithlistenlocal) + * [`fn withLogFormat(logFormat)`](#fn-specwithlogformat) + * [`fn withLogLevel(logLevel)`](#fn-specwithloglevel) + * [`fn withMinReadySeconds(minReadySeconds)`](#fn-specwithminreadyseconds) + * [`fn withNodeSelector(nodeSelector)`](#fn-specwithnodeselector) + * [`fn withNodeSelectorMixin(nodeSelector)`](#fn-specwithnodeselectormixin) + * [`fn withObjectStorageConfigFile(objectStorageConfigFile)`](#fn-specwithobjectstorageconfigfile) + * [`fn withPaused(paused)`](#fn-specwithpaused) + * [`fn withPortName(portName)`](#fn-specwithportname) + * [`fn withPriorityClassName(priorityClassName)`](#fn-specwithpriorityclassname) + * [`fn withPrometheusRulesExcludedFromEnforce(prometheusRulesExcludedFromEnforce)`](#fn-specwithprometheusrulesexcludedfromenforce) + * [`fn withPrometheusRulesExcludedFromEnforceMixin(prometheusRulesExcludedFromEnforce)`](#fn-specwithprometheusrulesexcludedfromenforcemixin) + * [`fn withQueryEndpoints(queryEndpoints)`](#fn-specwithqueryendpoints) + * [`fn withQueryEndpointsMixin(queryEndpoints)`](#fn-specwithqueryendpointsmixin) + * [`fn withReplicas(replicas)`](#fn-specwithreplicas) + * [`fn withRetention(retention)`](#fn-specwithretention) + * [`fn withRoutePrefix(routePrefix)`](#fn-specwithrouteprefix) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withTolerations(tolerations)`](#fn-specwithtolerations) + * [`fn withTolerationsMixin(tolerations)`](#fn-specwithtolerationsmixin) + * [`fn withTopologySpreadConstraints(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraints) + * [`fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraintsmixin) + * [`fn withTracingConfigFile(tracingConfigFile)`](#fn-specwithtracingconfigfile) + * [`fn withVersion(version)`](#fn-specwithversion) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specwithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specwithvolumemountsmixin) + * [`fn withVolumes(volumes)`](#fn-specwithvolumes) + * [`fn withVolumesMixin(volumes)`](#fn-specwithvolumesmixin) + * [`obj spec.additionalArgs`](#obj-specadditionalargs) + * [`fn withName(name)`](#fn-specadditionalargswithname) + * [`fn withValue(value)`](#fn-specadditionalargswithvalue) + * [`obj spec.affinity`](#obj-specaffinity) + * [`obj spec.affinity.nodeAffinity`](#obj-specaffinitynodeaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfieldsmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressions) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfields) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withNodeSelectorTerms(nodeSelectorTerms)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectorterms) + * [`fn withNodeSelectorTermsMixin(nodeSelectorTerms)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectortermsmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfieldsmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfields) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvaluesmixin) + * [`obj spec.affinity.podAffinity`](#obj-specaffinitypodaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity`](#obj-specaffinitypodantiaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.alertRelabelConfigs`](#obj-specalertrelabelconfigs) + * [`fn withKey(key)`](#fn-specalertrelabelconfigswithkey) + * [`fn withName(name)`](#fn-specalertrelabelconfigswithname) + * [`fn withOptional(optional)`](#fn-specalertrelabelconfigswithoptional) + * [`obj spec.alertmanagersConfig`](#obj-specalertmanagersconfig) + * [`fn withKey(key)`](#fn-specalertmanagersconfigwithkey) + * [`fn withName(name)`](#fn-specalertmanagersconfigwithname) + * [`fn withOptional(optional)`](#fn-specalertmanagersconfigwithoptional) + * [`obj spec.containers`](#obj-speccontainers) + * [`fn withArgs(args)`](#fn-speccontainerswithargs) + * [`fn withArgsMixin(args)`](#fn-speccontainerswithargsmixin) + * [`fn withCommand(command)`](#fn-speccontainerswithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerswithcommandmixin) + * [`fn withEnv(env)`](#fn-speccontainerswithenv) + * [`fn withEnvFrom(envFrom)`](#fn-speccontainerswithenvfrom) + * [`fn withEnvFromMixin(envFrom)`](#fn-speccontainerswithenvfrommixin) + * [`fn withEnvMixin(env)`](#fn-speccontainerswithenvmixin) + * [`fn withImage(image)`](#fn-speccontainerswithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-speccontainerswithimagepullpolicy) + * [`fn withName(name)`](#fn-speccontainerswithname) + * [`fn withPorts(ports)`](#fn-speccontainerswithports) + * [`fn withPortsMixin(ports)`](#fn-speccontainerswithportsmixin) + * [`fn withResizePolicy(resizePolicy)`](#fn-speccontainerswithresizepolicy) + * [`fn withResizePolicyMixin(resizePolicy)`](#fn-speccontainerswithresizepolicymixin) + * [`fn withRestartPolicy(restartPolicy)`](#fn-speccontainerswithrestartpolicy) + * [`fn withStdin(stdin)`](#fn-speccontainerswithstdin) + * [`fn withStdinOnce(stdinOnce)`](#fn-speccontainerswithstdinonce) + * [`fn withTerminationMessagePath(terminationMessagePath)`](#fn-speccontainerswithterminationmessagepath) + * [`fn withTerminationMessagePolicy(terminationMessagePolicy)`](#fn-speccontainerswithterminationmessagepolicy) + * [`fn withTty(tty)`](#fn-speccontainerswithtty) + * [`fn withVolumeDevices(volumeDevices)`](#fn-speccontainerswithvolumedevices) + * [`fn withVolumeDevicesMixin(volumeDevices)`](#fn-speccontainerswithvolumedevicesmixin) + * [`fn withVolumeMounts(volumeMounts)`](#fn-speccontainerswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-speccontainerswithvolumemountsmixin) + * [`fn withWorkingDir(workingDir)`](#fn-speccontainerswithworkingdir) + * [`obj spec.containers.env`](#obj-speccontainersenv) + * [`fn withName(name)`](#fn-speccontainersenvwithname) + * [`fn withValue(value)`](#fn-speccontainersenvwithvalue) + * [`obj spec.containers.env.valueFrom`](#obj-speccontainersenvvaluefrom) + * [`obj spec.containers.env.valueFrom.configMapKeyRef`](#obj-speccontainersenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.containers.env.valueFrom.fieldRef`](#obj-speccontainersenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-speccontainersenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-speccontainersenvvaluefromfieldrefwithfieldpath) + * [`obj spec.containers.env.valueFrom.resourceFieldRef`](#obj-speccontainersenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-speccontainersenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-speccontainersenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-speccontainersenvvaluefromresourcefieldrefwithresource) + * [`obj spec.containers.env.valueFrom.secretKeyRef`](#obj-speccontainersenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-speccontainersenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-speccontainersenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.containers.envFrom`](#obj-speccontainersenvfrom) + * [`fn withPrefix(prefix)`](#fn-speccontainersenvfromwithprefix) + * [`obj spec.containers.envFrom.configMapRef`](#obj-speccontainersenvfromconfigmapref) + * [`fn withName(name)`](#fn-speccontainersenvfromconfigmaprefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvfromconfigmaprefwithoptional) + * [`obj spec.containers.envFrom.secretRef`](#obj-speccontainersenvfromsecretref) + * [`fn withName(name)`](#fn-speccontainersenvfromsecretrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvfromsecretrefwithoptional) + * [`obj spec.containers.lifecycle`](#obj-speccontainerslifecycle) + * [`obj spec.containers.lifecycle.postStart`](#obj-speccontainerslifecyclepoststart) + * [`obj spec.containers.lifecycle.postStart.exec`](#obj-speccontainerslifecyclepoststartexec) + * [`fn withCommand(command)`](#fn-speccontainerslifecyclepoststartexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslifecyclepoststartexecwithcommandmixin) + * [`obj spec.containers.lifecycle.postStart.httpGet`](#obj-speccontainerslifecyclepoststarthttpget) + * [`fn withHost(host)`](#fn-speccontainerslifecyclepoststarthttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslifecyclepoststarthttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslifecyclepoststarthttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslifecyclepoststarthttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslifecyclepoststarthttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslifecyclepoststarthttpgetwithscheme) + * [`obj spec.containers.lifecycle.postStart.httpGet.httpHeaders`](#obj-speccontainerslifecyclepoststarthttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslifecyclepoststarthttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslifecyclepoststarthttpgethttpheaderswithvalue) + * [`obj spec.containers.lifecycle.postStart.sleep`](#obj-speccontainerslifecyclepoststartsleep) + * [`fn withSeconds(seconds)`](#fn-speccontainerslifecyclepoststartsleepwithseconds) + * [`obj spec.containers.lifecycle.postStart.tcpSocket`](#obj-speccontainerslifecyclepoststarttcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslifecyclepoststarttcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslifecyclepoststarttcpsocketwithport) + * [`obj spec.containers.lifecycle.preStop`](#obj-speccontainerslifecycleprestop) + * [`obj spec.containers.lifecycle.preStop.exec`](#obj-speccontainerslifecycleprestopexec) + * [`fn withCommand(command)`](#fn-speccontainerslifecycleprestopexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslifecycleprestopexecwithcommandmixin) + * [`obj spec.containers.lifecycle.preStop.httpGet`](#obj-speccontainerslifecycleprestophttpget) + * [`fn withHost(host)`](#fn-speccontainerslifecycleprestophttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslifecycleprestophttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslifecycleprestophttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslifecycleprestophttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslifecycleprestophttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslifecycleprestophttpgetwithscheme) + * [`obj spec.containers.lifecycle.preStop.httpGet.httpHeaders`](#obj-speccontainerslifecycleprestophttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslifecycleprestophttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslifecycleprestophttpgethttpheaderswithvalue) + * [`obj spec.containers.lifecycle.preStop.sleep`](#obj-speccontainerslifecycleprestopsleep) + * [`fn withSeconds(seconds)`](#fn-speccontainerslifecycleprestopsleepwithseconds) + * [`obj spec.containers.lifecycle.preStop.tcpSocket`](#obj-speccontainerslifecycleprestoptcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslifecycleprestoptcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslifecycleprestoptcpsocketwithport) + * [`obj spec.containers.livenessProbe`](#obj-speccontainerslivenessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainerslivenessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainerslivenessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainerslivenessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainerslivenessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainerslivenessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainerslivenessprobewithtimeoutseconds) + * [`obj spec.containers.livenessProbe.exec`](#obj-speccontainerslivenessprobeexec) + * [`fn withCommand(command)`](#fn-speccontainerslivenessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslivenessprobeexecwithcommandmixin) + * [`obj spec.containers.livenessProbe.grpc`](#obj-speccontainerslivenessprobegrpc) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainerslivenessprobegrpcwithservice) + * [`obj spec.containers.livenessProbe.httpGet`](#obj-speccontainerslivenessprobehttpget) + * [`fn withHost(host)`](#fn-speccontainerslivenessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslivenessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslivenessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslivenessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslivenessprobehttpgetwithscheme) + * [`obj spec.containers.livenessProbe.httpGet.httpHeaders`](#obj-speccontainerslivenessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslivenessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslivenessprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.livenessProbe.tcpSocket`](#obj-speccontainerslivenessprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslivenessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobetcpsocketwithport) + * [`obj spec.containers.ports`](#obj-speccontainersports) + * [`fn withContainerPort(containerPort)`](#fn-speccontainersportswithcontainerport) + * [`fn withHostIP(hostIP)`](#fn-speccontainersportswithhostip) + * [`fn withHostPort(hostPort)`](#fn-speccontainersportswithhostport) + * [`fn withName(name)`](#fn-speccontainersportswithname) + * [`fn withProtocol(protocol)`](#fn-speccontainersportswithprotocol) + * [`obj spec.containers.readinessProbe`](#obj-speccontainersreadinessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainersreadinessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainersreadinessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainersreadinessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainersreadinessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainersreadinessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainersreadinessprobewithtimeoutseconds) + * [`obj spec.containers.readinessProbe.exec`](#obj-speccontainersreadinessprobeexec) + * [`fn withCommand(command)`](#fn-speccontainersreadinessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainersreadinessprobeexecwithcommandmixin) + * [`obj spec.containers.readinessProbe.grpc`](#obj-speccontainersreadinessprobegrpc) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainersreadinessprobegrpcwithservice) + * [`obj spec.containers.readinessProbe.httpGet`](#obj-speccontainersreadinessprobehttpget) + * [`fn withHost(host)`](#fn-speccontainersreadinessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainersreadinessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainersreadinessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainersreadinessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainersreadinessprobehttpgetwithscheme) + * [`obj spec.containers.readinessProbe.httpGet.httpHeaders`](#obj-speccontainersreadinessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainersreadinessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainersreadinessprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.readinessProbe.tcpSocket`](#obj-speccontainersreadinessprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainersreadinessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobetcpsocketwithport) + * [`obj spec.containers.resizePolicy`](#obj-speccontainersresizepolicy) + * [`fn withResourceName(resourceName)`](#fn-speccontainersresizepolicywithresourcename) + * [`fn withRestartPolicy(restartPolicy)`](#fn-speccontainersresizepolicywithrestartpolicy) + * [`obj spec.containers.resources`](#obj-speccontainersresources) + * [`fn withClaims(claims)`](#fn-speccontainersresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-speccontainersresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-speccontainersresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-speccontainersresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-speccontainersresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-speccontainersresourceswithrequestsmixin) + * [`obj spec.containers.resources.claims`](#obj-speccontainersresourcesclaims) + * [`fn withName(name)`](#fn-speccontainersresourcesclaimswithname) + * [`obj spec.containers.securityContext`](#obj-speccontainerssecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-speccontainerssecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-speccontainerssecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-speccontainerssecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-speccontainerssecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-speccontainerssecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-speccontainerssecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-speccontainerssecuritycontextwithrunasuser) + * [`obj spec.containers.securityContext.appArmorProfile`](#obj-speccontainerssecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-speccontainerssecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextapparmorprofilewithtype) + * [`obj spec.containers.securityContext.capabilities`](#obj-speccontainerssecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-speccontainerssecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-speccontainerssecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-speccontainerssecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-speccontainerssecuritycontextcapabilitieswithdropmixin) + * [`obj spec.containers.securityContext.seLinuxOptions`](#obj-speccontainerssecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-speccontainerssecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-speccontainerssecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-speccontainerssecuritycontextselinuxoptionswithuser) + * [`obj spec.containers.securityContext.seccompProfile`](#obj-speccontainerssecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-speccontainerssecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextseccompprofilewithtype) + * [`obj spec.containers.securityContext.windowsOptions`](#obj-speccontainerssecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-speccontainerssecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-speccontainerssecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-speccontainerssecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-speccontainerssecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.containers.startupProbe`](#obj-speccontainersstartupprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainersstartupprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainersstartupprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainersstartupprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainersstartupprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainersstartupprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainersstartupprobewithtimeoutseconds) + * [`obj spec.containers.startupProbe.exec`](#obj-speccontainersstartupprobeexec) + * [`fn withCommand(command)`](#fn-speccontainersstartupprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainersstartupprobeexecwithcommandmixin) + * [`obj spec.containers.startupProbe.grpc`](#obj-speccontainersstartupprobegrpc) + * [`fn withPort(port)`](#fn-speccontainersstartupprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainersstartupprobegrpcwithservice) + * [`obj spec.containers.startupProbe.httpGet`](#obj-speccontainersstartupprobehttpget) + * [`fn withHost(host)`](#fn-speccontainersstartupprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainersstartupprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainersstartupprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainersstartupprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainersstartupprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainersstartupprobehttpgetwithscheme) + * [`obj spec.containers.startupProbe.httpGet.httpHeaders`](#obj-speccontainersstartupprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainersstartupprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainersstartupprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.startupProbe.tcpSocket`](#obj-speccontainersstartupprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainersstartupprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainersstartupprobetcpsocketwithport) + * [`obj spec.containers.volumeDevices`](#obj-speccontainersvolumedevices) + * [`fn withDevicePath(devicePath)`](#fn-speccontainersvolumedeviceswithdevicepath) + * [`fn withName(name)`](#fn-speccontainersvolumedeviceswithname) + * [`obj spec.containers.volumeMounts`](#obj-speccontainersvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-speccontainersvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-speccontainersvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-speccontainersvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-speccontainersvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-speccontainersvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-speccontainersvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-speccontainersvolumemountswithsubpathexpr) + * [`obj spec.excludedFromEnforcement`](#obj-specexcludedfromenforcement) + * [`fn withGroup(group)`](#fn-specexcludedfromenforcementwithgroup) + * [`fn withName(name)`](#fn-specexcludedfromenforcementwithname) + * [`fn withNamespace(namespace)`](#fn-specexcludedfromenforcementwithnamespace) + * [`fn withResource(resource)`](#fn-specexcludedfromenforcementwithresource) + * [`obj spec.grpcServerTlsConfig`](#obj-specgrpcservertlsconfig) + * [`fn withCaFile(caFile)`](#fn-specgrpcservertlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specgrpcservertlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specgrpcservertlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specgrpcservertlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specgrpcservertlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specgrpcservertlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specgrpcservertlsconfigwithservername) + * [`obj spec.grpcServerTlsConfig.ca`](#obj-specgrpcservertlsconfigca) + * [`obj spec.grpcServerTlsConfig.ca.configMap`](#obj-specgrpcservertlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specgrpcservertlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specgrpcservertlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specgrpcservertlsconfigcaconfigmapwithoptional) + * [`obj spec.grpcServerTlsConfig.ca.secret`](#obj-specgrpcservertlsconfigcasecret) + * [`fn withKey(key)`](#fn-specgrpcservertlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specgrpcservertlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specgrpcservertlsconfigcasecretwithoptional) + * [`obj spec.grpcServerTlsConfig.cert`](#obj-specgrpcservertlsconfigcert) + * [`obj spec.grpcServerTlsConfig.cert.configMap`](#obj-specgrpcservertlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specgrpcservertlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specgrpcservertlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specgrpcservertlsconfigcertconfigmapwithoptional) + * [`obj spec.grpcServerTlsConfig.cert.secret`](#obj-specgrpcservertlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specgrpcservertlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specgrpcservertlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specgrpcservertlsconfigcertsecretwithoptional) + * [`obj spec.grpcServerTlsConfig.keySecret`](#obj-specgrpcservertlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specgrpcservertlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specgrpcservertlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specgrpcservertlsconfigkeysecretwithoptional) + * [`obj spec.hostAliases`](#obj-spechostaliases) + * [`fn withHostnames(hostnames)`](#fn-spechostaliaseswithhostnames) + * [`fn withHostnamesMixin(hostnames)`](#fn-spechostaliaseswithhostnamesmixin) + * [`fn withIp(ip)`](#fn-spechostaliaseswithip) + * [`obj spec.imagePullSecrets`](#obj-specimagepullsecrets) + * [`fn withName(name)`](#fn-specimagepullsecretswithname) + * [`obj spec.initContainers`](#obj-specinitcontainers) + * [`fn withArgs(args)`](#fn-specinitcontainerswithargs) + * [`fn withArgsMixin(args)`](#fn-specinitcontainerswithargsmixin) + * [`fn withCommand(command)`](#fn-specinitcontainerswithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerswithcommandmixin) + * [`fn withEnv(env)`](#fn-specinitcontainerswithenv) + * [`fn withEnvFrom(envFrom)`](#fn-specinitcontainerswithenvfrom) + * [`fn withEnvFromMixin(envFrom)`](#fn-specinitcontainerswithenvfrommixin) + * [`fn withEnvMixin(env)`](#fn-specinitcontainerswithenvmixin) + * [`fn withImage(image)`](#fn-specinitcontainerswithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-specinitcontainerswithimagepullpolicy) + * [`fn withName(name)`](#fn-specinitcontainerswithname) + * [`fn withPorts(ports)`](#fn-specinitcontainerswithports) + * [`fn withPortsMixin(ports)`](#fn-specinitcontainerswithportsmixin) + * [`fn withResizePolicy(resizePolicy)`](#fn-specinitcontainerswithresizepolicy) + * [`fn withResizePolicyMixin(resizePolicy)`](#fn-specinitcontainerswithresizepolicymixin) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specinitcontainerswithrestartpolicy) + * [`fn withStdin(stdin)`](#fn-specinitcontainerswithstdin) + * [`fn withStdinOnce(stdinOnce)`](#fn-specinitcontainerswithstdinonce) + * [`fn withTerminationMessagePath(terminationMessagePath)`](#fn-specinitcontainerswithterminationmessagepath) + * [`fn withTerminationMessagePolicy(terminationMessagePolicy)`](#fn-specinitcontainerswithterminationmessagepolicy) + * [`fn withTty(tty)`](#fn-specinitcontainerswithtty) + * [`fn withVolumeDevices(volumeDevices)`](#fn-specinitcontainerswithvolumedevices) + * [`fn withVolumeDevicesMixin(volumeDevices)`](#fn-specinitcontainerswithvolumedevicesmixin) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specinitcontainerswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specinitcontainerswithvolumemountsmixin) + * [`fn withWorkingDir(workingDir)`](#fn-specinitcontainerswithworkingdir) + * [`obj spec.initContainers.env`](#obj-specinitcontainersenv) + * [`fn withName(name)`](#fn-specinitcontainersenvwithname) + * [`fn withValue(value)`](#fn-specinitcontainersenvwithvalue) + * [`obj spec.initContainers.env.valueFrom`](#obj-specinitcontainersenvvaluefrom) + * [`obj spec.initContainers.env.valueFrom.configMapKeyRef`](#obj-specinitcontainersenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.initContainers.env.valueFrom.fieldRef`](#obj-specinitcontainersenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specinitcontainersenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specinitcontainersenvvaluefromfieldrefwithfieldpath) + * [`obj spec.initContainers.env.valueFrom.resourceFieldRef`](#obj-specinitcontainersenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithresource) + * [`obj spec.initContainers.env.valueFrom.secretKeyRef`](#obj-specinitcontainersenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.initContainers.envFrom`](#obj-specinitcontainersenvfrom) + * [`fn withPrefix(prefix)`](#fn-specinitcontainersenvfromwithprefix) + * [`obj spec.initContainers.envFrom.configMapRef`](#obj-specinitcontainersenvfromconfigmapref) + * [`fn withName(name)`](#fn-specinitcontainersenvfromconfigmaprefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvfromconfigmaprefwithoptional) + * [`obj spec.initContainers.envFrom.secretRef`](#obj-specinitcontainersenvfromsecretref) + * [`fn withName(name)`](#fn-specinitcontainersenvfromsecretrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvfromsecretrefwithoptional) + * [`obj spec.initContainers.lifecycle`](#obj-specinitcontainerslifecycle) + * [`obj spec.initContainers.lifecycle.postStart`](#obj-specinitcontainerslifecyclepoststart) + * [`obj spec.initContainers.lifecycle.postStart.exec`](#obj-specinitcontainerslifecyclepoststartexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslifecyclepoststartexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslifecyclepoststartexecwithcommandmixin) + * [`obj spec.initContainers.lifecycle.postStart.httpGet`](#obj-specinitcontainerslifecyclepoststarthttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithscheme) + * [`obj spec.initContainers.lifecycle.postStart.httpGet.httpHeaders`](#obj-specinitcontainerslifecyclepoststarthttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslifecyclepoststarthttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslifecyclepoststarthttpgethttpheaderswithvalue) + * [`obj spec.initContainers.lifecycle.postStart.sleep`](#obj-specinitcontainerslifecyclepoststartsleep) + * [`fn withSeconds(seconds)`](#fn-specinitcontainerslifecyclepoststartsleepwithseconds) + * [`obj spec.initContainers.lifecycle.postStart.tcpSocket`](#obj-specinitcontainerslifecyclepoststarttcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslifecyclepoststarttcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslifecyclepoststarttcpsocketwithport) + * [`obj spec.initContainers.lifecycle.preStop`](#obj-specinitcontainerslifecycleprestop) + * [`obj spec.initContainers.lifecycle.preStop.exec`](#obj-specinitcontainerslifecycleprestopexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslifecycleprestopexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslifecycleprestopexecwithcommandmixin) + * [`obj spec.initContainers.lifecycle.preStop.httpGet`](#obj-specinitcontainerslifecycleprestophttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslifecycleprestophttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslifecycleprestophttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslifecycleprestophttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslifecycleprestophttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslifecycleprestophttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslifecycleprestophttpgetwithscheme) + * [`obj spec.initContainers.lifecycle.preStop.httpGet.httpHeaders`](#obj-specinitcontainerslifecycleprestophttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslifecycleprestophttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslifecycleprestophttpgethttpheaderswithvalue) + * [`obj spec.initContainers.lifecycle.preStop.sleep`](#obj-specinitcontainerslifecycleprestopsleep) + * [`fn withSeconds(seconds)`](#fn-specinitcontainerslifecycleprestopsleepwithseconds) + * [`obj spec.initContainers.lifecycle.preStop.tcpSocket`](#obj-specinitcontainerslifecycleprestoptcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslifecycleprestoptcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslifecycleprestoptcpsocketwithport) + * [`obj spec.initContainers.livenessProbe`](#obj-specinitcontainerslivenessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainerslivenessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainerslivenessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainerslivenessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainerslivenessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainerslivenessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainerslivenessprobewithtimeoutseconds) + * [`obj spec.initContainers.livenessProbe.exec`](#obj-specinitcontainerslivenessprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslivenessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslivenessprobeexecwithcommandmixin) + * [`obj spec.initContainers.livenessProbe.grpc`](#obj-specinitcontainerslivenessprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainerslivenessprobegrpcwithservice) + * [`obj spec.initContainers.livenessProbe.httpGet`](#obj-specinitcontainerslivenessprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslivenessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslivenessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslivenessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslivenessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslivenessprobehttpgetwithscheme) + * [`obj spec.initContainers.livenessProbe.httpGet.httpHeaders`](#obj-specinitcontainerslivenessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslivenessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslivenessprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.livenessProbe.tcpSocket`](#obj-specinitcontainerslivenessprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslivenessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobetcpsocketwithport) + * [`obj spec.initContainers.ports`](#obj-specinitcontainersports) + * [`fn withContainerPort(containerPort)`](#fn-specinitcontainersportswithcontainerport) + * [`fn withHostIP(hostIP)`](#fn-specinitcontainersportswithhostip) + * [`fn withHostPort(hostPort)`](#fn-specinitcontainersportswithhostport) + * [`fn withName(name)`](#fn-specinitcontainersportswithname) + * [`fn withProtocol(protocol)`](#fn-specinitcontainersportswithprotocol) + * [`obj spec.initContainers.readinessProbe`](#obj-specinitcontainersreadinessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainersreadinessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainersreadinessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainersreadinessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainersreadinessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainersreadinessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainersreadinessprobewithtimeoutseconds) + * [`obj spec.initContainers.readinessProbe.exec`](#obj-specinitcontainersreadinessprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainersreadinessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainersreadinessprobeexecwithcommandmixin) + * [`obj spec.initContainers.readinessProbe.grpc`](#obj-specinitcontainersreadinessprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainersreadinessprobegrpcwithservice) + * [`obj spec.initContainers.readinessProbe.httpGet`](#obj-specinitcontainersreadinessprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainersreadinessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainersreadinessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainersreadinessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainersreadinessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainersreadinessprobehttpgetwithscheme) + * [`obj spec.initContainers.readinessProbe.httpGet.httpHeaders`](#obj-specinitcontainersreadinessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainersreadinessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainersreadinessprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.readinessProbe.tcpSocket`](#obj-specinitcontainersreadinessprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainersreadinessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobetcpsocketwithport) + * [`obj spec.initContainers.resizePolicy`](#obj-specinitcontainersresizepolicy) + * [`fn withResourceName(resourceName)`](#fn-specinitcontainersresizepolicywithresourcename) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specinitcontainersresizepolicywithrestartpolicy) + * [`obj spec.initContainers.resources`](#obj-specinitcontainersresources) + * [`fn withClaims(claims)`](#fn-specinitcontainersresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specinitcontainersresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specinitcontainersresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specinitcontainersresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specinitcontainersresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specinitcontainersresourceswithrequestsmixin) + * [`obj spec.initContainers.resources.claims`](#obj-specinitcontainersresourcesclaims) + * [`fn withName(name)`](#fn-specinitcontainersresourcesclaimswithname) + * [`obj spec.initContainers.securityContext`](#obj-specinitcontainerssecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-specinitcontainerssecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-specinitcontainerssecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-specinitcontainerssecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-specinitcontainerssecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specinitcontainerssecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specinitcontainerssecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specinitcontainerssecuritycontextwithrunasuser) + * [`obj spec.initContainers.securityContext.appArmorProfile`](#obj-specinitcontainerssecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specinitcontainerssecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextapparmorprofilewithtype) + * [`obj spec.initContainers.securityContext.capabilities`](#obj-specinitcontainerssecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-specinitcontainerssecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-specinitcontainerssecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-specinitcontainerssecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-specinitcontainerssecuritycontextcapabilitieswithdropmixin) + * [`obj spec.initContainers.securityContext.seLinuxOptions`](#obj-specinitcontainerssecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithuser) + * [`obj spec.initContainers.securityContext.seccompProfile`](#obj-specinitcontainerssecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specinitcontainerssecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextseccompprofilewithtype) + * [`obj spec.initContainers.securityContext.windowsOptions`](#obj-specinitcontainerssecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.initContainers.startupProbe`](#obj-specinitcontainersstartupprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainersstartupprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainersstartupprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainersstartupprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainersstartupprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainersstartupprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainersstartupprobewithtimeoutseconds) + * [`obj spec.initContainers.startupProbe.exec`](#obj-specinitcontainersstartupprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainersstartupprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainersstartupprobeexecwithcommandmixin) + * [`obj spec.initContainers.startupProbe.grpc`](#obj-specinitcontainersstartupprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainersstartupprobegrpcwithservice) + * [`obj spec.initContainers.startupProbe.httpGet`](#obj-specinitcontainersstartupprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainersstartupprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainersstartupprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainersstartupprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainersstartupprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainersstartupprobehttpgetwithscheme) + * [`obj spec.initContainers.startupProbe.httpGet.httpHeaders`](#obj-specinitcontainersstartupprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainersstartupprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainersstartupprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.startupProbe.tcpSocket`](#obj-specinitcontainersstartupprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainersstartupprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobetcpsocketwithport) + * [`obj spec.initContainers.volumeDevices`](#obj-specinitcontainersvolumedevices) + * [`fn withDevicePath(devicePath)`](#fn-specinitcontainersvolumedeviceswithdevicepath) + * [`fn withName(name)`](#fn-specinitcontainersvolumedeviceswithname) + * [`obj spec.initContainers.volumeMounts`](#obj-specinitcontainersvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specinitcontainersvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specinitcontainersvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specinitcontainersvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specinitcontainersvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-specinitcontainersvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-specinitcontainersvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specinitcontainersvolumemountswithsubpathexpr) + * [`obj spec.objectStorageConfig`](#obj-specobjectstorageconfig) + * [`fn withKey(key)`](#fn-specobjectstorageconfigwithkey) + * [`fn withName(name)`](#fn-specobjectstorageconfigwithname) + * [`fn withOptional(optional)`](#fn-specobjectstorageconfigwithoptional) + * [`obj spec.podMetadata`](#obj-specpodmetadata) + * [`fn withAnnotations(annotations)`](#fn-specpodmetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specpodmetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specpodmetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specpodmetadatawithlabelsmixin) + * [`fn withName(name)`](#fn-specpodmetadatawithname) + * [`obj spec.prometheusRulesExcludedFromEnforce`](#obj-specprometheusrulesexcludedfromenforce) + * [`fn withRuleName(ruleName)`](#fn-specprometheusrulesexcludedfromenforcewithrulename) + * [`fn withRuleNamespace(ruleNamespace)`](#fn-specprometheusrulesexcludedfromenforcewithrulenamespace) + * [`obj spec.queryConfig`](#obj-specqueryconfig) + * [`fn withKey(key)`](#fn-specqueryconfigwithkey) + * [`fn withName(name)`](#fn-specqueryconfigwithname) + * [`fn withOptional(optional)`](#fn-specqueryconfigwithoptional) + * [`obj spec.resources`](#obj-specresources) + * [`fn withClaims(claims)`](#fn-specresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specresourceswithrequestsmixin) + * [`obj spec.resources.claims`](#obj-specresourcesclaims) + * [`fn withName(name)`](#fn-specresourcesclaimswithname) + * [`obj spec.ruleNamespaceSelector`](#obj-specrulenamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specrulenamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specrulenamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specrulenamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specrulenamespaceselectorwithmatchlabelsmixin) + * [`obj spec.ruleNamespaceSelector.matchExpressions`](#obj-specrulenamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specrulenamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specrulenamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specrulenamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specrulenamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.ruleSelector`](#obj-specruleselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specruleselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specruleselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specruleselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specruleselectorwithmatchlabelsmixin) + * [`obj spec.ruleSelector.matchExpressions`](#obj-specruleselectormatchexpressions) + * [`fn withKey(key)`](#fn-specruleselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specruleselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specruleselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specruleselectormatchexpressionswithvaluesmixin) + * [`obj spec.securityContext`](#obj-specsecuritycontext) + * [`fn withFsGroup(fsGroup)`](#fn-specsecuritycontextwithfsgroup) + * [`fn withFsGroupChangePolicy(fsGroupChangePolicy)`](#fn-specsecuritycontextwithfsgroupchangepolicy) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specsecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specsecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specsecuritycontextwithrunasuser) + * [`fn withSupplementalGroups(supplementalGroups)`](#fn-specsecuritycontextwithsupplementalgroups) + * [`fn withSupplementalGroupsMixin(supplementalGroups)`](#fn-specsecuritycontextwithsupplementalgroupsmixin) + * [`fn withSysctls(sysctls)`](#fn-specsecuritycontextwithsysctls) + * [`fn withSysctlsMixin(sysctls)`](#fn-specsecuritycontextwithsysctlsmixin) + * [`obj spec.securityContext.appArmorProfile`](#obj-specsecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specsecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specsecuritycontextapparmorprofilewithtype) + * [`obj spec.securityContext.seLinuxOptions`](#obj-specsecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specsecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specsecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specsecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specsecuritycontextselinuxoptionswithuser) + * [`obj spec.securityContext.seccompProfile`](#obj-specsecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specsecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specsecuritycontextseccompprofilewithtype) + * [`obj spec.securityContext.sysctls`](#obj-specsecuritycontextsysctls) + * [`fn withName(name)`](#fn-specsecuritycontextsysctlswithname) + * [`fn withValue(value)`](#fn-specsecuritycontextsysctlswithvalue) + * [`obj spec.securityContext.windowsOptions`](#obj-specsecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specsecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specsecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specsecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specsecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.storage`](#obj-specstorage) + * [`fn withDisableMountSubPath(disableMountSubPath)`](#fn-specstoragewithdisablemountsubpath) + * [`obj spec.storage.emptyDir`](#obj-specstorageemptydir) + * [`fn withMedium(medium)`](#fn-specstorageemptydirwithmedium) + * [`fn withSizeLimit(sizeLimit)`](#fn-specstorageemptydirwithsizelimit) + * [`obj spec.storage.ephemeral`](#obj-specstorageephemeral) + * [`obj spec.storage.ephemeral.volumeClaimTemplate`](#obj-specstorageephemeralvolumeclaimtemplate) + * [`fn withMetadata(metadata)`](#fn-specstorageephemeralvolumeclaimtemplatewithmetadata) + * [`fn withMetadataMixin(metadata)`](#fn-specstorageephemeralvolumeclaimtemplatewithmetadatamixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec`](#obj-specstorageephemeralvolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumename) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource`](#obj-specstorageephemeralvolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef`](#obj-specstorageephemeralvolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.resources`](#obj-specstorageephemeralvolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector`](#obj-specstorageephemeralvolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.storage.volumeClaimTemplate`](#obj-specstoragevolumeclaimtemplate) + * [`fn withApiVersion(apiVersion)`](#fn-specstoragevolumeclaimtemplatewithapiversion) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatewithkind) + * [`obj spec.storage.volumeClaimTemplate.metadata`](#obj-specstoragevolumeclaimtemplatemetadata) + * [`fn withAnnotations(annotations)`](#fn-specstoragevolumeclaimtemplatemetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specstoragevolumeclaimtemplatemetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specstoragevolumeclaimtemplatemetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specstoragevolumeclaimtemplatemetadatawithlabelsmixin) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatemetadatawithname) + * [`obj spec.storage.volumeClaimTemplate.spec`](#obj-specstoragevolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specstoragevolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specstoragevolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specstoragevolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specstoragevolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specstoragevolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specstoragevolumeclaimtemplatespecwithvolumename) + * [`obj spec.storage.volumeClaimTemplate.spec.dataSource`](#obj-specstoragevolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.storage.volumeClaimTemplate.spec.dataSourceRef`](#obj-specstoragevolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.storage.volumeClaimTemplate.spec.resources`](#obj-specstoragevolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specstoragevolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specstoragevolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specstoragevolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specstoragevolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.storage.volumeClaimTemplate.spec.selector`](#obj-specstoragevolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.storage.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specstoragevolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.tolerations`](#obj-spectolerations) + * [`fn withEffect(effect)`](#fn-spectolerationswitheffect) + * [`fn withKey(key)`](#fn-spectolerationswithkey) + * [`fn withOperator(operator)`](#fn-spectolerationswithoperator) + * [`fn withTolerationSeconds(tolerationSeconds)`](#fn-spectolerationswithtolerationseconds) + * [`fn withValue(value)`](#fn-spectolerationswithvalue) + * [`obj spec.topologySpreadConstraints`](#obj-spectopologyspreadconstraints) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeysmixin) + * [`fn withMaxSkew(maxSkew)`](#fn-spectopologyspreadconstraintswithmaxskew) + * [`fn withMinDomains(minDomains)`](#fn-spectopologyspreadconstraintswithmindomains) + * [`fn withNodeAffinityPolicy(nodeAffinityPolicy)`](#fn-spectopologyspreadconstraintswithnodeaffinitypolicy) + * [`fn withNodeTaintsPolicy(nodeTaintsPolicy)`](#fn-spectopologyspreadconstraintswithnodetaintspolicy) + * [`fn withTopologyKey(topologyKey)`](#fn-spectopologyspreadconstraintswithtopologykey) + * [`fn withWhenUnsatisfiable(whenUnsatisfiable)`](#fn-spectopologyspreadconstraintswithwhenunsatisfiable) + * [`obj spec.topologySpreadConstraints.labelSelector`](#obj-spectopologyspreadconstraintslabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchlabelsmixin) + * [`obj spec.topologySpreadConstraints.labelSelector.matchExpressions`](#obj-spectopologyspreadconstraintslabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.tracingConfig`](#obj-spectracingconfig) + * [`fn withKey(key)`](#fn-spectracingconfigwithkey) + * [`fn withName(name)`](#fn-spectracingconfigwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigwithoptional) + * [`obj spec.volumeMounts`](#obj-specvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-specvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-specvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specvolumemountswithsubpathexpr) + * [`obj spec.volumes`](#obj-specvolumes) + * [`fn withName(name)`](#fn-specvolumeswithname) + * [`obj spec.volumes.awsElasticBlockStore`](#obj-specvolumesawselasticblockstore) + * [`fn withFsType(fsType)`](#fn-specvolumesawselasticblockstorewithfstype) + * [`fn withPartition(partition)`](#fn-specvolumesawselasticblockstorewithpartition) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesawselasticblockstorewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumesawselasticblockstorewithvolumeid) + * [`obj spec.volumes.azureDisk`](#obj-specvolumesazuredisk) + * [`fn withCachingMode(cachingMode)`](#fn-specvolumesazurediskwithcachingmode) + * [`fn withDiskName(diskName)`](#fn-specvolumesazurediskwithdiskname) + * [`fn withDiskURI(diskURI)`](#fn-specvolumesazurediskwithdiskuri) + * [`fn withFsType(fsType)`](#fn-specvolumesazurediskwithfstype) + * [`fn withKind(kind)`](#fn-specvolumesazurediskwithkind) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesazurediskwithreadonly) + * [`obj spec.volumes.azureFile`](#obj-specvolumesazurefile) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesazurefilewithreadonly) + * [`fn withSecretName(secretName)`](#fn-specvolumesazurefilewithsecretname) + * [`fn withShareName(shareName)`](#fn-specvolumesazurefilewithsharename) + * [`obj spec.volumes.cephfs`](#obj-specvolumescephfs) + * [`fn withMonitors(monitors)`](#fn-specvolumescephfswithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specvolumescephfswithmonitorsmixin) + * [`fn withPath(path)`](#fn-specvolumescephfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescephfswithreadonly) + * [`fn withSecretFile(secretFile)`](#fn-specvolumescephfswithsecretfile) + * [`fn withUser(user)`](#fn-specvolumescephfswithuser) + * [`obj spec.volumes.cephfs.secretRef`](#obj-specvolumescephfssecretref) + * [`fn withName(name)`](#fn-specvolumescephfssecretrefwithname) + * [`obj spec.volumes.cinder`](#obj-specvolumescinder) + * [`fn withFsType(fsType)`](#fn-specvolumescinderwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescinderwithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumescinderwithvolumeid) + * [`obj spec.volumes.cinder.secretRef`](#obj-specvolumescindersecretref) + * [`fn withName(name)`](#fn-specvolumescindersecretrefwithname) + * [`obj spec.volumes.configMap`](#obj-specvolumesconfigmap) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesconfigmapwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specvolumesconfigmapwithoptional) + * [`obj spec.volumes.configMap.items`](#obj-specvolumesconfigmapitems) + * [`fn withKey(key)`](#fn-specvolumesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesconfigmapitemswithpath) + * [`obj spec.volumes.csi`](#obj-specvolumescsi) + * [`fn withDriver(driver)`](#fn-specvolumescsiwithdriver) + * [`fn withFsType(fsType)`](#fn-specvolumescsiwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescsiwithreadonly) + * [`fn withVolumeAttributes(volumeAttributes)`](#fn-specvolumescsiwithvolumeattributes) + * [`fn withVolumeAttributesMixin(volumeAttributes)`](#fn-specvolumescsiwithvolumeattributesmixin) + * [`obj spec.volumes.csi.nodePublishSecretRef`](#obj-specvolumescsinodepublishsecretref) + * [`fn withName(name)`](#fn-specvolumescsinodepublishsecretrefwithname) + * [`obj spec.volumes.downwardAPI`](#obj-specvolumesdownwardapi) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesdownwardapiwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesdownwardapiwithitemsmixin) + * [`obj spec.volumes.downwardAPI.items`](#obj-specvolumesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specvolumesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesdownwardapiitemswithpath) + * [`obj spec.volumes.downwardAPI.items.fieldRef`](#obj-specvolumesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specvolumesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specvolumesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.volumes.downwardAPI.items.resourceFieldRef`](#obj-specvolumesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.volumes.emptyDir`](#obj-specvolumesemptydir) + * [`fn withMedium(medium)`](#fn-specvolumesemptydirwithmedium) + * [`fn withSizeLimit(sizeLimit)`](#fn-specvolumesemptydirwithsizelimit) + * [`obj spec.volumes.ephemeral`](#obj-specvolumesephemeral) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate`](#obj-specvolumesephemeralvolumeclaimtemplate) + * [`fn withMetadata(metadata)`](#fn-specvolumesephemeralvolumeclaimtemplatewithmetadata) + * [`fn withMetadataMixin(metadata)`](#fn-specvolumesephemeralvolumeclaimtemplatewithmetadatamixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec`](#obj-specvolumesephemeralvolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumename) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource`](#obj-specvolumesephemeralvolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef`](#obj-specvolumesephemeralvolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.resources`](#obj-specvolumesephemeralvolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector`](#obj-specvolumesephemeralvolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.volumes.fc`](#obj-specvolumesfc) + * [`fn withFsType(fsType)`](#fn-specvolumesfcwithfstype) + * [`fn withLun(lun)`](#fn-specvolumesfcwithlun) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesfcwithreadonly) + * [`fn withTargetWWNs(targetWWNs)`](#fn-specvolumesfcwithtargetwwns) + * [`fn withTargetWWNsMixin(targetWWNs)`](#fn-specvolumesfcwithtargetwwnsmixin) + * [`fn withWwids(wwids)`](#fn-specvolumesfcwithwwids) + * [`fn withWwidsMixin(wwids)`](#fn-specvolumesfcwithwwidsmixin) + * [`obj spec.volumes.flexVolume`](#obj-specvolumesflexvolume) + * [`fn withDriver(driver)`](#fn-specvolumesflexvolumewithdriver) + * [`fn withFsType(fsType)`](#fn-specvolumesflexvolumewithfstype) + * [`fn withOptions(options)`](#fn-specvolumesflexvolumewithoptions) + * [`fn withOptionsMixin(options)`](#fn-specvolumesflexvolumewithoptionsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesflexvolumewithreadonly) + * [`obj spec.volumes.flexVolume.secretRef`](#obj-specvolumesflexvolumesecretref) + * [`fn withName(name)`](#fn-specvolumesflexvolumesecretrefwithname) + * [`obj spec.volumes.flocker`](#obj-specvolumesflocker) + * [`fn withDatasetName(datasetName)`](#fn-specvolumesflockerwithdatasetname) + * [`fn withDatasetUUID(datasetUUID)`](#fn-specvolumesflockerwithdatasetuuid) + * [`obj spec.volumes.gcePersistentDisk`](#obj-specvolumesgcepersistentdisk) + * [`fn withFsType(fsType)`](#fn-specvolumesgcepersistentdiskwithfstype) + * [`fn withPartition(partition)`](#fn-specvolumesgcepersistentdiskwithpartition) + * [`fn withPdName(pdName)`](#fn-specvolumesgcepersistentdiskwithpdname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesgcepersistentdiskwithreadonly) + * [`obj spec.volumes.gitRepo`](#obj-specvolumesgitrepo) + * [`fn withDirectory(directory)`](#fn-specvolumesgitrepowithdirectory) + * [`fn withRepository(repository)`](#fn-specvolumesgitrepowithrepository) + * [`fn withRevision(revision)`](#fn-specvolumesgitrepowithrevision) + * [`obj spec.volumes.glusterfs`](#obj-specvolumesglusterfs) + * [`fn withEndpoints(endpoints)`](#fn-specvolumesglusterfswithendpoints) + * [`fn withPath(path)`](#fn-specvolumesglusterfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesglusterfswithreadonly) + * [`obj spec.volumes.hostPath`](#obj-specvolumeshostpath) + * [`fn withPath(path)`](#fn-specvolumeshostpathwithpath) + * [`fn withType(type)`](#fn-specvolumeshostpathwithtype) + * [`obj spec.volumes.iscsi`](#obj-specvolumesiscsi) + * [`fn withChapAuthDiscovery(chapAuthDiscovery)`](#fn-specvolumesiscsiwithchapauthdiscovery) + * [`fn withChapAuthSession(chapAuthSession)`](#fn-specvolumesiscsiwithchapauthsession) + * [`fn withFsType(fsType)`](#fn-specvolumesiscsiwithfstype) + * [`fn withInitiatorName(initiatorName)`](#fn-specvolumesiscsiwithinitiatorname) + * [`fn withIqn(iqn)`](#fn-specvolumesiscsiwithiqn) + * [`fn withIscsiInterface(iscsiInterface)`](#fn-specvolumesiscsiwithiscsiinterface) + * [`fn withLun(lun)`](#fn-specvolumesiscsiwithlun) + * [`fn withPortals(portals)`](#fn-specvolumesiscsiwithportals) + * [`fn withPortalsMixin(portals)`](#fn-specvolumesiscsiwithportalsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesiscsiwithreadonly) + * [`fn withTargetPortal(targetPortal)`](#fn-specvolumesiscsiwithtargetportal) + * [`obj spec.volumes.iscsi.secretRef`](#obj-specvolumesiscsisecretref) + * [`fn withName(name)`](#fn-specvolumesiscsisecretrefwithname) + * [`obj spec.volumes.nfs`](#obj-specvolumesnfs) + * [`fn withPath(path)`](#fn-specvolumesnfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesnfswithreadonly) + * [`fn withServer(server)`](#fn-specvolumesnfswithserver) + * [`obj spec.volumes.persistentVolumeClaim`](#obj-specvolumespersistentvolumeclaim) + * [`fn withClaimName(claimName)`](#fn-specvolumespersistentvolumeclaimwithclaimname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumespersistentvolumeclaimwithreadonly) + * [`obj spec.volumes.photonPersistentDisk`](#obj-specvolumesphotonpersistentdisk) + * [`fn withFsType(fsType)`](#fn-specvolumesphotonpersistentdiskwithfstype) + * [`fn withPdID(pdID)`](#fn-specvolumesphotonpersistentdiskwithpdid) + * [`obj spec.volumes.portworxVolume`](#obj-specvolumesportworxvolume) + * [`fn withFsType(fsType)`](#fn-specvolumesportworxvolumewithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesportworxvolumewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumesportworxvolumewithvolumeid) + * [`obj spec.volumes.projected`](#obj-specvolumesprojected) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesprojectedwithdefaultmode) + * [`fn withSources(sources)`](#fn-specvolumesprojectedwithsources) + * [`fn withSourcesMixin(sources)`](#fn-specvolumesprojectedwithsourcesmixin) + * [`obj spec.volumes.projected.sources`](#obj-specvolumesprojectedsources) + * [`obj spec.volumes.projected.sources.clusterTrustBundle`](#obj-specvolumesprojectedsourcesclustertrustbundle) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithoptional) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithpath) + * [`fn withSignerName(signerName)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithsignername) + * [`obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector`](#obj-specvolumesprojectedsourcesclustertrustbundlelabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchlabelsmixin) + * [`obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions`](#obj-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.volumes.projected.sources.configMap`](#obj-specvolumesprojectedsourcesconfigmap) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcesconfigmapwithoptional) + * [`obj spec.volumes.projected.sources.configMap.items`](#obj-specvolumesprojectedsourcesconfigmapitems) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesconfigmapitemswithpath) + * [`obj spec.volumes.projected.sources.downwardAPI`](#obj-specvolumesprojectedsourcesdownwardapi) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcesdownwardapiwithitemsmixin) + * [`obj spec.volumes.projected.sources.downwardAPI.items`](#obj-specvolumesprojectedsourcesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesdownwardapiitemswithpath) + * [`obj spec.volumes.projected.sources.downwardAPI.items.fieldRef`](#obj-specvolumesprojectedsourcesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specvolumesprojectedsourcesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specvolumesprojectedsourcesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef`](#obj-specvolumesprojectedsourcesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.volumes.projected.sources.secret`](#obj-specvolumesprojectedsourcessecret) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcessecretwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcessecretwithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcessecretwithoptional) + * [`obj spec.volumes.projected.sources.secret.items`](#obj-specvolumesprojectedsourcessecretitems) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcessecretitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcessecretitemswithpath) + * [`obj spec.volumes.projected.sources.serviceAccountToken`](#obj-specvolumesprojectedsourcesserviceaccounttoken) + * [`fn withAudience(audience)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithaudience) + * [`fn withExpirationSeconds(expirationSeconds)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithexpirationseconds) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithpath) + * [`obj spec.volumes.quobyte`](#obj-specvolumesquobyte) + * [`fn withGroup(group)`](#fn-specvolumesquobytewithgroup) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesquobytewithreadonly) + * [`fn withRegistry(registry)`](#fn-specvolumesquobytewithregistry) + * [`fn withTenant(tenant)`](#fn-specvolumesquobytewithtenant) + * [`fn withUser(user)`](#fn-specvolumesquobytewithuser) + * [`fn withVolume(volume)`](#fn-specvolumesquobytewithvolume) + * [`obj spec.volumes.rbd`](#obj-specvolumesrbd) + * [`fn withFsType(fsType)`](#fn-specvolumesrbdwithfstype) + * [`fn withImage(image)`](#fn-specvolumesrbdwithimage) + * [`fn withKeyring(keyring)`](#fn-specvolumesrbdwithkeyring) + * [`fn withMonitors(monitors)`](#fn-specvolumesrbdwithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specvolumesrbdwithmonitorsmixin) + * [`fn withPool(pool)`](#fn-specvolumesrbdwithpool) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesrbdwithreadonly) + * [`fn withUser(user)`](#fn-specvolumesrbdwithuser) + * [`obj spec.volumes.rbd.secretRef`](#obj-specvolumesrbdsecretref) + * [`fn withName(name)`](#fn-specvolumesrbdsecretrefwithname) + * [`obj spec.volumes.scaleIO`](#obj-specvolumesscaleio) + * [`fn withFsType(fsType)`](#fn-specvolumesscaleiowithfstype) + * [`fn withGateway(gateway)`](#fn-specvolumesscaleiowithgateway) + * [`fn withProtectionDomain(protectionDomain)`](#fn-specvolumesscaleiowithprotectiondomain) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesscaleiowithreadonly) + * [`fn withSslEnabled(sslEnabled)`](#fn-specvolumesscaleiowithsslenabled) + * [`fn withStorageMode(storageMode)`](#fn-specvolumesscaleiowithstoragemode) + * [`fn withStoragePool(storagePool)`](#fn-specvolumesscaleiowithstoragepool) + * [`fn withSystem(system)`](#fn-specvolumesscaleiowithsystem) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesscaleiowithvolumename) + * [`obj spec.volumes.scaleIO.secretRef`](#obj-specvolumesscaleiosecretref) + * [`fn withName(name)`](#fn-specvolumesscaleiosecretrefwithname) + * [`obj spec.volumes.secret`](#obj-specvolumessecret) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumessecretwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumessecretwithitemsmixin) + * [`fn withOptional(optional)`](#fn-specvolumessecretwithoptional) + * [`fn withSecretName(secretName)`](#fn-specvolumessecretwithsecretname) + * [`obj spec.volumes.secret.items`](#obj-specvolumessecretitems) + * [`fn withKey(key)`](#fn-specvolumessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumessecretitemswithmode) + * [`fn withPath(path)`](#fn-specvolumessecretitemswithpath) + * [`obj spec.volumes.storageos`](#obj-specvolumesstorageos) + * [`fn withFsType(fsType)`](#fn-specvolumesstorageoswithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesstorageoswithreadonly) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesstorageoswithvolumename) + * [`fn withVolumeNamespace(volumeNamespace)`](#fn-specvolumesstorageoswithvolumenamespace) + * [`obj spec.volumes.storageos.secretRef`](#obj-specvolumesstorageossecretref) + * [`fn withName(name)`](#fn-specvolumesstorageossecretrefwithname) + * [`obj spec.volumes.vsphereVolume`](#obj-specvolumesvspherevolume) + * [`fn withFsType(fsType)`](#fn-specvolumesvspherevolumewithfstype) + * [`fn withStoragePolicyID(storagePolicyID)`](#fn-specvolumesvspherevolumewithstoragepolicyid) + * [`fn withStoragePolicyName(storagePolicyName)`](#fn-specvolumesvspherevolumewithstoragepolicyname) + * [`fn withVolumePath(volumePath)`](#fn-specvolumesvspherevolumewithvolumepath) + * [`obj spec.web`](#obj-specweb) + * [`obj spec.web.httpConfig`](#obj-specwebhttpconfig) + * [`fn withHttp2(http2)`](#fn-specwebhttpconfigwithhttp2) + * [`obj spec.web.httpConfig.headers`](#obj-specwebhttpconfigheaders) + * [`fn withContentSecurityPolicy(contentSecurityPolicy)`](#fn-specwebhttpconfigheaderswithcontentsecuritypolicy) + * [`fn withStrictTransportSecurity(strictTransportSecurity)`](#fn-specwebhttpconfigheaderswithstricttransportsecurity) + * [`fn withXContentTypeOptions(xContentTypeOptions)`](#fn-specwebhttpconfigheaderswithxcontenttypeoptions) + * [`fn withXFrameOptions(xFrameOptions)`](#fn-specwebhttpconfigheaderswithxframeoptions) + * [`fn withXXSSProtection(xXSSProtection)`](#fn-specwebhttpconfigheaderswithxxssprotection) + * [`obj spec.web.tlsConfig`](#obj-specwebtlsconfig) + * [`fn withCipherSuites(cipherSuites)`](#fn-specwebtlsconfigwithciphersuites) + * [`fn withCipherSuitesMixin(cipherSuites)`](#fn-specwebtlsconfigwithciphersuitesmixin) + * [`fn withClientAuthType(clientAuthType)`](#fn-specwebtlsconfigwithclientauthtype) + * [`fn withCurvePreferences(curvePreferences)`](#fn-specwebtlsconfigwithcurvepreferences) + * [`fn withCurvePreferencesMixin(curvePreferences)`](#fn-specwebtlsconfigwithcurvepreferencesmixin) + * [`fn withMaxVersion(maxVersion)`](#fn-specwebtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specwebtlsconfigwithminversion) + * [`fn withPreferServerCipherSuites(preferServerCipherSuites)`](#fn-specwebtlsconfigwithpreferserverciphersuites) + * [`obj spec.web.tlsConfig.cert`](#obj-specwebtlsconfigcert) + * [`obj spec.web.tlsConfig.cert.configMap`](#obj-specwebtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specwebtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigcertconfigmapwithoptional) + * [`obj spec.web.tlsConfig.cert.secret`](#obj-specwebtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigcertsecretwithoptional) + * [`obj spec.web.tlsConfig.client_ca`](#obj-specwebtlsconfigclient_ca) + * [`obj spec.web.tlsConfig.client_ca.configMap`](#obj-specwebtlsconfigclient_caconfigmap) + * [`fn withKey(key)`](#fn-specwebtlsconfigclient_caconfigmapwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigclient_caconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigclient_caconfigmapwithoptional) + * [`obj spec.web.tlsConfig.client_ca.secret`](#obj-specwebtlsconfigclient_casecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigclient_casecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigclient_casecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigclient_casecretwithoptional) + * [`obj spec.web.tlsConfig.keySecret`](#obj-specwebtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigkeysecretwithoptional) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ThanosRuler + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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 ThanosRuler cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" + +### fn spec.withAdditionalArgs + +```ts +withAdditionalArgs(additionalArgs) +``` + +"AdditionalArgs allows setting additional arguments for the ThanosRuler container.\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nThanosRuler container which may cause issues if they are invalid or not supported\nby the given ThanosRuler version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument the reconciliation will\nfail and an error will be logged." + +### fn spec.withAdditionalArgsMixin + +```ts +withAdditionalArgsMixin(additionalArgs) +``` + +"AdditionalArgs allows setting additional arguments for the ThanosRuler container.\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nThanosRuler container which may cause issues if they are invalid or not supported\nby the given ThanosRuler version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument the reconciliation will\nfail and an error will be logged." + +**Note:** This function appends passed data to existing values + +### fn spec.withAlertDropLabels + +```ts +withAlertDropLabels(alertDropLabels) +``` + +"AlertDropLabels configure the label names which should be dropped in ThanosRuler alerts.\nThe replica label `thanos_ruler_replica` will always be dropped in alerts." + +### fn spec.withAlertDropLabelsMixin + +```ts +withAlertDropLabelsMixin(alertDropLabels) +``` + +"AlertDropLabels configure the label names which should be dropped in ThanosRuler alerts.\nThe replica label `thanos_ruler_replica` will always be dropped in alerts." + +**Note:** This function appends passed data to existing values + +### fn spec.withAlertQueryUrl + +```ts +withAlertQueryUrl(alertQueryUrl) +``` + +"The external Query URL the Thanos Ruler will set in the 'Source' field\nof all alerts.\nMaps to the '--alert.query-url' CLI arg." + +### fn spec.withAlertRelabelConfigFile + +```ts +withAlertRelabelConfigFile(alertRelabelConfigFile) +``` + +"AlertRelabelConfigFile specifies the path of the alert relabeling configuration file.\nWhen used alongside with AlertRelabelConfigs, alertRelabelConfigFile takes precedence." + +### fn spec.withAlertmanagersUrl + +```ts +withAlertmanagersUrl(alertmanagersUrl) +``` + +"Define URLs to send alerts to Alertmanager. For Thanos v0.10.0 and higher,\nAlertManagersConfig should be used instead. Note: this field will be ignored\nif AlertManagersConfig is specified.\nMaps to the `alertmanagers.url` arg." + +### fn spec.withAlertmanagersUrlMixin + +```ts +withAlertmanagersUrlMixin(alertmanagersUrl) +``` + +"Define URLs to send alerts to Alertmanager. For Thanos v0.10.0 and higher,\nAlertManagersConfig should be used instead. Note: this field will be ignored\nif AlertManagersConfig is specified.\nMaps to the `alertmanagers.url` arg." + +**Note:** This function appends passed data to existing values + +### fn spec.withContainers + +```ts +withContainers(containers) +``` + +"Containers allows injecting additional containers or modifying operator generated\ncontainers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or\nto change the behavior of an operator generated container. Containers described here modify\nan operator generated container if they share the same name and modifications are done via a\nstrategic merge patch. The current container names are: `thanos-ruler` and `config-reloader`.\nOverriding containers is entirely outside the scope of what the maintainers will support and by doing\nso, you accept that this behaviour may break at any time without notice." + +### fn spec.withContainersMixin + +```ts +withContainersMixin(containers) +``` + +"Containers allows injecting additional containers or modifying operator generated\ncontainers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or\nto change the behavior of an operator generated container. Containers described here modify\nan operator generated container if they share the same name and modifications are done via a\nstrategic merge patch. The current container names are: `thanos-ruler` and `config-reloader`.\nOverriding containers is entirely outside the scope of what the maintainers will support and by doing\nso, you accept that this behaviour may break at any time without notice." + +**Note:** This function appends passed data to existing values + +### fn spec.withEnforcedNamespaceLabel + +```ts +withEnforcedNamespaceLabel(enforcedNamespaceLabel) +``` + +"EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert\nand metric that is user created. The label value will always be the namespace of the object that is\nbeing created." + +### fn spec.withEvaluationInterval + +```ts +withEvaluationInterval(evaluationInterval) +``` + +"Interval between consecutive evaluations." + +### fn spec.withExcludedFromEnforcement + +```ts +withExcludedFromEnforcement(excludedFromEnforcement) +``` + +"List of references to PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\nApplies only if enforcedNamespaceLabel set to true." + +### fn spec.withExcludedFromEnforcementMixin + +```ts +withExcludedFromEnforcementMixin(excludedFromEnforcement) +``` + +"List of references to PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\nApplies only if enforcedNamespaceLabel set to true." + +**Note:** This function appends passed data to existing values + +### fn spec.withExternalPrefix + +```ts +withExternalPrefix(externalPrefix) +``` + +"The external URL the Thanos Ruler instances will be available under. This is\nnecessary to generate correct URLs. This is necessary if Thanos Ruler is not\nserved from root of a DNS name." + +### fn spec.withHostAliases + +```ts +withHostAliases(hostAliases) +``` + +"Pods' hostAliases configuration" + +### fn spec.withHostAliasesMixin + +```ts +withHostAliasesMixin(hostAliases) +``` + +"Pods' hostAliases configuration" + +**Note:** This function appends passed data to existing values + +### fn spec.withImage + +```ts +withImage(image) +``` + +"Thanos container image URL." + +### fn spec.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy for the 'thanos', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details." + +### fn spec.withImagePullSecrets + +```ts +withImagePullSecrets(imagePullSecrets) +``` + +"An optional list of references to secrets in the same namespace\nto use for pulling thanos images from registries\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +### fn spec.withImagePullSecretsMixin + +```ts +withImagePullSecretsMixin(imagePullSecrets) +``` + +"An optional list of references to secrets in the same namespace\nto use for pulling thanos images from registries\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +**Note:** This function appends passed data to existing values + +### fn spec.withInitContainers + +```ts +withInitContainers(initContainers) +``` + +"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the ThanosRuler configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that this behaviour may break\nat any time without notice." + +### fn spec.withInitContainersMixin + +```ts +withInitContainersMixin(initContainers) +``` + +"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the ThanosRuler configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that this behaviour may break\nat any time without notice." + +**Note:** This function appends passed data to existing values + +### fn spec.withLabels + +```ts +withLabels(labels) +``` + +"Labels configure the external label pairs to ThanosRuler. A default replica label\n`thanos_ruler_replica` will be always added as a label with the value of the pod's name and it will be dropped in the alerts." + +### fn spec.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Labels configure the external label pairs to ThanosRuler. A default replica label\n`thanos_ruler_replica` will be always added as a label with the value of the pod's name and it will be dropped in the alerts." + +**Note:** This function appends passed data to existing values + +### fn spec.withListenLocal + +```ts +withListenLocal(listenLocal) +``` + +"ListenLocal makes the Thanos ruler listen on loopback, so that it\ndoes not bind against the Pod IP." + +### fn spec.withLogFormat + +```ts +withLogFormat(logFormat) +``` + +"Log format for ThanosRuler to be configured with." + +### fn spec.withLogLevel + +```ts +withLogLevel(logLevel) +``` + +"Log level for ThanosRuler to be configured with." + +### fn spec.withMinReadySeconds + +```ts +withMinReadySeconds(minReadySeconds) +``` + +"Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\nThis is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate." + +### fn spec.withNodeSelector + +```ts +withNodeSelector(nodeSelector) +``` + +"Define which Nodes the Pods are scheduled on." + +### fn spec.withNodeSelectorMixin + +```ts +withNodeSelectorMixin(nodeSelector) +``` + +"Define which Nodes the Pods are scheduled on." + +**Note:** This function appends passed data to existing values + +### fn spec.withObjectStorageConfigFile + +```ts +withObjectStorageConfigFile(objectStorageConfigFile) +``` + +"ObjectStorageConfigFile specifies the path of the object storage configuration file.\nWhen used alongside with ObjectStorageConfig, ObjectStorageConfigFile takes precedence." + +### fn spec.withPaused + +```ts +withPaused(paused) +``` + +"When a ThanosRuler deployment is paused, no actions except for deletion\nwill be performed on the underlying objects." + +### fn spec.withPortName + +```ts +withPortName(portName) +``` + +"Port name used for the pods and governing service.\nDefaults to `web`." + +### fn spec.withPriorityClassName + +```ts +withPriorityClassName(priorityClassName) +``` + +"Priority class assigned to the Pods" + +### fn spec.withPrometheusRulesExcludedFromEnforce + +```ts +withPrometheusRulesExcludedFromEnforce(prometheusRulesExcludedFromEnforce) +``` + +"PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing\nof adding namespace labels. Works only if enforcedNamespaceLabel set to true.\nMake sure both ruleNamespace and ruleName are set for each pair\nDeprecated: use excludedFromEnforcement instead." + +### fn spec.withPrometheusRulesExcludedFromEnforceMixin + +```ts +withPrometheusRulesExcludedFromEnforceMixin(prometheusRulesExcludedFromEnforce) +``` + +"PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing\nof adding namespace labels. Works only if enforcedNamespaceLabel set to true.\nMake sure both ruleNamespace and ruleName are set for each pair\nDeprecated: use excludedFromEnforcement instead." + +**Note:** This function appends passed data to existing values + +### fn spec.withQueryEndpoints + +```ts +withQueryEndpoints(queryEndpoints) +``` + +"QueryEndpoints defines Thanos querier endpoints from which to query metrics.\nMaps to the --query flag of thanos ruler." + +### fn spec.withQueryEndpointsMixin + +```ts +withQueryEndpointsMixin(queryEndpoints) +``` + +"QueryEndpoints defines Thanos querier endpoints from which to query metrics.\nMaps to the --query flag of thanos ruler." + +**Note:** This function appends passed data to existing values + +### fn spec.withReplicas + +```ts +withReplicas(replicas) +``` + +"Number of thanos ruler instances to deploy." + +### fn spec.withRetention + +```ts +withRetention(retention) +``` + +"Time duration ThanosRuler shall retain data for. Default is '24h',\nand must match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds seconds minutes hours days weeks years)." + +### fn spec.withRoutePrefix + +```ts +withRoutePrefix(routePrefix) +``` + +"The route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path." + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"ServiceAccountName is the name of the ServiceAccount to use to run the\nThanos Ruler Pods." + +### fn spec.withTolerations + +```ts +withTolerations(tolerations) +``` + +"If specified, the pod's tolerations." + +### fn spec.withTolerationsMixin + +```ts +withTolerationsMixin(tolerations) +``` + +"If specified, the pod's tolerations." + +**Note:** This function appends passed data to existing values + +### fn spec.withTopologySpreadConstraints + +```ts +withTopologySpreadConstraints(topologySpreadConstraints) +``` + +"If specified, the pod's topology spread constraints." + +### fn spec.withTopologySpreadConstraintsMixin + +```ts +withTopologySpreadConstraintsMixin(topologySpreadConstraints) +``` + +"If specified, the pod's topology spread constraints." + +**Note:** This function appends passed data to existing values + +### fn spec.withTracingConfigFile + +```ts +withTracingConfigFile(tracingConfigFile) +``` + +"TracingConfig specifies the path of the tracing configuration file.\n\n\nThis field takes precedence over `tracingConfig`.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.withVersion + +```ts +withVersion(version) +``` + +"Version of Thanos to be deployed." + +### fn spec.withVolumeMounts + +```ts +withVolumeMounts(volumeMounts) +``` + +"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the ruler container,\nthat are generated as a result of StorageSpec objects." + +### fn spec.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the ruler container,\nthat are generated as a result of StorageSpec objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withVolumes + +```ts +withVolumes(volumes) +``` + +"Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will\nbe appended to other volumes that are generated as a result of StorageSpec objects." + +### fn spec.withVolumesMixin + +```ts +withVolumesMixin(volumes) +``` + +"Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will\nbe appended to other volumes that are generated as a result of StorageSpec objects." + +**Note:** This function appends passed data to existing values + +## obj spec.additionalArgs + +"AdditionalArgs allows setting additional arguments for the ThanosRuler container.\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nThanosRuler container which may cause issues if they are invalid or not supported\nby the given ThanosRuler version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument the reconciliation will\nfail and an error will be logged." + +### fn spec.additionalArgs.withName + +```ts +withName(name) +``` + +"Name of the argument, e.g. \"scrape.discovery-reload-interval\"." + +### fn spec.additionalArgs.withValue + +```ts +withValue(value) +``` + +"Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)" + +## 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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(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\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +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 + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin + +```ts +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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms + +```ts +withNodeSelectorTerms(nodeSelectorTerms) +``` + +"Required. A list of node selector terms. The terms are ORed." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin + +```ts +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 + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin + +```ts +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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm 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\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm,\nin 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.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm 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\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm,\nin 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.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.alertRelabelConfigs + +"AlertRelabelConfigs configures alert relabeling in ThanosRuler.\nAlert relabel configurations must have the form as specified in the official Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\nAlternative to AlertRelabelConfigFile, and lower order priority." + +### fn spec.alertRelabelConfigs.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertRelabelConfigs.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertRelabelConfigs.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.alertmanagersConfig + +"Define configuration for connecting to alertmanager. Only available with thanos v0.10.0\nand higher. Maps to the `alertmanagers.config` arg." + +### fn spec.alertmanagersConfig.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.alertmanagersConfig.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.alertmanagersConfig.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.containers + +"Containers allows injecting additional containers or modifying operator generated\ncontainers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or\nto change the behavior of an operator generated container. Containers described here modify\nan operator generated container if they share the same name and modifications are done via a\nstrategic merge patch. The current container names are: `thanos-ruler` and `config-reloader`.\nOverriding containers is entirely outside the scope of what the maintainers will support and by doing\nso, you accept that this behaviour may break at any time without notice." + +### fn spec.containers.withArgs + +```ts +withArgs(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.containers.withArgsMixin + +```ts +withArgsMixin(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withCommand(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.containers.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.containers.withEnvFrom + +```ts +withEnvFrom(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.containers.withEnvFromMixin + +```ts +withEnvFromMixin(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withImage + +```ts +withImage(image) +``` + +"Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets." + +### fn spec.containers.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + +### fn spec.containers.withName + +```ts +withName(name) +``` + +"Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + +### fn spec.containers.withPorts + +```ts +withPorts(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.containers.withPortsMixin + +```ts +withPortsMixin(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withResizePolicy + +```ts +withResizePolicy(resizePolicy) +``` + +"Resources resize policy for the container." + +### fn spec.containers.withResizePolicyMixin + +```ts +withResizePolicyMixin(resizePolicy) +``` + +"Resources resize policy for the container." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted." + +### fn spec.containers.withStdin + +```ts +withStdin(stdin) +``` + +"Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false." + +### fn spec.containers.withStdinOnce + +```ts +withStdinOnce(stdinOnce) +``` + +"Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false" + +### fn spec.containers.withTerminationMessagePath + +```ts +withTerminationMessagePath(terminationMessagePath) +``` + +"Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated." + +### fn spec.containers.withTerminationMessagePolicy + +```ts +withTerminationMessagePolicy(terminationMessagePolicy) +``` + +"Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated." + +### fn spec.containers.withTty + +```ts +withTty(tty) +``` + +"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false." + +### fn spec.containers.withVolumeDevices + +```ts +withVolumeDevices(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.containers.withVolumeDevicesMixin + +```ts +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 + +```ts +withVolumeMounts(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +### fn spec.containers.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withWorkingDir + +```ts +withWorkingDir(workingDir) +``` + +"Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated." + +## obj spec.containers.env + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.containers.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.containers.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"." + +## obj spec.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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.containers.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.env.valueFrom.configMapKeyRef.withOptional + +```ts +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['']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.containers.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.containers.env.valueFrom.fieldRef.withFieldPath + +```ts +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\n(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 + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.containers.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.containers.env.valueFrom.resourceFieldRef.withResource + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.containers.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.env.valueFrom.secretKeyRef.withOptional + +```ts +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.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.containers.envFrom.withPrefix + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.envFrom.configMapRef.withOptional + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.envFrom.secretRef.withOptional + +```ts +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.\nCannot be updated." + +## obj spec.containers.lifecycle.postStart + +"PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.containers.lifecycle.postStart.exec + +"Exec specifies the action to take." + +### fn spec.containers.lifecycle.postStart.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.lifecycle.postStart.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.lifecycle.postStart.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.lifecycle.postStart.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.lifecycle.postStart.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.lifecycle.postStart.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.lifecycle.postStart.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.lifecycle.postStart.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.containers.lifecycle.postStart.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.containers.lifecycle.postStart.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.containers.lifecycle.postStart.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.lifecycle.postStart.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.lifecycle.preStop + +"PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.containers.lifecycle.preStop.exec + +"Exec specifies the action to take." + +### fn spec.containers.lifecycle.preStop.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.lifecycle.preStop.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.lifecycle.preStop.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.lifecycle.preStop.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.lifecycle.preStop.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.lifecycle.preStop.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.lifecycle.preStop.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.lifecycle.preStop.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.containers.lifecycle.preStop.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.containers.lifecycle.preStop.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.containers.lifecycle.preStop.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.lifecycle.preStop.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.livenessProbe + +"Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.livenessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.livenessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.livenessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.livenessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.livenessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.livenessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.livenessProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.livenessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.livenessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.livenessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.livenessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.livenessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.livenessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.livenessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.livenessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.livenessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.livenessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.livenessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.livenessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.livenessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.livenessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.ports + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.containers.ports.withContainerPort + +```ts +withContainerPort(containerPort) +``` + +"Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536." + +### fn spec.containers.ports.withHostIP + +```ts +withHostIP(hostIP) +``` + +"What host IP to bind the external port to." + +### fn spec.containers.ports.withHostPort + +```ts +withHostPort(hostPort) +``` + +"Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this." + +### fn spec.containers.ports.withName + +```ts +withName(name) +``` + +"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services." + +### fn spec.containers.ports.withProtocol + +```ts +withProtocol(protocol) +``` + +"Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\"." + +## obj spec.containers.readinessProbe + +"Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.readinessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.readinessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.readinessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.readinessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.readinessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.readinessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.readinessProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.readinessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.readinessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.readinessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.readinessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.readinessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.readinessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.readinessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.readinessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.readinessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.readinessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.readinessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.readinessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.readinessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.readinessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.resizePolicy + +"Resources resize policy for the container." + +### fn spec.containers.resizePolicy.withResourceName + +```ts +withResourceName(resourceName) +``` + +"Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + +### fn spec.containers.resizePolicy.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + +## obj spec.containers.resources + +"Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.containers.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.containers.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.containers.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.containers.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.containers.securityContext + +"SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.containers.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.containers.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +## obj spec.containers.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.containers.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.containers.securityContext.capabilities + +"The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.containers.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.containers.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.containers.securityContext.capabilities.withDropMixin + +```ts +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.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.containers.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.containers.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.containers.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.containers.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.containers.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.containers.startupProbe + +"StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.startupProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.startupProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.startupProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.startupProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.startupProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.startupProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.startupProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.startupProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.startupProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.startupProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.startupProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.startupProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.startupProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.startupProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.startupProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.startupProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.startupProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.startupProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.startupProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.startupProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.startupProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName 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 + +```ts +withDevicePath(devicePath) +``` + +"devicePath is the path inside of the container that the device will be mapped to." + +### fn spec.containers.volumeDevices.withName + +```ts +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.\nCannot be updated." + +### fn spec.containers.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.containers.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.containers.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.containers.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.containers.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.containers.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.containers.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.excludedFromEnforcement + +"List of references to PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\nApplies only if enforcedNamespaceLabel set to true." + +### fn spec.excludedFromEnforcement.withGroup + +```ts +withGroup(group) +``` + +"Group of the referent. When not specified, it defaults to `monitoring.coreos.com`" + +### fn spec.excludedFromEnforcement.withName + +```ts +withName(name) +``` + +"Name of the referent. When not set, all resources in the namespace are matched." + +### fn spec.excludedFromEnforcement.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/" + +### fn spec.excludedFromEnforcement.withResource + +```ts +withResource(resource) +``` + +"Resource of the referent." + +## obj spec.grpcServerTlsConfig + +"GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads\nrecorded rule data.\nNote: Currently only the CAFile, CertFile, and KeyFile fields are supported.\nMaps to the '--grpc-server-tls-*' CLI args." + +### fn spec.grpcServerTlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.grpcServerTlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.grpcServerTlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.grpcServerTlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.grpcServerTlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.grpcServerTlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.grpcServerTlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.grpcServerTlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.grpcServerTlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.grpcServerTlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.grpcServerTlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.grpcServerTlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.grpcServerTlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.grpcServerTlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.grpcServerTlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.grpcServerTlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.grpcServerTlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.grpcServerTlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.grpcServerTlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.grpcServerTlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.grpcServerTlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.grpcServerTlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.grpcServerTlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.grpcServerTlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.grpcServerTlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.grpcServerTlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.grpcServerTlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.grpcServerTlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.grpcServerTlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hostAliases + +"Pods' hostAliases configuration" + +### fn spec.hostAliases.withHostnames + +```ts +withHostnames(hostnames) +``` + +"Hostnames for the above IP address." + +### fn spec.hostAliases.withHostnamesMixin + +```ts +withHostnamesMixin(hostnames) +``` + +"Hostnames for the above IP address." + +**Note:** This function appends passed data to existing values + +### fn spec.hostAliases.withIp + +```ts +withIp(ip) +``` + +"IP address of the host file entry." + +## obj spec.imagePullSecrets + +"An optional list of references to secrets in the same namespace\nto use for pulling thanos images from registries\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +### fn spec.imagePullSecrets.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.initContainers + +"InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the ThanosRuler configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that this behaviour may break\nat any time without notice." + +### fn spec.initContainers.withArgs + +```ts +withArgs(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.initContainers.withArgsMixin + +```ts +withArgsMixin(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withCommand(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.initContainers.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.initContainers.withEnvFrom + +```ts +withEnvFrom(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.initContainers.withEnvFromMixin + +```ts +withEnvFromMixin(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withImage + +```ts +withImage(image) +``` + +"Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets." + +### fn spec.initContainers.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + +### fn spec.initContainers.withName + +```ts +withName(name) +``` + +"Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + +### fn spec.initContainers.withPorts + +```ts +withPorts(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.initContainers.withPortsMixin + +```ts +withPortsMixin(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withResizePolicy + +```ts +withResizePolicy(resizePolicy) +``` + +"Resources resize policy for the container." + +### fn spec.initContainers.withResizePolicyMixin + +```ts +withResizePolicyMixin(resizePolicy) +``` + +"Resources resize policy for the container." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted." + +### fn spec.initContainers.withStdin + +```ts +withStdin(stdin) +``` + +"Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false." + +### fn spec.initContainers.withStdinOnce + +```ts +withStdinOnce(stdinOnce) +``` + +"Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false" + +### fn spec.initContainers.withTerminationMessagePath + +```ts +withTerminationMessagePath(terminationMessagePath) +``` + +"Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated." + +### fn spec.initContainers.withTerminationMessagePolicy + +```ts +withTerminationMessagePolicy(terminationMessagePolicy) +``` + +"Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated." + +### fn spec.initContainers.withTty + +```ts +withTty(tty) +``` + +"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false." + +### fn spec.initContainers.withVolumeDevices + +```ts +withVolumeDevices(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.initContainers.withVolumeDevicesMixin + +```ts +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 + +```ts +withVolumeMounts(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +### fn spec.initContainers.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withWorkingDir + +```ts +withWorkingDir(workingDir) +``` + +"Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated." + +## obj spec.initContainers.env + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.initContainers.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.initContainers.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"." + +## obj spec.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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.initContainers.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.env.valueFrom.configMapKeyRef.withOptional + +```ts +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['']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.initContainers.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.initContainers.env.valueFrom.fieldRef.withFieldPath + +```ts +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\n(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 + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.initContainers.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.initContainers.env.valueFrom.resourceFieldRef.withResource + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.initContainers.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.env.valueFrom.secretKeyRef.withOptional + +```ts +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.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.initContainers.envFrom.withPrefix + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.envFrom.configMapRef.withOptional + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.envFrom.secretRef.withOptional + +```ts +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.\nCannot be updated." + +## obj spec.initContainers.lifecycle.postStart + +"PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.initContainers.lifecycle.postStart.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.lifecycle.postStart.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.lifecycle.postStart.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.lifecycle.postStart.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.lifecycle.postStart.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.initContainers.lifecycle.postStart.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.initContainers.lifecycle.postStart.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.initContainers.lifecycle.postStart.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.lifecycle.postStart.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.lifecycle.preStop + +"PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.initContainers.lifecycle.preStop.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.lifecycle.preStop.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.lifecycle.preStop.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.lifecycle.preStop.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.lifecycle.preStop.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.initContainers.lifecycle.preStop.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.initContainers.lifecycle.preStop.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.initContainers.lifecycle.preStop.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.lifecycle.preStop.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.livenessProbe + +"Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.livenessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.livenessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.livenessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.livenessProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.livenessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.livenessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.livenessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.livenessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.livenessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.livenessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.livenessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.livenessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.livenessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.livenessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.livenessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.livenessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.livenessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.livenessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.ports + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.initContainers.ports.withContainerPort + +```ts +withContainerPort(containerPort) +``` + +"Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536." + +### fn spec.initContainers.ports.withHostIP + +```ts +withHostIP(hostIP) +``` + +"What host IP to bind the external port to." + +### fn spec.initContainers.ports.withHostPort + +```ts +withHostPort(hostPort) +``` + +"Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this." + +### fn spec.initContainers.ports.withName + +```ts +withName(name) +``` + +"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services." + +### fn spec.initContainers.ports.withProtocol + +```ts +withProtocol(protocol) +``` + +"Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\"." + +## obj spec.initContainers.readinessProbe + +"Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.readinessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.readinessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.readinessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.readinessProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.readinessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.readinessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.readinessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.readinessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.readinessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.readinessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.readinessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.readinessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.readinessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.readinessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.readinessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.readinessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.readinessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.readinessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.resizePolicy + +"Resources resize policy for the container." + +### fn spec.initContainers.resizePolicy.withResourceName + +```ts +withResourceName(resourceName) +``` + +"Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + +### fn spec.initContainers.resizePolicy.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + +## obj spec.initContainers.resources + +"Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.initContainers.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.initContainers.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.initContainers.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.initContainers.securityContext + +"SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.initContainers.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.initContainers.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +## obj spec.initContainers.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.initContainers.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.initContainers.securityContext.capabilities + +"The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.initContainers.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.initContainers.securityContext.capabilities.withDropMixin + +```ts +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.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.initContainers.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.initContainers.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.initContainers.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.initContainers.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.initContainers.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.initContainers.startupProbe + +"StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.startupProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.startupProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.startupProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.startupProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.startupProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.startupProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.startupProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.startupProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.startupProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.startupProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.startupProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.startupProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.startupProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.startupProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.startupProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.startupProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.startupProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.startupProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName 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 + +```ts +withDevicePath(devicePath) +``` + +"devicePath is the path inside of the container that the device will be mapped to." + +### fn spec.initContainers.volumeDevices.withName + +```ts +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.\nCannot be updated." + +### fn spec.initContainers.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.initContainers.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.initContainers.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.initContainers.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.initContainers.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.initContainers.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.initContainers.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.objectStorageConfig + +"ObjectStorageConfig configures object storage in Thanos.\nAlternative to ObjectStorageConfigFile, and lower order priority." + +### fn spec.objectStorageConfig.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.objectStorageConfig.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.objectStorageConfig.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.podMetadata + +"PodMetadata configures labels and annotations which are propagated to the ThanosRuler pods.\n\n\nThe following items are reserved and cannot be overridden:\n* \"app.kubernetes.io/name\" label, set to \"thanos-ruler\".\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/instance\" label, set to the name of the ThanosRuler instance.\n* \"thanos-ruler\" label, set to the name of the ThanosRuler instance.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"thanos-ruler\"." + +### fn spec.podMetadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +### fn spec.podMetadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn spec.podMetadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +### fn spec.podMetadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn spec.podMetadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + +## obj spec.prometheusRulesExcludedFromEnforce + +"PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing\nof adding namespace labels. Works only if enforcedNamespaceLabel set to true.\nMake sure both ruleNamespace and ruleName are set for each pair\nDeprecated: use excludedFromEnforcement instead." + +### fn spec.prometheusRulesExcludedFromEnforce.withRuleName + +```ts +withRuleName(ruleName) +``` + +"Name of the excluded PrometheusRule object." + +### fn spec.prometheusRulesExcludedFromEnforce.withRuleNamespace + +```ts +withRuleNamespace(ruleNamespace) +``` + +"Namespace of the excluded PrometheusRule object." + +## obj spec.queryConfig + +"Define configuration for connecting to thanos query instances.\nIf this is defined, the QueryEndpoints field will be ignored.\nMaps to the `query.config` CLI argument.\nOnly available with thanos v0.11.0 and higher." + +### fn spec.queryConfig.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.queryConfig.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.queryConfig.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.resources + +"Resources defines the resource requirements for single Pods.\nIf not provided, no requests/limits will be set" + +### fn spec.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.ruleNamespaceSelector + +"Namespaces to be selected for Rules discovery. If unspecified, only\nthe same namespace as the ThanosRuler object is in is used." + +### fn spec.ruleNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.ruleNamespaceSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.ruleNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.ruleNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.ruleNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.ruleNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.ruleNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.ruleNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.ruleSelector + +"A label selector to select which PrometheusRules to mount for alerting and\nrecording." + +### fn spec.ruleSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.ruleSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.ruleSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.ruleSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.ruleSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.ruleSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.ruleSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.ruleSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.securityContext + +"SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext." + +### fn spec.securityContext.withFsGroup + +```ts +withFsGroup(fsGroup) +``` + +"A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withFsGroupChangePolicy + +```ts +withFsGroupChangePolicy(fsGroupChangePolicy) +``` + +"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSupplementalGroups + +```ts +withSupplementalGroups(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSupplementalGroupsMixin + +```ts +withSupplementalGroupsMixin(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +### fn spec.securityContext.withSysctls + +```ts +withSysctls(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSysctlsMixin + +```ts +withSysctlsMixin(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +## obj spec.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.securityContext.seLinuxOptions + +"The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.securityContext.seccompProfile + +"The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.securityContext.sysctls + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.sysctls.withName + +```ts +withName(name) +``` + +"Name of a property to set" + +### fn spec.securityContext.sysctls.withValue + +```ts +withValue(value) +``` + +"Value of a property to set" + +## obj spec.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.storage + +"Storage spec to specify how storage shall be used." + +### fn spec.storage.withDisableMountSubPath + +```ts +withDisableMountSubPath(disableMountSubPath) +``` + +"Deprecated: subPath usage will be removed in a future release." + +## obj spec.storage.emptyDir + +"EmptyDirVolumeSource to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir" + +### fn spec.storage.emptyDir.withMedium + +```ts +withMedium(medium) +``` + +"medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.storage.emptyDir.withSizeLimit + +```ts +withSizeLimit(sizeLimit) +``` + +"sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +## obj spec.storage.ephemeral + +"EphemeralVolumeSource to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes" + +## obj spec.storage.ephemeral.volumeClaimTemplate + +"Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\n\nRequired, must not be nil." + +### fn spec.storage.ephemeral.volumeClaimTemplate.withMetadata + +```ts +withMetadata(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +### fn spec.storage.ephemeral.volumeClaimTemplate.withMetadataMixin + +```ts +withMetadataMixin(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec + +"The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate + +"Defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes." + +### fn spec.storage.volumeClaimTemplate.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources" + +### fn spec.storage.volumeClaimTemplate.withKind + +```ts +withKind(kind) +``` + +"Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + +## obj spec.storage.volumeClaimTemplate.metadata + +"EmbeddedMetadata contains metadata relevant to an EmbeddedResource." + +### fn spec.storage.volumeClaimTemplate.metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +### fn spec.storage.volumeClaimTemplate.metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +### fn spec.storage.volumeClaimTemplate.metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + +## obj spec.storage.volumeClaimTemplate.spec + +"Defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.storage.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.storage.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.storage.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.storage.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.storage.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.tolerations + +"If specified, the pod's tolerations." + +### fn spec.tolerations.withEffect + +```ts +withEffect(effect) +``` + +"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute." + +### fn spec.tolerations.withKey + +```ts +withKey(key) +``` + +"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys." + +### fn spec.tolerations.withOperator + +```ts +withOperator(operator) +``` + +"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category." + +### fn spec.tolerations.withTolerationSeconds + +```ts +withTolerationSeconds(tolerationSeconds) +``` + +"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system." + +### fn spec.tolerations.withValue + +```ts +withValue(value) +``` + +"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string." + +## obj spec.topologySpreadConstraints + +"If specified, the pod's topology spread constraints." + +### fn spec.topologySpreadConstraints.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default)." + +### fn spec.topologySpreadConstraints.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default)." + +**Note:** This function appends passed data to existing values + +### fn spec.topologySpreadConstraints.withMaxSkew + +```ts +withMaxSkew(maxSkew) +``` + +"MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n| zone1 | zone2 | zone3 |\n| P P | P P | P |\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed." + +### fn spec.topologySpreadConstraints.withMinDomains + +```ts +withMinDomains(minDomains) +``` + +"MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n| zone1 | zone2 | zone3 |\n| P P | P P | P P |\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew." + +### fn spec.topologySpreadConstraints.withNodeAffinityPolicy + +```ts +withNodeAffinityPolicy(nodeAffinityPolicy) +``` + +"NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\nwhen calculating pod topology spread skew. Options are:\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\n\nIf this value is nil, the behavior is equivalent to the Honor policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag." + +### fn spec.topologySpreadConstraints.withNodeTaintsPolicy + +```ts +withNodeTaintsPolicy(nodeTaintsPolicy) +``` + +"NodeTaintsPolicy indicates how we will treat node taints when calculating\npod topology spread skew. Options are:\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\nhas a toleration, are included.\n- Ignore: node taints are ignored. All nodes are included.\n\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag." + +### fn spec.topologySpreadConstraints.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field." + +### fn spec.topologySpreadConstraints.withWhenUnsatisfiable + +```ts +withWhenUnsatisfiable(whenUnsatisfiable) +``` + +"WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it.\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod\nif and only if every possible node assignment for that pod would violate\n\"MaxSkew\" on some topology.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n| zone1 | zone2 | zone3 |\n| P P P | P | P |\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field." + +## obj spec.topologySpreadConstraints.labelSelector + +"LabelSelector is used to find matching pods.\nPods that match this label selector are counted to determine the number of pods\nin their corresponding topology domain." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.topologySpreadConstraints.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.tracingConfig + +"TracingConfig configures tracing in Thanos.\n\n\n`tracingConfigFile` takes precedence over this field.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.tracingConfig.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tracingConfig.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.volumeMounts + +"VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the ruler container,\nthat are generated as a result of StorageSpec objects." + +### fn spec.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.volumes + +"Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will\nbe appended to other volumes that are generated as a result of StorageSpec objects." + +### fn spec.volumes.withName + +```ts +withName(name) +``` + +"name of the volume.\nMust be a DNS_LABEL and unique within the pod.\nMore 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\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.volumes.awsElasticBlockStore.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.awsElasticBlockStore.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)." + +### fn spec.volumes.awsElasticBlockStore.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly value true will force the readOnly setting in VolumeMounts.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.volumes.awsElasticBlockStore.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore 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 + +```ts +withCachingMode(cachingMode) +``` + +"cachingMode is the Host Caching mode: None, Read Only, Read Write." + +### fn spec.volumes.azureDisk.withDiskName + +```ts +withDiskName(diskName) +``` + +"diskName is the Name of the data disk in the blob storage" + +### fn spec.volumes.azureDisk.withDiskURI + +```ts +withDiskURI(diskURI) +``` + +"diskURI is the URI of data disk in the blob storage" + +### fn spec.volumes.azureDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.azureDisk.withKind + +```ts +withKind(kind) +``` + +"kind expected values are 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 + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force\nthe 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 + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.azureFile.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of secret that contains Azure Storage Account Name and Key" + +### fn spec.volumes.azureFile.withShareName + +```ts +withShareName(shareName) +``` + +"shareName is the azure 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 + +```ts +withMonitors(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors\nMore 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 + +```ts +withPath(path) +``` + +"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /" + +### fn spec.volumes.cephfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withSecretFile + +```ts +withSecretFile(secretFile) +``` + +"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withUser + +```ts +withUser(user) +``` + +"user is optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +## obj spec.volumes.cephfs.secretRef + +"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.cinder + +"cinder represents a cinder volume attached and mounted on kubelets host machine.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +## obj spec.volumes.cinder.secretRef + +"secretRef is optional: points to a secret object containing parameters used to connect\nto OpenStack." + +### fn spec.volumes.cinder.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.configMap + +"configMap represents a configMap that should populate this volume" + +### fn spec.volumes.configMap.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.volumes.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.csi + +"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)." + +### fn spec.volumes.csi.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster." + +### fn spec.volumes.csi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply." + +### fn spec.volumes.csi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write)." + +### fn spec.volumes.csi.withVolumeAttributes + +```ts +withVolumeAttributes(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values." + +### fn spec.volumes.csi.withVolumeAttributesMixin + +```ts +withVolumeAttributesMixin(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. 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\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed." + +### fn spec.volumes.csi.nodePublishSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.downwardAPI + +"downwardAPI represents downward API about the pod that should populate this volume" + +### fn spec.volumes.downwardAPI.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of downward API volume file" + +### fn spec.volumes.downwardAPI.withItemsMixin + +```ts +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 + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.downwardAPI.items.withPath + +```ts +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, namespace and uid are supported." + +### fn spec.volumes.downwardAPI.items.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.volumes.downwardAPI.items.fieldRef.withFieldPath + +```ts +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\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.volumes.emptyDir + +"emptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.volumes.emptyDir.withMedium + +```ts +withMedium(medium) +``` + +"medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.volumes.emptyDir.withSizeLimit + +```ts +withSizeLimit(sizeLimit) +``` + +"sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +## obj spec.volumes.ephemeral + +"ephemeral represents a volume that is handled by a cluster storage driver.\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\nand deleted when the pod is removed.\n\n\nUse this if:\na) the volume is only needed while the pod runs,\nb) features of normal volumes like restoring from snapshot or capacity\n tracking are needed,\nc) the storage driver is specified through a storage class, and\nd) the storage driver supports dynamic volume provisioning through\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\n information on the connection between this volume type\n and PersistentVolumeClaim).\n\n\nUse PersistentVolumeClaim or one of the vendor-specific\nAPIs for volumes that persist for longer than the lifecycle\nof an individual pod.\n\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\nbe used that way - see the documentation of the driver for\nmore information.\n\n\nA pod can use both types of ephemeral volumes and\npersistent volumes at the same time." + +## obj spec.volumes.ephemeral.volumeClaimTemplate + +"Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\n\nRequired, must not be nil." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.withMetadata + +```ts +withMetadata(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.withMetadataMixin + +```ts +withMetadataMixin(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec + +"The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.fc.withLun + +```ts +withLun(lun) +``` + +"lun is Optional: FC target lun number" + +### fn spec.volumes.fc.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.fc.withTargetWWNs + +```ts +withTargetWWNs(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +### fn spec.volumes.fc.withTargetWWNsMixin + +```ts +withTargetWWNsMixin(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.fc.withWwids + +```ts +withWwids(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously." + +### fn spec.volumes.fc.withWwidsMixin + +```ts +withWwidsMixin(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids)\nEither 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\nprovisioned/attached using an exec based plugin." + +### fn spec.volumes.flexVolume.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the driver to use for this volume." + +### fn spec.volumes.flexVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script." + +### fn spec.volumes.flexVolume.withOptions + +```ts +withOptions(options) +``` + +"options is Optional: this field holds extra command options if any." + +### fn spec.volumes.flexVolume.withOptionsMixin + +```ts +withOptionsMixin(options) +``` + +"options is Optional: this field holds extra command options if any." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.flexVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +## obj spec.volumes.flexVolume.secretRef + +"secretRef is Optional: secretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts." + +### fn spec.volumes.flexVolume.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.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 + +```ts +withDatasetName(datasetName) +``` + +"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\nshould be considered as deprecated" + +### fn spec.volumes.flocker.withDatasetUUID + +```ts +withDatasetUUID(datasetUUID) +``` + +"datasetUUID is the 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\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.gcePersistentDisk.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withPdName + +```ts +withPdName(pdName) +``` + +"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +## obj spec.volumes.gitRepo + +"gitRepo represents a git repository at a particular revision.\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container." + +### fn spec.volumes.gitRepo.withDirectory + +```ts +withDirectory(directory) +``` + +"directory is the target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name." + +### fn spec.volumes.gitRepo.withRepository + +```ts +withRepository(repository) +``` + +"repository is the URL" + +### fn spec.volumes.gitRepo.withRevision + +```ts +withRevision(revision) +``` + +"revision is the commit hash for the specified revision." + +## obj spec.volumes.glusterfs + +"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md" + +### fn spec.volumes.glusterfs.withEndpoints + +```ts +withEndpoints(endpoints) +``` + +"endpoints is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.volumes.glusterfs.withPath + +```ts +withPath(path) +``` + +"path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.volumes.glusterfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore 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\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n---\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\nmount host directories as read/write." + +### fn spec.volumes.hostPath.withPath + +```ts +withPath(path) +``` + +"path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +### fn spec.volumes.hostPath.withType + +```ts +withType(type) +``` + +"type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +## obj spec.volumes.iscsi + +"iscsi represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://examples.k8s.io/volumes/iscsi/README.md" + +### fn spec.volumes.iscsi.withChapAuthDiscovery + +```ts +withChapAuthDiscovery(chapAuthDiscovery) +``` + +"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication" + +### fn spec.volumes.iscsi.withChapAuthSession + +```ts +withChapAuthSession(chapAuthSession) +``` + +"chapAuthSession defines whether support iSCSI Session CHAP authentication" + +### fn spec.volumes.iscsi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.iscsi.withInitiatorName + +```ts +withInitiatorName(initiatorName) +``` + +"initiatorName is the custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n: will be created for the connection." + +### fn spec.volumes.iscsi.withIqn + +```ts +withIqn(iqn) +``` + +"iqn is the target iSCSI Qualified Name." + +### fn spec.volumes.iscsi.withIscsiInterface + +```ts +withIscsiInterface(iscsiInterface) +``` + +"iscsiInterface is the interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp)." + +### fn spec.volumes.iscsi.withLun + +```ts +withLun(lun) +``` + +"lun represents iSCSI Target Lun number." + +### fn spec.volumes.iscsi.withPortals + +```ts +withPortals(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +### fn spec.volumes.iscsi.withPortalsMixin + +```ts +withPortalsMixin(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.iscsi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false." + +### fn spec.volumes.iscsi.withTargetPortal + +```ts +withTargetPortal(targetPortal) +``` + +"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +## obj spec.volumes.iscsi.secretRef + +"secretRef is the CHAP Secret for iSCSI target and initiator authentication" + +### fn spec.volumes.iscsi.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.nfs + +"nfs represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withPath + +```ts +withPath(path) +``` + +"path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withServer + +```ts +withServer(server) +``` + +"server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +## obj spec.volumes.persistentVolumeClaim + +"persistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.volumes.persistentVolumeClaim.withClaimName + +```ts +withClaimName(claimName) +``` + +"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.volumes.persistentVolumeClaim.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Will force the ReadOnly setting in VolumeMounts.\nDefault false." + +## obj spec.volumes.photonPersistentDisk + +"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine" + +### fn spec.volumes.photonPersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.photonPersistentDisk.withPdID + +```ts +withPdID(pdID) +``` + +"pdID is the 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 + +```ts +withFsType(fsType) +``` + +"fSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.portworxVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.portworxVolume.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID uniquely identifies a Portworx volume" + +## obj spec.volumes.projected + +"projected items for all in one resources secrets, configmaps, and downward API" + +### fn spec.volumes.projected.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode are the mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.withSources + +```ts +withSources(sources) +``` + +"sources is the list of volume projections" + +### fn spec.volumes.projected.withSourcesMixin + +```ts +withSourcesMixin(sources) +``` + +"sources is the list of volume projections" + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources + +"sources is the list of volume projections" + +## obj spec.volumes.projected.sources.clusterTrustBundle + +"ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\nof ClusterTrustBundle objects in an auto-updating file.\n\n\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\n\n\nClusterTrustBundle objects can either be selected by name, or by the\ncombination of signer name and a label selector.\n\n\nKubelet performs aggressive normalization of the PEM contents written\ninto the pod filesystem. Esoteric PEM features such as inter-block\ncomments and block headers are stripped. Certificates are deduplicated.\nThe ordering of certificates within the file is arbitrary, and Kubelet\nmay change the order over time." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withName + +```ts +withName(name) +``` + +"Select a single ClusterTrustBundle by object name. Mutually-exclusive\nwith signerName and labelSelector." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withOptional + +```ts +withOptional(optional) +``` + +"If true, don't block pod startup if the referenced ClusterTrustBundle(s)\naren't available. If using name, then the named ClusterTrustBundle is\nallowed not to exist. If using signerName, then the combination of\nsignerName and labelSelector is allowed to match zero\nClusterTrustBundles." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withPath + +```ts +withPath(path) +``` + +"Relative path from the volume root to write the bundle." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withSignerName + +```ts +withSignerName(signerName) +``` + +"Select all ClusterTrustBundles that match this signer name.\nMutually-exclusive with name. The contents of all selected\nClusterTrustBundles will be unified and deduplicated." + +## obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector + +"Select all ClusterTrustBundles that match this label selector. Only has\neffect if signerName is set. Mutually-exclusive with name. If unset,\ninterpreted as \"match nothing\". If set but empty, interpreted as \"match\neverything\"." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchExpressionsMixin + +```ts +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.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources.configMap + +"configMap information about the configMap data to project" + +### fn spec.volumes.projected.sources.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative 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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.projected.sources.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.volumes.projected.sources.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.projected.sources.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.projected.sources.downwardAPI + +"downwardAPI information about the downwardAPI data to project" + +### fn spec.volumes.projected.sources.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of DownwardAPIVolume file" + +### fn spec.volumes.projected.sources.downwardAPI.withItemsMixin + +```ts +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 + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.downwardAPI.items.withPath + +```ts +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, namespace and uid are supported." + +### fn spec.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion + +```ts +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 + +```ts +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\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.volumes.projected.sources.secret + +"secret information about the secret data to project" + +### fn spec.volumes.projected.sources.secret.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative 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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.projected.sources.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its key must be defined" + +## obj spec.volumes.projected.sources.secret.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.projected.sources.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.projected.sources.serviceAccountToken + +"serviceAccountToken is information about the serviceAccountToken data to project" + +### fn spec.volumes.projected.sources.serviceAccountToken.withAudience + +```ts +withAudience(audience) +``` + +"audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver." + +### fn spec.volumes.projected.sources.serviceAccountToken.withExpirationSeconds + +```ts +withExpirationSeconds(expirationSeconds) +``` + +"expirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes." + +### fn spec.volumes.projected.sources.serviceAccountToken.withPath + +```ts +withPath(path) +``` + +"path is the path relative to the mount point of the file to project the\ntoken into." + +## obj spec.volumes.quobyte + +"quobyte represents a Quobyte mount on the host that shares a pod's lifetime" + +### fn spec.volumes.quobyte.withGroup + +```ts +withGroup(group) +``` + +"group to map volume access to\nDefault is no group" + +### fn spec.volumes.quobyte.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false." + +### fn spec.volumes.quobyte.withRegistry + +```ts +withRegistry(registry) +``` + +"registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes" + +### fn spec.volumes.quobyte.withTenant + +```ts +withTenant(tenant) +``` + +"tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin" + +### fn spec.volumes.quobyte.withUser + +```ts +withUser(user) +``` + +"user to map volume access to\nDefaults to serivceaccount user" + +### fn spec.volumes.quobyte.withVolume + +```ts +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.\nMore info: https://examples.k8s.io/volumes/rbd/README.md" + +### fn spec.volumes.rbd.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.rbd.withImage + +```ts +withImage(image) +``` + +"image is the rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withKeyring + +```ts +withKeyring(keyring) +``` + +"keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withMonitors + +```ts +withMonitors(monitors) +``` + +"monitors is a collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is a collection of Ceph monitors.\nMore 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 + +```ts +withPool(pool) +``` + +"pool is the rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withUser + +```ts +withUser(user) +``` + +"user is the rados user name.\nDefault is admin.\nMore 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\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.scaleIO + +"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes." + +### fn spec.volumes.scaleIO.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\"." + +### fn spec.volumes.scaleIO.withGateway + +```ts +withGateway(gateway) +``` + +"gateway is the host address of the ScaleIO API Gateway." + +### fn spec.volumes.scaleIO.withProtectionDomain + +```ts +withProtectionDomain(protectionDomain) +``` + +"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage." + +### fn spec.volumes.scaleIO.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.scaleIO.withSslEnabled + +```ts +withSslEnabled(sslEnabled) +``` + +"sslEnabled Flag enable/disable SSL communication with Gateway, default false" + +### fn spec.volumes.scaleIO.withStorageMode + +```ts +withStorageMode(storageMode) +``` + +"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned." + +### fn spec.volumes.scaleIO.withStoragePool + +```ts +withStoragePool(storagePool) +``` + +"storagePool is the ScaleIO Storage Pool associated with the protection domain." + +### fn spec.volumes.scaleIO.withSystem + +```ts +withSystem(system) +``` + +"system is the name of the storage system as configured in ScaleIO." + +### fn spec.volumes.scaleIO.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the name of a volume already created in the ScaleIO system\nthat is associated with this volume source." + +## obj spec.volumes.scaleIO.secretRef + +"secretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail." + +### fn spec.volumes.scaleIO.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.secret + +"secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +### fn spec.volumes.secret.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.secret.withItems + +```ts +withItems(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its keys must be defined" + +### fn spec.volumes.secret.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +## obj spec.volumes.secret.items + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay 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 + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.storageos.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.storageos.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace." + +### fn spec.volumes.storageos.withVolumeNamespace + +```ts +withVolumeNamespace(volumeNamespace) +``` + +"volumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces 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\ncredentials. If not specified, default values will be attempted." + +### fn spec.volumes.storageos.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.vsphereVolume + +"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine" + +### fn spec.volumes.vsphereVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.vsphereVolume.withStoragePolicyID + +```ts +withStoragePolicyID(storagePolicyID) +``` + +"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName." + +### fn spec.volumes.vsphereVolume.withStoragePolicyName + +```ts +withStoragePolicyName(storagePolicyName) +``` + +"storagePolicyName is the storage Policy Based Management (SPBM) profile name." + +### fn spec.volumes.vsphereVolume.withVolumePath + +```ts +withVolumePath(volumePath) +``` + +"volumePath is the path that identifies vSphere volume vmdk" + +## obj spec.web + +"Defines the configuration of the ThanosRuler web server." + +## obj spec.web.httpConfig + +"Defines HTTP parameters for web server." + +### fn spec.web.httpConfig.withHttp2 + +```ts +withHttp2(http2) +``` + +"Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered." + +## obj spec.web.httpConfig.headers + +"List of headers that can be added to HTTP responses." + +### fn spec.web.httpConfig.headers.withContentSecurityPolicy + +```ts +withContentSecurityPolicy(contentSecurityPolicy) +``` + +"Set the Content-Security-Policy header to HTTP responses.\nUnset if blank." + +### fn spec.web.httpConfig.headers.withStrictTransportSecurity + +```ts +withStrictTransportSecurity(strictTransportSecurity) +``` + +"Set the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security" + +### fn spec.web.httpConfig.headers.withXContentTypeOptions + +```ts +withXContentTypeOptions(xContentTypeOptions) +``` + +"Set the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options" + +### fn spec.web.httpConfig.headers.withXFrameOptions + +```ts +withXFrameOptions(xFrameOptions) +``` + +"Set the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options" + +### fn spec.web.httpConfig.headers.withXXSSProtection + +```ts +withXXSSProtection(xXSSProtection) +``` + +"Set the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection" + +## obj spec.web.tlsConfig + +"Defines the TLS parameters for HTTPS." + +### fn spec.web.tlsConfig.withCipherSuites + +```ts +withCipherSuites(cipherSuites) +``` + +"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\nGo default cipher suites are used. Available cipher suites are documented\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants" + +### fn spec.web.tlsConfig.withCipherSuitesMixin + +```ts +withCipherSuitesMixin(cipherSuites) +``` + +"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\nGo default cipher suites are used. Available cipher suites are documented\nin 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 + +```ts +withClientAuthType(clientAuthType) +``` + +"Server policy for client authentication. Maps to ClientAuth Policies.\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType" + +### fn spec.web.tlsConfig.withCurvePreferences + +```ts +withCurvePreferences(curvePreferences) +``` + +"Elliptic curves that will be used in an ECDHE handshake, in preference\norder. Available curves are documented in the go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID" + +### fn spec.web.tlsConfig.withCurvePreferencesMixin + +```ts +withCurvePreferencesMixin(curvePreferences) +``` + +"Elliptic curves that will be used in an ECDHE handshake, in preference\norder. Available curves are documented in the go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID" + +**Note:** This function appends passed data to existing values + +### fn spec.web.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum TLS version that is acceptable. Defaults to TLS13." + +### fn spec.web.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum TLS version that is acceptable. Defaults to TLS12." + +### fn spec.web.tlsConfig.withPreferServerCipherSuites + +```ts +withPreferServerCipherSuites(preferServerCipherSuites) +``` + +"Controls whether the server selects the\nclient's most preferred cipher suite, or the server's most preferred\ncipher suite. If true then the server's preference, as expressed in\nthe 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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.web.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.web.tlsConfig.client_ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.client_ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.client_ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.client_ca.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" \ No newline at end of file diff --git a/docs/0.14/monitoring/v1alpha1/alertmanagerConfig.md b/docs/0.14/monitoring/v1alpha1/alertmanagerConfig.md new file mode 100644 index 0000000..0cc4585 --- /dev/null +++ b/docs/0.14/monitoring/v1alpha1/alertmanagerConfig.md @@ -0,0 +1,12909 @@ +--- +permalink: /0.14/monitoring/v1alpha1/alertmanagerConfig/ +--- + +# monitoring.v1alpha1.alertmanagerConfig + +"AlertmanagerConfig configures the Prometheus Alertmanager,\nspecifying how alerts should be grouped, inhibited and notified to external systems." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withInhibitRules(inhibitRules)`](#fn-specwithinhibitrules) + * [`fn withInhibitRulesMixin(inhibitRules)`](#fn-specwithinhibitrulesmixin) + * [`fn withMuteTimeIntervals(muteTimeIntervals)`](#fn-specwithmutetimeintervals) + * [`fn withMuteTimeIntervalsMixin(muteTimeIntervals)`](#fn-specwithmutetimeintervalsmixin) + * [`fn withReceivers(receivers)`](#fn-specwithreceivers) + * [`fn withReceiversMixin(receivers)`](#fn-specwithreceiversmixin) + * [`obj spec.inhibitRules`](#obj-specinhibitrules) + * [`fn withEqual(equal)`](#fn-specinhibitruleswithequal) + * [`fn withEqualMixin(equal)`](#fn-specinhibitruleswithequalmixin) + * [`fn withSourceMatch(sourceMatch)`](#fn-specinhibitruleswithsourcematch) + * [`fn withSourceMatchMixin(sourceMatch)`](#fn-specinhibitruleswithsourcematchmixin) + * [`fn withTargetMatch(targetMatch)`](#fn-specinhibitruleswithtargetmatch) + * [`fn withTargetMatchMixin(targetMatch)`](#fn-specinhibitruleswithtargetmatchmixin) + * [`obj spec.inhibitRules.sourceMatch`](#obj-specinhibitrulessourcematch) + * [`fn withMatchType(matchType)`](#fn-specinhibitrulessourcematchwithmatchtype) + * [`fn withName(name)`](#fn-specinhibitrulessourcematchwithname) + * [`fn withRegex(regex)`](#fn-specinhibitrulessourcematchwithregex) + * [`fn withValue(value)`](#fn-specinhibitrulessourcematchwithvalue) + * [`obj spec.inhibitRules.targetMatch`](#obj-specinhibitrulestargetmatch) + * [`fn withMatchType(matchType)`](#fn-specinhibitrulestargetmatchwithmatchtype) + * [`fn withName(name)`](#fn-specinhibitrulestargetmatchwithname) + * [`fn withRegex(regex)`](#fn-specinhibitrulestargetmatchwithregex) + * [`fn withValue(value)`](#fn-specinhibitrulestargetmatchwithvalue) + * [`obj spec.muteTimeIntervals`](#obj-specmutetimeintervals) + * [`fn withName(name)`](#fn-specmutetimeintervalswithname) + * [`fn withTimeIntervals(timeIntervals)`](#fn-specmutetimeintervalswithtimeintervals) + * [`fn withTimeIntervalsMixin(timeIntervals)`](#fn-specmutetimeintervalswithtimeintervalsmixin) + * [`obj spec.muteTimeIntervals.timeIntervals`](#obj-specmutetimeintervalstimeintervals) + * [`fn withDaysOfMonth(daysOfMonth)`](#fn-specmutetimeintervalstimeintervalswithdaysofmonth) + * [`fn withDaysOfMonthMixin(daysOfMonth)`](#fn-specmutetimeintervalstimeintervalswithdaysofmonthmixin) + * [`fn withMonths(months)`](#fn-specmutetimeintervalstimeintervalswithmonths) + * [`fn withMonthsMixin(months)`](#fn-specmutetimeintervalstimeintervalswithmonthsmixin) + * [`fn withTimes(times)`](#fn-specmutetimeintervalstimeintervalswithtimes) + * [`fn withTimesMixin(times)`](#fn-specmutetimeintervalstimeintervalswithtimesmixin) + * [`fn withWeekdays(weekdays)`](#fn-specmutetimeintervalstimeintervalswithweekdays) + * [`fn withWeekdaysMixin(weekdays)`](#fn-specmutetimeintervalstimeintervalswithweekdaysmixin) + * [`fn withYears(years)`](#fn-specmutetimeintervalstimeintervalswithyears) + * [`fn withYearsMixin(years)`](#fn-specmutetimeintervalstimeintervalswithyearsmixin) + * [`obj spec.muteTimeIntervals.timeIntervals.daysOfMonth`](#obj-specmutetimeintervalstimeintervalsdaysofmonth) + * [`fn withEnd(end)`](#fn-specmutetimeintervalstimeintervalsdaysofmonthwithend) + * [`fn withStart(start)`](#fn-specmutetimeintervalstimeintervalsdaysofmonthwithstart) + * [`obj spec.muteTimeIntervals.timeIntervals.times`](#obj-specmutetimeintervalstimeintervalstimes) + * [`fn withEndTime(endTime)`](#fn-specmutetimeintervalstimeintervalstimeswithendtime) + * [`fn withStartTime(startTime)`](#fn-specmutetimeintervalstimeintervalstimeswithstarttime) + * [`obj spec.receivers`](#obj-specreceivers) + * [`fn withDiscordConfigs(discordConfigs)`](#fn-specreceiverswithdiscordconfigs) + * [`fn withDiscordConfigsMixin(discordConfigs)`](#fn-specreceiverswithdiscordconfigsmixin) + * [`fn withEmailConfigs(emailConfigs)`](#fn-specreceiverswithemailconfigs) + * [`fn withEmailConfigsMixin(emailConfigs)`](#fn-specreceiverswithemailconfigsmixin) + * [`fn withMsteamsConfigs(msteamsConfigs)`](#fn-specreceiverswithmsteamsconfigs) + * [`fn withMsteamsConfigsMixin(msteamsConfigs)`](#fn-specreceiverswithmsteamsconfigsmixin) + * [`fn withName(name)`](#fn-specreceiverswithname) + * [`fn withOpsgenieConfigs(opsgenieConfigs)`](#fn-specreceiverswithopsgenieconfigs) + * [`fn withOpsgenieConfigsMixin(opsgenieConfigs)`](#fn-specreceiverswithopsgenieconfigsmixin) + * [`fn withPagerdutyConfigs(pagerdutyConfigs)`](#fn-specreceiverswithpagerdutyconfigs) + * [`fn withPagerdutyConfigsMixin(pagerdutyConfigs)`](#fn-specreceiverswithpagerdutyconfigsmixin) + * [`fn withPushoverConfigs(pushoverConfigs)`](#fn-specreceiverswithpushoverconfigs) + * [`fn withPushoverConfigsMixin(pushoverConfigs)`](#fn-specreceiverswithpushoverconfigsmixin) + * [`fn withSlackConfigs(slackConfigs)`](#fn-specreceiverswithslackconfigs) + * [`fn withSlackConfigsMixin(slackConfigs)`](#fn-specreceiverswithslackconfigsmixin) + * [`fn withSnsConfigs(snsConfigs)`](#fn-specreceiverswithsnsconfigs) + * [`fn withSnsConfigsMixin(snsConfigs)`](#fn-specreceiverswithsnsconfigsmixin) + * [`fn withTelegramConfigs(telegramConfigs)`](#fn-specreceiverswithtelegramconfigs) + * [`fn withTelegramConfigsMixin(telegramConfigs)`](#fn-specreceiverswithtelegramconfigsmixin) + * [`fn withVictoropsConfigs(victoropsConfigs)`](#fn-specreceiverswithvictoropsconfigs) + * [`fn withVictoropsConfigsMixin(victoropsConfigs)`](#fn-specreceiverswithvictoropsconfigsmixin) + * [`fn withWebexConfigs(webexConfigs)`](#fn-specreceiverswithwebexconfigs) + * [`fn withWebexConfigsMixin(webexConfigs)`](#fn-specreceiverswithwebexconfigsmixin) + * [`fn withWebhookConfigs(webhookConfigs)`](#fn-specreceiverswithwebhookconfigs) + * [`fn withWebhookConfigsMixin(webhookConfigs)`](#fn-specreceiverswithwebhookconfigsmixin) + * [`fn withWechatConfigs(wechatConfigs)`](#fn-specreceiverswithwechatconfigs) + * [`fn withWechatConfigsMixin(wechatConfigs)`](#fn-specreceiverswithwechatconfigsmixin) + * [`obj spec.receivers.discordConfigs`](#obj-specreceiversdiscordconfigs) + * [`fn withMessage(message)`](#fn-specreceiversdiscordconfigswithmessage) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiversdiscordconfigswithsendresolved) + * [`fn withTitle(title)`](#fn-specreceiversdiscordconfigswithtitle) + * [`obj spec.receivers.discordConfigs.apiURL`](#obj-specreceiversdiscordconfigsapiurl) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigsapiurlwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigsapiurlwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigsapiurlwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig`](#obj-specreceiversdiscordconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiversdiscordconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiversdiscordconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.discordConfigs.httpConfig.authorization`](#obj-specreceiversdiscordconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiversdiscordconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.discordConfigs.httpConfig.authorization.credentials`](#obj-specreceiversdiscordconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.basicAuth`](#obj-specreceiversdiscordconfigshttpconfigbasicauth) + * [`obj spec.receivers.discordConfigs.httpConfig.basicAuth.password`](#obj-specreceiversdiscordconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.basicAuth.username`](#obj-specreceiversdiscordconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiversdiscordconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2`](#obj-specreceiversdiscordconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiversdiscordconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.clientId`](#obj-specreceiversdiscordconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiversdiscordconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiversdiscordconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiversdiscordconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiversdiscordconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiversdiscordconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiversdiscordconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.tlsConfig`](#obj-specreceiversdiscordconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.discordConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiversdiscordconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiversdiscordconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiversdiscordconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiversdiscordconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiversdiscordconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiversdiscordconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiversdiscordconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversdiscordconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.emailConfigs`](#obj-specreceiversemailconfigs) + * [`fn withAuthIdentity(authIdentity)`](#fn-specreceiversemailconfigswithauthidentity) + * [`fn withAuthUsername(authUsername)`](#fn-specreceiversemailconfigswithauthusername) + * [`fn withFrom(from)`](#fn-specreceiversemailconfigswithfrom) + * [`fn withHeaders(headers)`](#fn-specreceiversemailconfigswithheaders) + * [`fn withHeadersMixin(headers)`](#fn-specreceiversemailconfigswithheadersmixin) + * [`fn withHello(hello)`](#fn-specreceiversemailconfigswithhello) + * [`fn withHtml(html)`](#fn-specreceiversemailconfigswithhtml) + * [`fn withRequireTLS(requireTLS)`](#fn-specreceiversemailconfigswithrequiretls) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiversemailconfigswithsendresolved) + * [`fn withSmarthost(smarthost)`](#fn-specreceiversemailconfigswithsmarthost) + * [`fn withText(text)`](#fn-specreceiversemailconfigswithtext) + * [`fn withTo(to)`](#fn-specreceiversemailconfigswithto) + * [`obj spec.receivers.emailConfigs.authPassword`](#obj-specreceiversemailconfigsauthpassword) + * [`fn withKey(key)`](#fn-specreceiversemailconfigsauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiversemailconfigsauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiversemailconfigsauthpasswordwithoptional) + * [`obj spec.receivers.emailConfigs.authSecret`](#obj-specreceiversemailconfigsauthsecret) + * [`fn withKey(key)`](#fn-specreceiversemailconfigsauthsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversemailconfigsauthsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversemailconfigsauthsecretwithoptional) + * [`obj spec.receivers.emailConfigs.headers`](#obj-specreceiversemailconfigsheaders) + * [`fn withKey(key)`](#fn-specreceiversemailconfigsheaderswithkey) + * [`fn withValue(value)`](#fn-specreceiversemailconfigsheaderswithvalue) + * [`obj spec.receivers.emailConfigs.tlsConfig`](#obj-specreceiversemailconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversemailconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversemailconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversemailconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversemailconfigstlsconfigwithservername) + * [`obj spec.receivers.emailConfigs.tlsConfig.ca`](#obj-specreceiversemailconfigstlsconfigca) + * [`obj spec.receivers.emailConfigs.tlsConfig.ca.configMap`](#obj-specreceiversemailconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversemailconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversemailconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversemailconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.emailConfigs.tlsConfig.ca.secret`](#obj-specreceiversemailconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversemailconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversemailconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversemailconfigstlsconfigcasecretwithoptional) + * [`obj spec.receivers.emailConfigs.tlsConfig.cert`](#obj-specreceiversemailconfigstlsconfigcert) + * [`obj spec.receivers.emailConfigs.tlsConfig.cert.configMap`](#obj-specreceiversemailconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversemailconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversemailconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversemailconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.emailConfigs.tlsConfig.cert.secret`](#obj-specreceiversemailconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversemailconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversemailconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversemailconfigstlsconfigcertsecretwithoptional) + * [`obj spec.receivers.emailConfigs.tlsConfig.keySecret`](#obj-specreceiversemailconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversemailconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversemailconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversemailconfigstlsconfigkeysecretwithoptional) + * [`obj spec.receivers.msteamsConfigs`](#obj-specreceiversmsteamsconfigs) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiversmsteamsconfigswithsendresolved) + * [`fn withSummary(summary)`](#fn-specreceiversmsteamsconfigswithsummary) + * [`fn withText(text)`](#fn-specreceiversmsteamsconfigswithtext) + * [`fn withTitle(title)`](#fn-specreceiversmsteamsconfigswithtitle) + * [`obj spec.receivers.msteamsConfigs.httpConfig`](#obj-specreceiversmsteamsconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiversmsteamsconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiversmsteamsconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.msteamsConfigs.httpConfig.authorization`](#obj-specreceiversmsteamsconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiversmsteamsconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.msteamsConfigs.httpConfig.authorization.credentials`](#obj-specreceiversmsteamsconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.basicAuth`](#obj-specreceiversmsteamsconfigshttpconfigbasicauth) + * [`obj spec.receivers.msteamsConfigs.httpConfig.basicAuth.password`](#obj-specreceiversmsteamsconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.basicAuth.username`](#obj-specreceiversmsteamsconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiversmsteamsconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2`](#obj-specreceiversmsteamsconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId`](#obj-specreceiversmsteamsconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiversmsteamsconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiversmsteamsconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiversmsteamsconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiversmsteamsconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig`](#obj-specreceiversmsteamsconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiversmsteamsconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiversmsteamsconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiversmsteamsconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiversmsteamsconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiversmsteamsconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiversmsteamsconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiversmsteamsconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.msteamsConfigs.webhookUrl`](#obj-specreceiversmsteamsconfigswebhookurl) + * [`fn withKey(key)`](#fn-specreceiversmsteamsconfigswebhookurlwithkey) + * [`fn withName(name)`](#fn-specreceiversmsteamsconfigswebhookurlwithname) + * [`fn withOptional(optional)`](#fn-specreceiversmsteamsconfigswebhookurlwithoptional) + * [`obj spec.receivers.opsgenieConfigs`](#obj-specreceiversopsgenieconfigs) + * [`fn withActions(actions)`](#fn-specreceiversopsgenieconfigswithactions) + * [`fn withApiURL(apiURL)`](#fn-specreceiversopsgenieconfigswithapiurl) + * [`fn withDescription(description)`](#fn-specreceiversopsgenieconfigswithdescription) + * [`fn withDetails(details)`](#fn-specreceiversopsgenieconfigswithdetails) + * [`fn withDetailsMixin(details)`](#fn-specreceiversopsgenieconfigswithdetailsmixin) + * [`fn withEntity(entity)`](#fn-specreceiversopsgenieconfigswithentity) + * [`fn withMessage(message)`](#fn-specreceiversopsgenieconfigswithmessage) + * [`fn withNote(note)`](#fn-specreceiversopsgenieconfigswithnote) + * [`fn withPriority(priority)`](#fn-specreceiversopsgenieconfigswithpriority) + * [`fn withResponders(responders)`](#fn-specreceiversopsgenieconfigswithresponders) + * [`fn withRespondersMixin(responders)`](#fn-specreceiversopsgenieconfigswithrespondersmixin) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiversopsgenieconfigswithsendresolved) + * [`fn withSource(source)`](#fn-specreceiversopsgenieconfigswithsource) + * [`fn withTags(tags)`](#fn-specreceiversopsgenieconfigswithtags) + * [`fn withUpdateAlerts(updateAlerts)`](#fn-specreceiversopsgenieconfigswithupdatealerts) + * [`obj spec.receivers.opsgenieConfigs.apiKey`](#obj-specreceiversopsgenieconfigsapikey) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigsapikeywithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigsapikeywithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigsapikeywithoptional) + * [`obj spec.receivers.opsgenieConfigs.details`](#obj-specreceiversopsgenieconfigsdetails) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigsdetailswithkey) + * [`fn withValue(value)`](#fn-specreceiversopsgenieconfigsdetailswithvalue) + * [`obj spec.receivers.opsgenieConfigs.httpConfig`](#obj-specreceiversopsgenieconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiversopsgenieconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiversopsgenieconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.authorization`](#obj-specreceiversopsgenieconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiversopsgenieconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials`](#obj-specreceiversopsgenieconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth`](#obj-specreceiversopsgenieconfigshttpconfigbasicauth) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password`](#obj-specreceiversopsgenieconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username`](#obj-specreceiversopsgenieconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiversopsgenieconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2`](#obj-specreceiversopsgenieconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId`](#obj-specreceiversopsgenieconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiversopsgenieconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiversopsgenieconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiversopsgenieconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiversopsgenieconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig`](#obj-specreceiversopsgenieconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiversopsgenieconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiversopsgenieconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiversopsgenieconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiversopsgenieconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiversopsgenieconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiversopsgenieconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiversopsgenieconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversopsgenieconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.opsgenieConfigs.responders`](#obj-specreceiversopsgenieconfigsresponders) + * [`fn withId(id)`](#fn-specreceiversopsgenieconfigsresponderswithid) + * [`fn withName(name)`](#fn-specreceiversopsgenieconfigsresponderswithname) + * [`fn withType(type)`](#fn-specreceiversopsgenieconfigsresponderswithtype) + * [`fn withUsername(username)`](#fn-specreceiversopsgenieconfigsresponderswithusername) + * [`obj spec.receivers.pagerdutyConfigs`](#obj-specreceiverspagerdutyconfigs) + * [`fn withClass(class)`](#fn-specreceiverspagerdutyconfigswithclass) + * [`fn withClient(client)`](#fn-specreceiverspagerdutyconfigswithclient) + * [`fn withClientURL(clientURL)`](#fn-specreceiverspagerdutyconfigswithclienturl) + * [`fn withComponent(component)`](#fn-specreceiverspagerdutyconfigswithcomponent) + * [`fn withDescription(description)`](#fn-specreceiverspagerdutyconfigswithdescription) + * [`fn withDetails(details)`](#fn-specreceiverspagerdutyconfigswithdetails) + * [`fn withDetailsMixin(details)`](#fn-specreceiverspagerdutyconfigswithdetailsmixin) + * [`fn withGroup(group)`](#fn-specreceiverspagerdutyconfigswithgroup) + * [`fn withPagerDutyImageConfigs(pagerDutyImageConfigs)`](#fn-specreceiverspagerdutyconfigswithpagerdutyimageconfigs) + * [`fn withPagerDutyImageConfigsMixin(pagerDutyImageConfigs)`](#fn-specreceiverspagerdutyconfigswithpagerdutyimageconfigsmixin) + * [`fn withPagerDutyLinkConfigs(pagerDutyLinkConfigs)`](#fn-specreceiverspagerdutyconfigswithpagerdutylinkconfigs) + * [`fn withPagerDutyLinkConfigsMixin(pagerDutyLinkConfigs)`](#fn-specreceiverspagerdutyconfigswithpagerdutylinkconfigsmixin) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiverspagerdutyconfigswithsendresolved) + * [`fn withSeverity(severity)`](#fn-specreceiverspagerdutyconfigswithseverity) + * [`fn withSource(source)`](#fn-specreceiverspagerdutyconfigswithsource) + * [`fn withUrl(url)`](#fn-specreceiverspagerdutyconfigswithurl) + * [`obj spec.receivers.pagerdutyConfigs.details`](#obj-specreceiverspagerdutyconfigsdetails) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigsdetailswithkey) + * [`fn withValue(value)`](#fn-specreceiverspagerdutyconfigsdetailswithvalue) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig`](#obj-specreceiverspagerdutyconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiverspagerdutyconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiverspagerdutyconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.authorization`](#obj-specreceiverspagerdutyconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiverspagerdutyconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials`](#obj-specreceiverspagerdutyconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth`](#obj-specreceiverspagerdutyconfigshttpconfigbasicauth) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password`](#obj-specreceiverspagerdutyconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username`](#obj-specreceiverspagerdutyconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiverspagerdutyconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig`](#obj-specreceiverspagerdutyconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiverspagerdutyconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiverspagerdutyconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiverspagerdutyconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiverspagerdutyconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiverspagerdutyconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiverspagerdutyconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiverspagerdutyconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs`](#obj-specreceiverspagerdutyconfigspagerdutyimageconfigs) + * [`fn withAlt(alt)`](#fn-specreceiverspagerdutyconfigspagerdutyimageconfigswithalt) + * [`fn withHref(href)`](#fn-specreceiverspagerdutyconfigspagerdutyimageconfigswithhref) + * [`fn withSrc(src)`](#fn-specreceiverspagerdutyconfigspagerdutyimageconfigswithsrc) + * [`obj spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs`](#obj-specreceiverspagerdutyconfigspagerdutylinkconfigs) + * [`fn withAlt(alt)`](#fn-specreceiverspagerdutyconfigspagerdutylinkconfigswithalt) + * [`fn withHref(href)`](#fn-specreceiverspagerdutyconfigspagerdutylinkconfigswithhref) + * [`obj spec.receivers.pagerdutyConfigs.routingKey`](#obj-specreceiverspagerdutyconfigsroutingkey) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigsroutingkeywithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigsroutingkeywithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigsroutingkeywithoptional) + * [`obj spec.receivers.pagerdutyConfigs.serviceKey`](#obj-specreceiverspagerdutyconfigsservicekey) + * [`fn withKey(key)`](#fn-specreceiverspagerdutyconfigsservicekeywithkey) + * [`fn withName(name)`](#fn-specreceiverspagerdutyconfigsservicekeywithname) + * [`fn withOptional(optional)`](#fn-specreceiverspagerdutyconfigsservicekeywithoptional) + * [`obj spec.receivers.pushoverConfigs`](#obj-specreceiverspushoverconfigs) + * [`fn withDevice(device)`](#fn-specreceiverspushoverconfigswithdevice) + * [`fn withExpire(expire)`](#fn-specreceiverspushoverconfigswithexpire) + * [`fn withHtml(html)`](#fn-specreceiverspushoverconfigswithhtml) + * [`fn withMessage(message)`](#fn-specreceiverspushoverconfigswithmessage) + * [`fn withPriority(priority)`](#fn-specreceiverspushoverconfigswithpriority) + * [`fn withRetry(retry)`](#fn-specreceiverspushoverconfigswithretry) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiverspushoverconfigswithsendresolved) + * [`fn withSound(sound)`](#fn-specreceiverspushoverconfigswithsound) + * [`fn withTitle(title)`](#fn-specreceiverspushoverconfigswithtitle) + * [`fn withTokenFile(tokenFile)`](#fn-specreceiverspushoverconfigswithtokenfile) + * [`fn withTtl(ttl)`](#fn-specreceiverspushoverconfigswithttl) + * [`fn withUrl(url)`](#fn-specreceiverspushoverconfigswithurl) + * [`fn withUrlTitle(urlTitle)`](#fn-specreceiverspushoverconfigswithurltitle) + * [`fn withUserKeyFile(userKeyFile)`](#fn-specreceiverspushoverconfigswithuserkeyfile) + * [`obj spec.receivers.pushoverConfigs.httpConfig`](#obj-specreceiverspushoverconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiverspushoverconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiverspushoverconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.pushoverConfigs.httpConfig.authorization`](#obj-specreceiverspushoverconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiverspushoverconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.pushoverConfigs.httpConfig.authorization.credentials`](#obj-specreceiverspushoverconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.basicAuth`](#obj-specreceiverspushoverconfigshttpconfigbasicauth) + * [`obj spec.receivers.pushoverConfigs.httpConfig.basicAuth.password`](#obj-specreceiverspushoverconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.basicAuth.username`](#obj-specreceiverspushoverconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiverspushoverconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2`](#obj-specreceiverspushoverconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiverspushoverconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId`](#obj-specreceiverspushoverconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiverspushoverconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiverspushoverconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiverspushoverconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiverspushoverconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiverspushoverconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiverspushoverconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig`](#obj-specreceiverspushoverconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiverspushoverconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiverspushoverconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiverspushoverconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiverspushoverconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiverspushoverconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiverspushoverconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiverspushoverconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.pushoverConfigs.token`](#obj-specreceiverspushoverconfigstoken) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigstokenwithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigstokenwithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigstokenwithoptional) + * [`obj spec.receivers.pushoverConfigs.userKey`](#obj-specreceiverspushoverconfigsuserkey) + * [`fn withKey(key)`](#fn-specreceiverspushoverconfigsuserkeywithkey) + * [`fn withName(name)`](#fn-specreceiverspushoverconfigsuserkeywithname) + * [`fn withOptional(optional)`](#fn-specreceiverspushoverconfigsuserkeywithoptional) + * [`obj spec.receivers.slackConfigs`](#obj-specreceiversslackconfigs) + * [`fn withActions(actions)`](#fn-specreceiversslackconfigswithactions) + * [`fn withActionsMixin(actions)`](#fn-specreceiversslackconfigswithactionsmixin) + * [`fn withCallbackId(callbackId)`](#fn-specreceiversslackconfigswithcallbackid) + * [`fn withChannel(channel)`](#fn-specreceiversslackconfigswithchannel) + * [`fn withColor(color)`](#fn-specreceiversslackconfigswithcolor) + * [`fn withFallback(fallback)`](#fn-specreceiversslackconfigswithfallback) + * [`fn withFields(fields)`](#fn-specreceiversslackconfigswithfields) + * [`fn withFieldsMixin(fields)`](#fn-specreceiversslackconfigswithfieldsmixin) + * [`fn withFooter(footer)`](#fn-specreceiversslackconfigswithfooter) + * [`fn withIconEmoji(iconEmoji)`](#fn-specreceiversslackconfigswithiconemoji) + * [`fn withIconURL(iconURL)`](#fn-specreceiversslackconfigswithiconurl) + * [`fn withImageURL(imageURL)`](#fn-specreceiversslackconfigswithimageurl) + * [`fn withLinkNames(linkNames)`](#fn-specreceiversslackconfigswithlinknames) + * [`fn withMrkdwnIn(mrkdwnIn)`](#fn-specreceiversslackconfigswithmrkdwnin) + * [`fn withMrkdwnInMixin(mrkdwnIn)`](#fn-specreceiversslackconfigswithmrkdwninmixin) + * [`fn withPretext(pretext)`](#fn-specreceiversslackconfigswithpretext) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiversslackconfigswithsendresolved) + * [`fn withShortFields(shortFields)`](#fn-specreceiversslackconfigswithshortfields) + * [`fn withText(text)`](#fn-specreceiversslackconfigswithtext) + * [`fn withThumbURL(thumbURL)`](#fn-specreceiversslackconfigswiththumburl) + * [`fn withTitle(title)`](#fn-specreceiversslackconfigswithtitle) + * [`fn withTitleLink(titleLink)`](#fn-specreceiversslackconfigswithtitlelink) + * [`fn withUsername(username)`](#fn-specreceiversslackconfigswithusername) + * [`obj spec.receivers.slackConfigs.actions`](#obj-specreceiversslackconfigsactions) + * [`fn withName(name)`](#fn-specreceiversslackconfigsactionswithname) + * [`fn withStyle(style)`](#fn-specreceiversslackconfigsactionswithstyle) + * [`fn withText(text)`](#fn-specreceiversslackconfigsactionswithtext) + * [`fn withType(type)`](#fn-specreceiversslackconfigsactionswithtype) + * [`fn withUrl(url)`](#fn-specreceiversslackconfigsactionswithurl) + * [`fn withValue(value)`](#fn-specreceiversslackconfigsactionswithvalue) + * [`obj spec.receivers.slackConfigs.actions.confirm`](#obj-specreceiversslackconfigsactionsconfirm) + * [`fn withDismissText(dismissText)`](#fn-specreceiversslackconfigsactionsconfirmwithdismisstext) + * [`fn withOkText(okText)`](#fn-specreceiversslackconfigsactionsconfirmwithoktext) + * [`fn withText(text)`](#fn-specreceiversslackconfigsactionsconfirmwithtext) + * [`fn withTitle(title)`](#fn-specreceiversslackconfigsactionsconfirmwithtitle) + * [`obj spec.receivers.slackConfigs.apiURL`](#obj-specreceiversslackconfigsapiurl) + * [`fn withKey(key)`](#fn-specreceiversslackconfigsapiurlwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigsapiurlwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigsapiurlwithoptional) + * [`obj spec.receivers.slackConfigs.fields`](#obj-specreceiversslackconfigsfields) + * [`fn withShort(short)`](#fn-specreceiversslackconfigsfieldswithshort) + * [`fn withTitle(title)`](#fn-specreceiversslackconfigsfieldswithtitle) + * [`fn withValue(value)`](#fn-specreceiversslackconfigsfieldswithvalue) + * [`obj spec.receivers.slackConfigs.httpConfig`](#obj-specreceiversslackconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiversslackconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiversslackconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.slackConfigs.httpConfig.authorization`](#obj-specreceiversslackconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiversslackconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.slackConfigs.httpConfig.authorization.credentials`](#obj-specreceiversslackconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.basicAuth`](#obj-specreceiversslackconfigshttpconfigbasicauth) + * [`obj spec.receivers.slackConfigs.httpConfig.basicAuth.password`](#obj-specreceiversslackconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.basicAuth.username`](#obj-specreceiversslackconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiversslackconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2`](#obj-specreceiversslackconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiversslackconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiversslackconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiversslackconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiversslackconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiversslackconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiversslackconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiversslackconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiversslackconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiversslackconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiversslackconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId`](#obj-specreceiversslackconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiversslackconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiversslackconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiversslackconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiversslackconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiversslackconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiversslackconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiversslackconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiversslackconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiversslackconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiversslackconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiversslackconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.tlsConfig`](#obj-specreceiversslackconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversslackconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversslackconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversslackconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversslackconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiversslackconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiversslackconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiversslackconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiversslackconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiversslackconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiversslackconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiversslackconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversslackconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversslackconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversslackconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.snsConfigs`](#obj-specreceiverssnsconfigs) + * [`fn withApiURL(apiURL)`](#fn-specreceiverssnsconfigswithapiurl) + * [`fn withAttributes(attributes)`](#fn-specreceiverssnsconfigswithattributes) + * [`fn withAttributesMixin(attributes)`](#fn-specreceiverssnsconfigswithattributesmixin) + * [`fn withMessage(message)`](#fn-specreceiverssnsconfigswithmessage) + * [`fn withPhoneNumber(phoneNumber)`](#fn-specreceiverssnsconfigswithphonenumber) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiverssnsconfigswithsendresolved) + * [`fn withSubject(subject)`](#fn-specreceiverssnsconfigswithsubject) + * [`fn withTargetARN(targetARN)`](#fn-specreceiverssnsconfigswithtargetarn) + * [`fn withTopicARN(topicARN)`](#fn-specreceiverssnsconfigswithtopicarn) + * [`obj spec.receivers.snsConfigs.httpConfig`](#obj-specreceiverssnsconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiverssnsconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiverssnsconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.snsConfigs.httpConfig.authorization`](#obj-specreceiverssnsconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiverssnsconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.snsConfigs.httpConfig.authorization.credentials`](#obj-specreceiverssnsconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.basicAuth`](#obj-specreceiverssnsconfigshttpconfigbasicauth) + * [`obj spec.receivers.snsConfigs.httpConfig.basicAuth.password`](#obj-specreceiverssnsconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.basicAuth.username`](#obj-specreceiverssnsconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiverssnsconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2`](#obj-specreceiverssnsconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiverssnsconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiverssnsconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiverssnsconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiverssnsconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiverssnsconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiverssnsconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiverssnsconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiverssnsconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiverssnsconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiverssnsconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId`](#obj-specreceiverssnsconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiverssnsconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiverssnsconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiverssnsconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiverssnsconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiverssnsconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiverssnsconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiverssnsconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiverssnsconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiverssnsconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiverssnsconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiverssnsconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.tlsConfig`](#obj-specreceiverssnsconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiverssnsconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiverssnsconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiverssnsconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiverssnsconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiverssnsconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiverssnsconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiverssnsconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.snsConfigs.sigv4`](#obj-specreceiverssnsconfigssigv4) + * [`fn withProfile(profile)`](#fn-specreceiverssnsconfigssigv4withprofile) + * [`fn withRegion(region)`](#fn-specreceiverssnsconfigssigv4withregion) + * [`fn withRoleArn(roleArn)`](#fn-specreceiverssnsconfigssigv4withrolearn) + * [`obj spec.receivers.snsConfigs.sigv4.accessKey`](#obj-specreceiverssnsconfigssigv4accesskey) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigssigv4accesskeywithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigssigv4accesskeywithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigssigv4accesskeywithoptional) + * [`obj spec.receivers.snsConfigs.sigv4.secretKey`](#obj-specreceiverssnsconfigssigv4secretkey) + * [`fn withKey(key)`](#fn-specreceiverssnsconfigssigv4secretkeywithkey) + * [`fn withName(name)`](#fn-specreceiverssnsconfigssigv4secretkeywithname) + * [`fn withOptional(optional)`](#fn-specreceiverssnsconfigssigv4secretkeywithoptional) + * [`obj spec.receivers.telegramConfigs`](#obj-specreceiverstelegramconfigs) + * [`fn withApiURL(apiURL)`](#fn-specreceiverstelegramconfigswithapiurl) + * [`fn withBotTokenFile(botTokenFile)`](#fn-specreceiverstelegramconfigswithbottokenfile) + * [`fn withChatID(chatID)`](#fn-specreceiverstelegramconfigswithchatid) + * [`fn withDisableNotifications(disableNotifications)`](#fn-specreceiverstelegramconfigswithdisablenotifications) + * [`fn withMessage(message)`](#fn-specreceiverstelegramconfigswithmessage) + * [`fn withParseMode(parseMode)`](#fn-specreceiverstelegramconfigswithparsemode) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiverstelegramconfigswithsendresolved) + * [`obj spec.receivers.telegramConfigs.botToken`](#obj-specreceiverstelegramconfigsbottoken) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigsbottokenwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigsbottokenwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigsbottokenwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig`](#obj-specreceiverstelegramconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiverstelegramconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiverstelegramconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.telegramConfigs.httpConfig.authorization`](#obj-specreceiverstelegramconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiverstelegramconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.telegramConfigs.httpConfig.authorization.credentials`](#obj-specreceiverstelegramconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.basicAuth`](#obj-specreceiverstelegramconfigshttpconfigbasicauth) + * [`obj spec.receivers.telegramConfigs.httpConfig.basicAuth.password`](#obj-specreceiverstelegramconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.basicAuth.username`](#obj-specreceiverstelegramconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiverstelegramconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2`](#obj-specreceiverstelegramconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiverstelegramconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId`](#obj-specreceiverstelegramconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiverstelegramconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiverstelegramconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiverstelegramconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiverstelegramconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiverstelegramconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiverstelegramconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.tlsConfig`](#obj-specreceiverstelegramconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiverstelegramconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiverstelegramconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiverstelegramconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiverstelegramconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiverstelegramconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiverstelegramconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiverstelegramconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverstelegramconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.victoropsConfigs`](#obj-specreceiversvictoropsconfigs) + * [`fn withApiUrl(apiUrl)`](#fn-specreceiversvictoropsconfigswithapiurl) + * [`fn withCustomFields(customFields)`](#fn-specreceiversvictoropsconfigswithcustomfields) + * [`fn withCustomFieldsMixin(customFields)`](#fn-specreceiversvictoropsconfigswithcustomfieldsmixin) + * [`fn withEntityDisplayName(entityDisplayName)`](#fn-specreceiversvictoropsconfigswithentitydisplayname) + * [`fn withMessageType(messageType)`](#fn-specreceiversvictoropsconfigswithmessagetype) + * [`fn withMonitoringTool(monitoringTool)`](#fn-specreceiversvictoropsconfigswithmonitoringtool) + * [`fn withRoutingKey(routingKey)`](#fn-specreceiversvictoropsconfigswithroutingkey) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiversvictoropsconfigswithsendresolved) + * [`fn withStateMessage(stateMessage)`](#fn-specreceiversvictoropsconfigswithstatemessage) + * [`obj spec.receivers.victoropsConfigs.apiKey`](#obj-specreceiversvictoropsconfigsapikey) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigsapikeywithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigsapikeywithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigsapikeywithoptional) + * [`obj spec.receivers.victoropsConfigs.customFields`](#obj-specreceiversvictoropsconfigscustomfields) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigscustomfieldswithkey) + * [`fn withValue(value)`](#fn-specreceiversvictoropsconfigscustomfieldswithvalue) + * [`obj spec.receivers.victoropsConfigs.httpConfig`](#obj-specreceiversvictoropsconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiversvictoropsconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiversvictoropsconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.victoropsConfigs.httpConfig.authorization`](#obj-specreceiversvictoropsconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiversvictoropsconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.victoropsConfigs.httpConfig.authorization.credentials`](#obj-specreceiversvictoropsconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.basicAuth`](#obj-specreceiversvictoropsconfigshttpconfigbasicauth) + * [`obj spec.receivers.victoropsConfigs.httpConfig.basicAuth.password`](#obj-specreceiversvictoropsconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.basicAuth.username`](#obj-specreceiversvictoropsconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiversvictoropsconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2`](#obj-specreceiversvictoropsconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId`](#obj-specreceiversvictoropsconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiversvictoropsconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiversvictoropsconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiversvictoropsconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiversvictoropsconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig`](#obj-specreceiversvictoropsconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiversvictoropsconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiversvictoropsconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiversvictoropsconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiversvictoropsconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiversvictoropsconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiversvictoropsconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiversvictoropsconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiversvictoropsconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.webexConfigs`](#obj-specreceiverswebexconfigs) + * [`fn withApiURL(apiURL)`](#fn-specreceiverswebexconfigswithapiurl) + * [`fn withMessage(message)`](#fn-specreceiverswebexconfigswithmessage) + * [`fn withRoomID(roomID)`](#fn-specreceiverswebexconfigswithroomid) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiverswebexconfigswithsendresolved) + * [`obj spec.receivers.webexConfigs.httpConfig`](#obj-specreceiverswebexconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiverswebexconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiverswebexconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.webexConfigs.httpConfig.authorization`](#obj-specreceiverswebexconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiverswebexconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.webexConfigs.httpConfig.authorization.credentials`](#obj-specreceiverswebexconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.basicAuth`](#obj-specreceiverswebexconfigshttpconfigbasicauth) + * [`obj spec.receivers.webexConfigs.httpConfig.basicAuth.password`](#obj-specreceiverswebexconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.basicAuth.username`](#obj-specreceiverswebexconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiverswebexconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2`](#obj-specreceiverswebexconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiverswebexconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiverswebexconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiverswebexconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiverswebexconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiverswebexconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiverswebexconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiverswebexconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiverswebexconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiverswebexconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiverswebexconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.clientId`](#obj-specreceiverswebexconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiverswebexconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiverswebexconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiverswebexconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiverswebexconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiverswebexconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiverswebexconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiverswebexconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiverswebexconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiverswebexconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiverswebexconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiverswebexconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.tlsConfig`](#obj-specreceiverswebexconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.webexConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiverswebexconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiverswebexconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiverswebexconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiverswebexconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiverswebexconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiverswebexconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiverswebexconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebexconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.webhookConfigs`](#obj-specreceiverswebhookconfigs) + * [`fn withMaxAlerts(maxAlerts)`](#fn-specreceiverswebhookconfigswithmaxalerts) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiverswebhookconfigswithsendresolved) + * [`fn withUrl(url)`](#fn-specreceiverswebhookconfigswithurl) + * [`obj spec.receivers.webhookConfigs.httpConfig`](#obj-specreceiverswebhookconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiverswebhookconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiverswebhookconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.webhookConfigs.httpConfig.authorization`](#obj-specreceiverswebhookconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiverswebhookconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.webhookConfigs.httpConfig.authorization.credentials`](#obj-specreceiverswebhookconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.basicAuth`](#obj-specreceiverswebhookconfigshttpconfigbasicauth) + * [`obj spec.receivers.webhookConfigs.httpConfig.basicAuth.password`](#obj-specreceiverswebhookconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.basicAuth.username`](#obj-specreceiverswebhookconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiverswebhookconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2`](#obj-specreceiverswebhookconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiverswebhookconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId`](#obj-specreceiverswebhookconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiverswebhookconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiverswebhookconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiverswebhookconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiverswebhookconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiverswebhookconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiverswebhookconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.tlsConfig`](#obj-specreceiverswebhookconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiverswebhookconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiverswebhookconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiverswebhookconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiverswebhookconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiverswebhookconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiverswebhookconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiverswebhookconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.receivers.webhookConfigs.urlSecret`](#obj-specreceiverswebhookconfigsurlsecret) + * [`fn withKey(key)`](#fn-specreceiverswebhookconfigsurlsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswebhookconfigsurlsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswebhookconfigsurlsecretwithoptional) + * [`obj spec.receivers.wechatConfigs`](#obj-specreceiverswechatconfigs) + * [`fn withAgentID(agentID)`](#fn-specreceiverswechatconfigswithagentid) + * [`fn withApiURL(apiURL)`](#fn-specreceiverswechatconfigswithapiurl) + * [`fn withCorpID(corpID)`](#fn-specreceiverswechatconfigswithcorpid) + * [`fn withMessage(message)`](#fn-specreceiverswechatconfigswithmessage) + * [`fn withMessageType(messageType)`](#fn-specreceiverswechatconfigswithmessagetype) + * [`fn withSendResolved(sendResolved)`](#fn-specreceiverswechatconfigswithsendresolved) + * [`fn withToParty(toParty)`](#fn-specreceiverswechatconfigswithtoparty) + * [`fn withToTag(toTag)`](#fn-specreceiverswechatconfigswithtotag) + * [`fn withToUser(toUser)`](#fn-specreceiverswechatconfigswithtouser) + * [`obj spec.receivers.wechatConfigs.apiSecret`](#obj-specreceiverswechatconfigsapisecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigsapisecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigsapisecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigsapisecretwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig`](#obj-specreceiverswechatconfigshttpconfig) + * [`fn withFollowRedirects(followRedirects)`](#fn-specreceiverswechatconfigshttpconfigwithfollowredirects) + * [`fn withProxyURL(proxyURL)`](#fn-specreceiverswechatconfigshttpconfigwithproxyurl) + * [`obj spec.receivers.wechatConfigs.httpConfig.authorization`](#obj-specreceiverswechatconfigshttpconfigauthorization) + * [`fn withType(type)`](#fn-specreceiverswechatconfigshttpconfigauthorizationwithtype) + * [`obj spec.receivers.wechatConfigs.httpConfig.authorization.credentials`](#obj-specreceiverswechatconfigshttpconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigauthorizationcredentialswithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.basicAuth`](#obj-specreceiverswechatconfigshttpconfigbasicauth) + * [`obj spec.receivers.wechatConfigs.httpConfig.basicAuth.password`](#obj-specreceiverswechatconfigshttpconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigbasicauthpasswordwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.basicAuth.username`](#obj-specreceiverswechatconfigshttpconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigbasicauthusernamewithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret`](#obj-specreceiverswechatconfigshttpconfigbearertokensecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigbearertokensecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigbearertokensecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigbearertokensecretwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2`](#obj-specreceiverswechatconfigshttpconfigoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specreceiverswechatconfigshttpconfigoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specreceiverswechatconfigshttpconfigoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specreceiverswechatconfigshttpconfigoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specreceiverswechatconfigshttpconfigoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specreceiverswechatconfigshttpconfigoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specreceiverswechatconfigshttpconfigoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specreceiverswechatconfigshttpconfigoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specreceiverswechatconfigshttpconfigoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specreceiverswechatconfigshttpconfigoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specreceiverswechatconfigshttpconfigoauth2withtokenurl) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId`](#obj-specreceiverswechatconfigshttpconfigoauth2clientid) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap`](#obj-specreceiverswechatconfigshttpconfigoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigoauth2clientidconfigmapwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret`](#obj-specreceiverswechatconfigshttpconfigoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigoauth2clientidsecretwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret`](#obj-specreceiverswechatconfigshttpconfigoauth2clientsecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigoauth2clientsecretwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig`](#obj-specreceiverswechatconfigshttpconfigoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigwithservername) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca`](#obj-specreceiverswechatconfigshttpconfigoauth2tlsconfigca) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap`](#obj-specreceiverswechatconfigshttpconfigoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.secret`](#obj-specreceiverswechatconfigshttpconfigoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcasecretwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert`](#obj-specreceiverswechatconfigshttpconfigoauth2tlsconfigcert) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap`](#obj-specreceiverswechatconfigshttpconfigoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.secret`](#obj-specreceiverswechatconfigshttpconfigoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret`](#obj-specreceiverswechatconfigshttpconfigoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.tlsConfig`](#obj-specreceiverswechatconfigshttpconfigtlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigwithservername) + * [`obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca`](#obj-specreceiverswechatconfigshttpconfigtlsconfigca) + * [`obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap`](#obj-specreceiverswechatconfigshttpconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret`](#obj-specreceiverswechatconfigshttpconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcasecretwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert`](#obj-specreceiverswechatconfigshttpconfigtlsconfigcert) + * [`obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap`](#obj-specreceiverswechatconfigshttpconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret`](#obj-specreceiverswechatconfigshttpconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigcertsecretwithoptional) + * [`obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret`](#obj-specreceiverswechatconfigshttpconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specreceiverswechatconfigshttpconfigtlsconfigkeysecretwithoptional) + * [`obj spec.route`](#obj-specroute) + * [`fn withActiveTimeIntervals(activeTimeIntervals)`](#fn-specroutewithactivetimeintervals) + * [`fn withActiveTimeIntervalsMixin(activeTimeIntervals)`](#fn-specroutewithactivetimeintervalsmixin) + * [`fn withContinue(continue)`](#fn-specroutewithcontinue) + * [`fn withGroupBy(groupBy)`](#fn-specroutewithgroupby) + * [`fn withGroupByMixin(groupBy)`](#fn-specroutewithgroupbymixin) + * [`fn withGroupInterval(groupInterval)`](#fn-specroutewithgroupinterval) + * [`fn withGroupWait(groupWait)`](#fn-specroutewithgroupwait) + * [`fn withMatchers(matchers)`](#fn-specroutewithmatchers) + * [`fn withMatchersMixin(matchers)`](#fn-specroutewithmatchersmixin) + * [`fn withMuteTimeIntervals(muteTimeIntervals)`](#fn-specroutewithmutetimeintervals) + * [`fn withMuteTimeIntervalsMixin(muteTimeIntervals)`](#fn-specroutewithmutetimeintervalsmixin) + * [`fn withReceiver(receiver)`](#fn-specroutewithreceiver) + * [`fn withRepeatInterval(repeatInterval)`](#fn-specroutewithrepeatinterval) + * [`fn withRoutes(routes)`](#fn-specroutewithroutes) + * [`fn withRoutesMixin(routes)`](#fn-specroutewithroutesmixin) + * [`obj spec.route.matchers`](#obj-specroutematchers) + * [`fn withMatchType(matchType)`](#fn-specroutematcherswithmatchtype) + * [`fn withName(name)`](#fn-specroutematcherswithname) + * [`fn withRegex(regex)`](#fn-specroutematcherswithregex) + * [`fn withValue(value)`](#fn-specroutematcherswithvalue) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of AlertmanagerConfig + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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 + +"AlertmanagerConfigSpec is a specification of the desired behavior of the\nAlertmanager configuration.\nBy default, the Alertmanager configuration only applies to alerts for which\nthe `namespace` label is equal to the namespace of the AlertmanagerConfig\nresource (see the `.spec.alertmanagerConfigMatcherStrategy` field of the\nAlertmanager CRD)." + +### fn spec.withInhibitRules + +```ts +withInhibitRules(inhibitRules) +``` + +"List of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace." + +### fn spec.withInhibitRulesMixin + +```ts +withInhibitRulesMixin(inhibitRules) +``` + +"List of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace." + +**Note:** This function appends passed data to existing values + +### fn spec.withMuteTimeIntervals + +```ts +withMuteTimeIntervals(muteTimeIntervals) +``` + +"List of MuteTimeInterval specifying when the routes should be muted." + +### fn spec.withMuteTimeIntervalsMixin + +```ts +withMuteTimeIntervalsMixin(muteTimeIntervals) +``` + +"List of MuteTimeInterval specifying when the routes should be muted." + +**Note:** This function appends passed data to existing values + +### fn spec.withReceivers + +```ts +withReceivers(receivers) +``` + +"List of receivers." + +### fn spec.withReceiversMixin + +```ts +withReceiversMixin(receivers) +``` + +"List of receivers." + +**Note:** This function appends passed data to existing values + +## obj spec.inhibitRules + +"List of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace." + +### fn spec.inhibitRules.withEqual + +```ts +withEqual(equal) +``` + +"Labels that must have an equal value in the source and target alert for\nthe inhibition to take effect." + +### fn spec.inhibitRules.withEqualMixin + +```ts +withEqualMixin(equal) +``` + +"Labels that must have an equal value in the source and target alert for\nthe inhibition to take effect." + +**Note:** This function appends passed data to existing values + +### fn spec.inhibitRules.withSourceMatch + +```ts +withSourceMatch(sourceMatch) +``` + +"Matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the\nresource's namespace." + +### fn spec.inhibitRules.withSourceMatchMixin + +```ts +withSourceMatchMixin(sourceMatch) +``` + +"Matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the\nresource's namespace." + +**Note:** This function appends passed data to existing values + +### fn spec.inhibitRules.withTargetMatch + +```ts +withTargetMatch(targetMatch) +``` + +"Matchers that have to be fulfilled in the alerts to be muted. The\noperator enforces that the alert matches the resource's namespace." + +### fn spec.inhibitRules.withTargetMatchMixin + +```ts +withTargetMatchMixin(targetMatch) +``` + +"Matchers that have to be fulfilled in the alerts to be muted. The\noperator enforces that the alert matches the resource's namespace." + +**Note:** This function appends passed data to existing values + +## obj spec.inhibitRules.sourceMatch + +"Matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the\nresource's namespace." + +### fn spec.inhibitRules.sourceMatch.withMatchType + +```ts +withMatchType(matchType) +``` + +"Match operation available with AlertManager >= v0.22.0 and\ntakes precedence over Regex (deprecated) if non-empty." + +### fn spec.inhibitRules.sourceMatch.withName + +```ts +withName(name) +``` + +"Label to match." + +### fn spec.inhibitRules.sourceMatch.withRegex + +```ts +withRegex(regex) +``` + +"Whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead." + +### fn spec.inhibitRules.sourceMatch.withValue + +```ts +withValue(value) +``` + +"Label value to match." + +## obj spec.inhibitRules.targetMatch + +"Matchers that have to be fulfilled in the alerts to be muted. The\noperator enforces that the alert matches the resource's namespace." + +### fn spec.inhibitRules.targetMatch.withMatchType + +```ts +withMatchType(matchType) +``` + +"Match operation available with AlertManager >= v0.22.0 and\ntakes precedence over Regex (deprecated) if non-empty." + +### fn spec.inhibitRules.targetMatch.withName + +```ts +withName(name) +``` + +"Label to match." + +### fn spec.inhibitRules.targetMatch.withRegex + +```ts +withRegex(regex) +``` + +"Whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead." + +### fn spec.inhibitRules.targetMatch.withValue + +```ts +withValue(value) +``` + +"Label value to match." + +## obj spec.muteTimeIntervals + +"List of MuteTimeInterval specifying when the routes should be muted." + +### fn spec.muteTimeIntervals.withName + +```ts +withName(name) +``` + +"Name of the time interval" + +### fn spec.muteTimeIntervals.withTimeIntervals + +```ts +withTimeIntervals(timeIntervals) +``` + +"TimeIntervals is a list of TimeInterval" + +### fn spec.muteTimeIntervals.withTimeIntervalsMixin + +```ts +withTimeIntervalsMixin(timeIntervals) +``` + +"TimeIntervals is a list of TimeInterval" + +**Note:** This function appends passed data to existing values + +## obj spec.muteTimeIntervals.timeIntervals + +"TimeIntervals is a list of TimeInterval" + +### fn spec.muteTimeIntervals.timeIntervals.withDaysOfMonth + +```ts +withDaysOfMonth(daysOfMonth) +``` + +"DaysOfMonth is a list of DayOfMonthRange" + +### fn spec.muteTimeIntervals.timeIntervals.withDaysOfMonthMixin + +```ts +withDaysOfMonthMixin(daysOfMonth) +``` + +"DaysOfMonth is a list of DayOfMonthRange" + +**Note:** This function appends passed data to existing values + +### fn spec.muteTimeIntervals.timeIntervals.withMonths + +```ts +withMonths(months) +``` + +"Months is a list of MonthRange" + +### fn spec.muteTimeIntervals.timeIntervals.withMonthsMixin + +```ts +withMonthsMixin(months) +``` + +"Months is a list of MonthRange" + +**Note:** This function appends passed data to existing values + +### fn spec.muteTimeIntervals.timeIntervals.withTimes + +```ts +withTimes(times) +``` + +"Times is a list of TimeRange" + +### fn spec.muteTimeIntervals.timeIntervals.withTimesMixin + +```ts +withTimesMixin(times) +``` + +"Times is a list of TimeRange" + +**Note:** This function appends passed data to existing values + +### fn spec.muteTimeIntervals.timeIntervals.withWeekdays + +```ts +withWeekdays(weekdays) +``` + +"Weekdays is a list of WeekdayRange" + +### fn spec.muteTimeIntervals.timeIntervals.withWeekdaysMixin + +```ts +withWeekdaysMixin(weekdays) +``` + +"Weekdays is a list of WeekdayRange" + +**Note:** This function appends passed data to existing values + +### fn spec.muteTimeIntervals.timeIntervals.withYears + +```ts +withYears(years) +``` + +"Years is a list of YearRange" + +### fn spec.muteTimeIntervals.timeIntervals.withYearsMixin + +```ts +withYearsMixin(years) +``` + +"Years is a list of YearRange" + +**Note:** This function appends passed data to existing values + +## obj spec.muteTimeIntervals.timeIntervals.daysOfMonth + +"DaysOfMonth is a list of DayOfMonthRange" + +### fn spec.muteTimeIntervals.timeIntervals.daysOfMonth.withEnd + +```ts +withEnd(end) +``` + +"End of the inclusive range" + +### fn spec.muteTimeIntervals.timeIntervals.daysOfMonth.withStart + +```ts +withStart(start) +``` + +"Start of the inclusive range" + +## obj spec.muteTimeIntervals.timeIntervals.times + +"Times is a list of TimeRange" + +### fn spec.muteTimeIntervals.timeIntervals.times.withEndTime + +```ts +withEndTime(endTime) +``` + +"EndTime is the end time in 24hr format." + +### fn spec.muteTimeIntervals.timeIntervals.times.withStartTime + +```ts +withStartTime(startTime) +``` + +"StartTime is the start time in 24hr format." + +## obj spec.receivers + +"List of receivers." + +### fn spec.receivers.withDiscordConfigs + +```ts +withDiscordConfigs(discordConfigs) +``` + +"List of Discord configurations." + +### fn spec.receivers.withDiscordConfigsMixin + +```ts +withDiscordConfigsMixin(discordConfigs) +``` + +"List of Discord configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withEmailConfigs + +```ts +withEmailConfigs(emailConfigs) +``` + +"List of Email configurations." + +### fn spec.receivers.withEmailConfigsMixin + +```ts +withEmailConfigsMixin(emailConfigs) +``` + +"List of Email configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withMsteamsConfigs + +```ts +withMsteamsConfigs(msteamsConfigs) +``` + +"List of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0." + +### fn spec.receivers.withMsteamsConfigsMixin + +```ts +withMsteamsConfigsMixin(msteamsConfigs) +``` + +"List of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withName + +```ts +withName(name) +``` + +"Name of the receiver. Must be unique across all items from the list." + +### fn spec.receivers.withOpsgenieConfigs + +```ts +withOpsgenieConfigs(opsgenieConfigs) +``` + +"List of OpsGenie configurations." + +### fn spec.receivers.withOpsgenieConfigsMixin + +```ts +withOpsgenieConfigsMixin(opsgenieConfigs) +``` + +"List of OpsGenie configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withPagerdutyConfigs + +```ts +withPagerdutyConfigs(pagerdutyConfigs) +``` + +"List of PagerDuty configurations." + +### fn spec.receivers.withPagerdutyConfigsMixin + +```ts +withPagerdutyConfigsMixin(pagerdutyConfigs) +``` + +"List of PagerDuty configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withPushoverConfigs + +```ts +withPushoverConfigs(pushoverConfigs) +``` + +"List of Pushover configurations." + +### fn spec.receivers.withPushoverConfigsMixin + +```ts +withPushoverConfigsMixin(pushoverConfigs) +``` + +"List of Pushover configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withSlackConfigs + +```ts +withSlackConfigs(slackConfigs) +``` + +"List of Slack configurations." + +### fn spec.receivers.withSlackConfigsMixin + +```ts +withSlackConfigsMixin(slackConfigs) +``` + +"List of Slack configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withSnsConfigs + +```ts +withSnsConfigs(snsConfigs) +``` + +"List of SNS configurations" + +### fn spec.receivers.withSnsConfigsMixin + +```ts +withSnsConfigsMixin(snsConfigs) +``` + +"List of SNS configurations" + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withTelegramConfigs + +```ts +withTelegramConfigs(telegramConfigs) +``` + +"List of Telegram configurations." + +### fn spec.receivers.withTelegramConfigsMixin + +```ts +withTelegramConfigsMixin(telegramConfigs) +``` + +"List of Telegram configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withVictoropsConfigs + +```ts +withVictoropsConfigs(victoropsConfigs) +``` + +"List of VictorOps configurations." + +### fn spec.receivers.withVictoropsConfigsMixin + +```ts +withVictoropsConfigsMixin(victoropsConfigs) +``` + +"List of VictorOps configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withWebexConfigs + +```ts +withWebexConfigs(webexConfigs) +``` + +"List of Webex configurations." + +### fn spec.receivers.withWebexConfigsMixin + +```ts +withWebexConfigsMixin(webexConfigs) +``` + +"List of Webex configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withWebhookConfigs + +```ts +withWebhookConfigs(webhookConfigs) +``` + +"List of webhook configurations." + +### fn spec.receivers.withWebhookConfigsMixin + +```ts +withWebhookConfigsMixin(webhookConfigs) +``` + +"List of webhook configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.withWechatConfigs + +```ts +withWechatConfigs(wechatConfigs) +``` + +"List of WeChat configurations." + +### fn spec.receivers.withWechatConfigsMixin + +```ts +withWechatConfigsMixin(wechatConfigs) +``` + +"List of WeChat configurations." + +**Note:** This function appends passed data to existing values + +## obj spec.receivers.discordConfigs + +"List of Discord configurations." + +### fn spec.receivers.discordConfigs.withMessage + +```ts +withMessage(message) +``` + +"The template of the message's body." + +### fn spec.receivers.discordConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.discordConfigs.withTitle + +```ts +withTitle(title) +``` + +"The template of the message's title." + +## obj spec.receivers.discordConfigs.apiURL + +"The secret's key that contains the Discord webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.discordConfigs.apiURL.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.apiURL.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.apiURL.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.discordConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.discordConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.discordConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.discordConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.discordConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.discordConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.discordConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.discordConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.discordConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.discordConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.discordConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.emailConfigs + +"List of Email configurations." + +### fn spec.receivers.emailConfigs.withAuthIdentity + +```ts +withAuthIdentity(authIdentity) +``` + +"The identity to use for authentication." + +### fn spec.receivers.emailConfigs.withAuthUsername + +```ts +withAuthUsername(authUsername) +``` + +"The username to use for authentication." + +### fn spec.receivers.emailConfigs.withFrom + +```ts +withFrom(from) +``` + +"The sender address." + +### fn spec.receivers.emailConfigs.withHeaders + +```ts +withHeaders(headers) +``` + +"Further headers email header key/value pairs. Overrides any headers\npreviously set by the notification implementation." + +### fn spec.receivers.emailConfigs.withHeadersMixin + +```ts +withHeadersMixin(headers) +``` + +"Further headers email header key/value pairs. Overrides any headers\npreviously set by the notification implementation." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.emailConfigs.withHello + +```ts +withHello(hello) +``` + +"The hostname to identify to the SMTP server." + +### fn spec.receivers.emailConfigs.withHtml + +```ts +withHtml(html) +``` + +"The HTML body of the email notification." + +### fn spec.receivers.emailConfigs.withRequireTLS + +```ts +withRequireTLS(requireTLS) +``` + +"The SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints." + +### fn spec.receivers.emailConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.emailConfigs.withSmarthost + +```ts +withSmarthost(smarthost) +``` + +"The SMTP host and port through which emails are sent. E.g. example.com:25" + +### fn spec.receivers.emailConfigs.withText + +```ts +withText(text) +``` + +"The text body of the email notification." + +### fn spec.receivers.emailConfigs.withTo + +```ts +withTo(to) +``` + +"The email address to send notifications to." + +## obj spec.receivers.emailConfigs.authPassword + +"The secret's key that contains the password to use for authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.emailConfigs.authPassword.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.emailConfigs.authPassword.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.emailConfigs.authPassword.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.emailConfigs.authSecret + +"The secret's key that contains the CRAM-MD5 secret.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.emailConfigs.authSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.emailConfigs.authSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.emailConfigs.authSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.emailConfigs.headers + +"Further headers email header key/value pairs. Overrides any headers\npreviously set by the notification implementation." + +### fn spec.receivers.emailConfigs.headers.withKey + +```ts +withKey(key) +``` + +"Key of the tuple." + +### fn spec.receivers.emailConfigs.headers.withValue + +```ts +withValue(value) +``` + +"Value of the tuple." + +## obj spec.receivers.emailConfigs.tlsConfig + +"TLS configuration" + +### fn spec.receivers.emailConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.emailConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.emailConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.emailConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.emailConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.emailConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.emailConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.emailConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.emailConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.emailConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.emailConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.emailConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.emailConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.emailConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.emailConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.emailConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.emailConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.emailConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.emailConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.emailConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.emailConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.emailConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.emailConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.emailConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.emailConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.emailConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs + +"List of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0." + +### fn spec.receivers.msteamsConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether to notify about resolved alerts." + +### fn spec.receivers.msteamsConfigs.withSummary + +```ts +withSummary(summary) +``` + +"Message summary template.\nIt requires Alertmanager >= 0.27.0." + +### fn spec.receivers.msteamsConfigs.withText + +```ts +withText(text) +``` + +"Message body template." + +### fn spec.receivers.msteamsConfigs.withTitle + +```ts +withTitle(title) +``` + +"Message title template." + +## obj spec.receivers.msteamsConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.msteamsConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.msteamsConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.msteamsConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.msteamsConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.msteamsConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.msteamsConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.msteamsConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.msteamsConfigs.webhookUrl + +"MSTeams webhook URL." + +### fn spec.receivers.msteamsConfigs.webhookUrl.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.msteamsConfigs.webhookUrl.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.msteamsConfigs.webhookUrl.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs + +"List of OpsGenie configurations." + +### fn spec.receivers.opsgenieConfigs.withActions + +```ts +withActions(actions) +``` + +"Comma separated list of actions that will be available for the alert." + +### fn spec.receivers.opsgenieConfigs.withApiURL + +```ts +withApiURL(apiURL) +``` + +"The URL to send OpsGenie API requests to." + +### fn spec.receivers.opsgenieConfigs.withDescription + +```ts +withDescription(description) +``` + +"Description of the incident." + +### fn spec.receivers.opsgenieConfigs.withDetails + +```ts +withDetails(details) +``` + +"A set of arbitrary key/value pairs that provide further detail about the incident." + +### fn spec.receivers.opsgenieConfigs.withDetailsMixin + +```ts +withDetailsMixin(details) +``` + +"A set of arbitrary key/value pairs that provide further detail about the incident." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.opsgenieConfigs.withEntity + +```ts +withEntity(entity) +``` + +"Optional field that can be used to specify which domain alert is related to." + +### fn spec.receivers.opsgenieConfigs.withMessage + +```ts +withMessage(message) +``` + +"Alert text limited to 130 characters." + +### fn spec.receivers.opsgenieConfigs.withNote + +```ts +withNote(note) +``` + +"Additional alert note." + +### fn spec.receivers.opsgenieConfigs.withPriority + +```ts +withPriority(priority) +``` + +"Priority level of alert. Possible values are P1, P2, P3, P4, and P5." + +### fn spec.receivers.opsgenieConfigs.withResponders + +```ts +withResponders(responders) +``` + +"List of responders responsible for notifications." + +### fn spec.receivers.opsgenieConfigs.withRespondersMixin + +```ts +withRespondersMixin(responders) +``` + +"List of responders responsible for notifications." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.opsgenieConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.opsgenieConfigs.withSource + +```ts +withSource(source) +``` + +"Backlink to the sender of the notification." + +### fn spec.receivers.opsgenieConfigs.withTags + +```ts +withTags(tags) +``` + +"Comma separated list of tags attached to the notifications." + +### fn spec.receivers.opsgenieConfigs.withUpdateAlerts + +```ts +withUpdateAlerts(updateAlerts) +``` + +"Whether to update message and description of the alert in OpsGenie if it already exists\nBy default, the alert is never updated in OpsGenie, the new message only appears in activity log." + +## obj spec.receivers.opsgenieConfigs.apiKey + +"The secret's key that contains the OpsGenie API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.opsgenieConfigs.apiKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.apiKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.apiKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.details + +"A set of arbitrary key/value pairs that provide further detail about the incident." + +### fn spec.receivers.opsgenieConfigs.details.withKey + +```ts +withKey(key) +``` + +"Key of the tuple." + +### fn spec.receivers.opsgenieConfigs.details.withValue + +```ts +withValue(value) +``` + +"Value of the tuple." + +## obj spec.receivers.opsgenieConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.opsgenieConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.opsgenieConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.opsgenieConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.opsgenieConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.opsgenieConfigs.responders + +"List of responders responsible for notifications." + +### fn spec.receivers.opsgenieConfigs.responders.withId + +```ts +withId(id) +``` + +"ID of the responder." + +### fn spec.receivers.opsgenieConfigs.responders.withName + +```ts +withName(name) +``` + +"Name of the responder." + +### fn spec.receivers.opsgenieConfigs.responders.withType + +```ts +withType(type) +``` + +"Type of responder." + +### fn spec.receivers.opsgenieConfigs.responders.withUsername + +```ts +withUsername(username) +``` + +"Username of the responder." + +## obj spec.receivers.pagerdutyConfigs + +"List of PagerDuty configurations." + +### fn spec.receivers.pagerdutyConfigs.withClass + +```ts +withClass(class) +``` + +"The class/type of the event." + +### fn spec.receivers.pagerdutyConfigs.withClient + +```ts +withClient(client) +``` + +"Client identification." + +### fn spec.receivers.pagerdutyConfigs.withClientURL + +```ts +withClientURL(clientURL) +``` + +"Backlink to the sender of notification." + +### fn spec.receivers.pagerdutyConfigs.withComponent + +```ts +withComponent(component) +``` + +"The part or component of the affected system that is broken." + +### fn spec.receivers.pagerdutyConfigs.withDescription + +```ts +withDescription(description) +``` + +"Description of the incident." + +### fn spec.receivers.pagerdutyConfigs.withDetails + +```ts +withDetails(details) +``` + +"Arbitrary key/value pairs that provide further detail about the incident." + +### fn spec.receivers.pagerdutyConfigs.withDetailsMixin + +```ts +withDetailsMixin(details) +``` + +"Arbitrary key/value pairs that provide further detail about the incident." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.pagerdutyConfigs.withGroup + +```ts +withGroup(group) +``` + +"A cluster or grouping of sources." + +### fn spec.receivers.pagerdutyConfigs.withPagerDutyImageConfigs + +```ts +withPagerDutyImageConfigs(pagerDutyImageConfigs) +``` + +"A list of image details to attach that provide further detail about an incident." + +### fn spec.receivers.pagerdutyConfigs.withPagerDutyImageConfigsMixin + +```ts +withPagerDutyImageConfigsMixin(pagerDutyImageConfigs) +``` + +"A list of image details to attach that provide further detail about an incident." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.pagerdutyConfigs.withPagerDutyLinkConfigs + +```ts +withPagerDutyLinkConfigs(pagerDutyLinkConfigs) +``` + +"A list of link details to attach that provide further detail about an incident." + +### fn spec.receivers.pagerdutyConfigs.withPagerDutyLinkConfigsMixin + +```ts +withPagerDutyLinkConfigsMixin(pagerDutyLinkConfigs) +``` + +"A list of link details to attach that provide further detail about an incident." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.pagerdutyConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.pagerdutyConfigs.withSeverity + +```ts +withSeverity(severity) +``` + +"Severity of the incident." + +### fn spec.receivers.pagerdutyConfigs.withSource + +```ts +withSource(source) +``` + +"Unique location of the affected system." + +### fn spec.receivers.pagerdutyConfigs.withUrl + +```ts +withUrl(url) +``` + +"The URL to send requests to." + +## obj spec.receivers.pagerdutyConfigs.details + +"Arbitrary key/value pairs that provide further detail about the incident." + +### fn spec.receivers.pagerdutyConfigs.details.withKey + +```ts +withKey(key) +``` + +"Key of the tuple." + +### fn spec.receivers.pagerdutyConfigs.details.withValue + +```ts +withValue(value) +``` + +"Value of the tuple." + +## obj spec.receivers.pagerdutyConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs + +"A list of image details to attach that provide further detail about an incident." + +### fn spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs.withAlt + +```ts +withAlt(alt) +``` + +"Alt is the optional alternative text for the image." + +### fn spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs.withHref + +```ts +withHref(href) +``` + +"Optional URL; makes the image a clickable link." + +### fn spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs.withSrc + +```ts +withSrc(src) +``` + +"Src of the image being attached to the incident" + +## obj spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs + +"A list of link details to attach that provide further detail about an incident." + +### fn spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs.withAlt + +```ts +withAlt(alt) +``` + +"Text that describes the purpose of the link, and can be used as the link's text." + +### fn spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs.withHref + +```ts +withHref(href) +``` + +"Href is the URL of the link to be attached" + +## obj spec.receivers.pagerdutyConfigs.routingKey + +"The secret's key that contains the PagerDuty integration key (when using\nEvents API v2). Either this field or `serviceKey` needs to be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.pagerdutyConfigs.routingKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.routingKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.routingKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pagerdutyConfigs.serviceKey + +"The secret's key that contains the PagerDuty service key (when using\nintegration type \"Prometheus\"). Either this field or `routingKey` needs to\nbe defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.pagerdutyConfigs.serviceKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pagerdutyConfigs.serviceKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pagerdutyConfigs.serviceKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs + +"List of Pushover configurations." + +### fn spec.receivers.pushoverConfigs.withDevice + +```ts +withDevice(device) +``` + +"The name of a device to send the notification to" + +### fn spec.receivers.pushoverConfigs.withExpire + +```ts +withExpire(expire) +``` + +"How long your notification will continue to be retried for, unless the user\nacknowledges the notification." + +### fn spec.receivers.pushoverConfigs.withHtml + +```ts +withHtml(html) +``` + +"Whether notification message is HTML or plain text." + +### fn spec.receivers.pushoverConfigs.withMessage + +```ts +withMessage(message) +``` + +"Notification message." + +### fn spec.receivers.pushoverConfigs.withPriority + +```ts +withPriority(priority) +``` + +"Priority, see https://pushover.net/api#priority" + +### fn spec.receivers.pushoverConfigs.withRetry + +```ts +withRetry(retry) +``` + +"How often the Pushover servers will send the same notification to the user.\nMust be at least 30 seconds." + +### fn spec.receivers.pushoverConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.pushoverConfigs.withSound + +```ts +withSound(sound) +``` + +"The name of one of the sounds supported by device clients to override the user's default sound choice" + +### fn spec.receivers.pushoverConfigs.withTitle + +```ts +withTitle(title) +``` + +"Notification title." + +### fn spec.receivers.pushoverConfigs.withTokenFile + +```ts +withTokenFile(tokenFile) +``` + +"The token file that contains the registered application's API token, see https://pushover.net/apps.\nEither `token` or `tokenFile` is required.\nIt requires Alertmanager >= v0.26.0." + +### fn spec.receivers.pushoverConfigs.withTtl + +```ts +withTtl(ttl) +``` + +"The time to live definition for the alert notification" + +### fn spec.receivers.pushoverConfigs.withUrl + +```ts +withUrl(url) +``` + +"A supplementary URL shown alongside the message." + +### fn spec.receivers.pushoverConfigs.withUrlTitle + +```ts +withUrlTitle(urlTitle) +``` + +"A title for supplementary URL, otherwise just the URL is shown" + +### fn spec.receivers.pushoverConfigs.withUserKeyFile + +```ts +withUserKeyFile(userKeyFile) +``` + +"The user key file that contains the recipient user's user key.\nEither `userKey` or `userKeyFile` is required.\nIt requires Alertmanager >= v0.26.0." + +## obj spec.receivers.pushoverConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.pushoverConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.pushoverConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.pushoverConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.pushoverConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.pushoverConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.pushoverConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.pushoverConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.token + +"The secret's key that contains the registered application's API token, see https://pushover.net/apps.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `token` or `tokenFile` is required." + +### fn spec.receivers.pushoverConfigs.token.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.token.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.token.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.pushoverConfigs.userKey + +"The secret's key that contains the recipient user's user key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `userKey` or `userKeyFile` is required." + +### fn spec.receivers.pushoverConfigs.userKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.pushoverConfigs.userKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.pushoverConfigs.userKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs + +"List of Slack configurations." + +### fn spec.receivers.slackConfigs.withActions + +```ts +withActions(actions) +``` + +"A list of Slack actions that are sent with each notification." + +### fn spec.receivers.slackConfigs.withActionsMixin + +```ts +withActionsMixin(actions) +``` + +"A list of Slack actions that are sent with each notification." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.slackConfigs.withCallbackId + +```ts +withCallbackId(callbackId) +``` + + + +### fn spec.receivers.slackConfigs.withChannel + +```ts +withChannel(channel) +``` + +"The channel or user to send notifications to." + +### fn spec.receivers.slackConfigs.withColor + +```ts +withColor(color) +``` + + + +### fn spec.receivers.slackConfigs.withFallback + +```ts +withFallback(fallback) +``` + + + +### fn spec.receivers.slackConfigs.withFields + +```ts +withFields(fields) +``` + +"A list of Slack fields that are sent with each notification." + +### fn spec.receivers.slackConfigs.withFieldsMixin + +```ts +withFieldsMixin(fields) +``` + +"A list of Slack fields that are sent with each notification." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.slackConfigs.withFooter + +```ts +withFooter(footer) +``` + + + +### fn spec.receivers.slackConfigs.withIconEmoji + +```ts +withIconEmoji(iconEmoji) +``` + + + +### fn spec.receivers.slackConfigs.withIconURL + +```ts +withIconURL(iconURL) +``` + + + +### fn spec.receivers.slackConfigs.withImageURL + +```ts +withImageURL(imageURL) +``` + + + +### fn spec.receivers.slackConfigs.withLinkNames + +```ts +withLinkNames(linkNames) +``` + + + +### fn spec.receivers.slackConfigs.withMrkdwnIn + +```ts +withMrkdwnIn(mrkdwnIn) +``` + + + +### fn spec.receivers.slackConfigs.withMrkdwnInMixin + +```ts +withMrkdwnInMixin(mrkdwnIn) +``` + + + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.slackConfigs.withPretext + +```ts +withPretext(pretext) +``` + + + +### fn spec.receivers.slackConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.slackConfigs.withShortFields + +```ts +withShortFields(shortFields) +``` + + + +### fn spec.receivers.slackConfigs.withText + +```ts +withText(text) +``` + + + +### fn spec.receivers.slackConfigs.withThumbURL + +```ts +withThumbURL(thumbURL) +``` + + + +### fn spec.receivers.slackConfigs.withTitle + +```ts +withTitle(title) +``` + + + +### fn spec.receivers.slackConfigs.withTitleLink + +```ts +withTitleLink(titleLink) +``` + + + +### fn spec.receivers.slackConfigs.withUsername + +```ts +withUsername(username) +``` + + + +## obj spec.receivers.slackConfigs.actions + +"A list of Slack actions that are sent with each notification." + +### fn spec.receivers.slackConfigs.actions.withName + +```ts +withName(name) +``` + + + +### fn spec.receivers.slackConfigs.actions.withStyle + +```ts +withStyle(style) +``` + + + +### fn spec.receivers.slackConfigs.actions.withText + +```ts +withText(text) +``` + + + +### fn spec.receivers.slackConfigs.actions.withType + +```ts +withType(type) +``` + + + +### fn spec.receivers.slackConfigs.actions.withUrl + +```ts +withUrl(url) +``` + + + +### fn spec.receivers.slackConfigs.actions.withValue + +```ts +withValue(value) +``` + + + +## obj spec.receivers.slackConfigs.actions.confirm + +"SlackConfirmationField protect users from destructive actions or\nparticularly distinguished decisions by asking them to confirm their button\nclick one more time.\nSee https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields\nfor more information." + +### fn spec.receivers.slackConfigs.actions.confirm.withDismissText + +```ts +withDismissText(dismissText) +``` + + + +### fn spec.receivers.slackConfigs.actions.confirm.withOkText + +```ts +withOkText(okText) +``` + + + +### fn spec.receivers.slackConfigs.actions.confirm.withText + +```ts +withText(text) +``` + + + +### fn spec.receivers.slackConfigs.actions.confirm.withTitle + +```ts +withTitle(title) +``` + + + +## obj spec.receivers.slackConfigs.apiURL + +"The secret's key that contains the Slack webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.slackConfigs.apiURL.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.apiURL.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.apiURL.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.fields + +"A list of Slack fields that are sent with each notification." + +### fn spec.receivers.slackConfigs.fields.withShort + +```ts +withShort(short) +``` + + + +### fn spec.receivers.slackConfigs.fields.withTitle + +```ts +withTitle(title) +``` + + + +### fn spec.receivers.slackConfigs.fields.withValue + +```ts +withValue(value) +``` + + + +## obj spec.receivers.slackConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.slackConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.slackConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.slackConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.slackConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.slackConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.slackConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.slackConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.slackConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.slackConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs + +"List of SNS configurations" + +### fn spec.receivers.snsConfigs.withApiURL + +```ts +withApiURL(apiURL) +``` + +"The SNS API URL i.e. https://sns.us-east-2.amazonaws.com.\nIf not specified, the SNS API URL from the SNS SDK will be used." + +### fn spec.receivers.snsConfigs.withAttributes + +```ts +withAttributes(attributes) +``` + +"SNS message attributes." + +### fn spec.receivers.snsConfigs.withAttributesMixin + +```ts +withAttributesMixin(attributes) +``` + +"SNS message attributes." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.snsConfigs.withMessage + +```ts +withMessage(message) +``` + +"The message content of the SNS notification." + +### fn spec.receivers.snsConfigs.withPhoneNumber + +```ts +withPhoneNumber(phoneNumber) +``` + +"Phone number if message is delivered via SMS in E.164 format.\nIf you don't specify this value, you must specify a value for the TopicARN or TargetARN." + +### fn spec.receivers.snsConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.snsConfigs.withSubject + +```ts +withSubject(subject) +``` + +"Subject line when the message is delivered to email endpoints." + +### fn spec.receivers.snsConfigs.withTargetARN + +```ts +withTargetARN(targetARN) +``` + +"The mobile platform endpoint ARN if message is delivered via mobile notifications.\nIf you don't specify this value, you must specify a value for the topic_arn or PhoneNumber." + +### fn spec.receivers.snsConfigs.withTopicARN + +```ts +withTopicARN(topicARN) +``` + +"SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic\nIf you don't specify this value, you must specify a value for the PhoneNumber or TargetARN." + +## obj spec.receivers.snsConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.snsConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.snsConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.snsConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.snsConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.snsConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.snsConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.snsConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.snsConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.snsConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.sigv4 + +"Configures AWS's Signature Verification 4 signing process to sign requests." + +### fn spec.receivers.snsConfigs.sigv4.withProfile + +```ts +withProfile(profile) +``` + +"Profile is the named AWS profile used to authenticate." + +### fn spec.receivers.snsConfigs.sigv4.withRegion + +```ts +withRegion(region) +``` + +"Region is the AWS region. If blank, the region from the default credentials chain used." + +### fn spec.receivers.snsConfigs.sigv4.withRoleArn + +```ts +withRoleArn(roleArn) +``` + +"RoleArn is the named AWS profile used to authenticate." + +## obj spec.receivers.snsConfigs.sigv4.accessKey + +"AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used." + +### fn spec.receivers.snsConfigs.sigv4.accessKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.sigv4.accessKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.sigv4.accessKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.snsConfigs.sigv4.secretKey + +"SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used." + +### fn spec.receivers.snsConfigs.sigv4.secretKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.snsConfigs.sigv4.secretKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.snsConfigs.sigv4.secretKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs + +"List of Telegram configurations." + +### fn spec.receivers.telegramConfigs.withApiURL + +```ts +withApiURL(apiURL) +``` + +"The Telegram API URL i.e. https://api.telegram.org.\nIf not specified, default API URL will be used." + +### fn spec.receivers.telegramConfigs.withBotTokenFile + +```ts +withBotTokenFile(botTokenFile) +``` + +"File to read the Telegram bot token from. It is mutually exclusive with `botToken`.\nEither `botToken` or `botTokenFile` is required.\n\n\nIt requires Alertmanager >= v0.26.0." + +### fn spec.receivers.telegramConfigs.withChatID + +```ts +withChatID(chatID) +``` + +"The Telegram chat ID." + +### fn spec.receivers.telegramConfigs.withDisableNotifications + +```ts +withDisableNotifications(disableNotifications) +``` + +"Disable telegram notifications" + +### fn spec.receivers.telegramConfigs.withMessage + +```ts +withMessage(message) +``` + +"Message template" + +### fn spec.receivers.telegramConfigs.withParseMode + +```ts +withParseMode(parseMode) +``` + +"Parse mode for telegram message" + +### fn spec.receivers.telegramConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether to notify about resolved alerts." + +## obj spec.receivers.telegramConfigs.botToken + +"Telegram bot token. It is mutually exclusive with `botTokenFile`.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\n\n\nEither `botToken` or `botTokenFile` is required." + +### fn spec.receivers.telegramConfigs.botToken.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.botToken.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.botToken.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.telegramConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.telegramConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.telegramConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.telegramConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.telegramConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.telegramConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.telegramConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.telegramConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.telegramConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs + +"List of VictorOps configurations." + +### fn spec.receivers.victoropsConfigs.withApiUrl + +```ts +withApiUrl(apiUrl) +``` + +"The VictorOps API URL." + +### fn spec.receivers.victoropsConfigs.withCustomFields + +```ts +withCustomFields(customFields) +``` + +"Additional custom fields for notification." + +### fn spec.receivers.victoropsConfigs.withCustomFieldsMixin + +```ts +withCustomFieldsMixin(customFields) +``` + +"Additional custom fields for notification." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.victoropsConfigs.withEntityDisplayName + +```ts +withEntityDisplayName(entityDisplayName) +``` + +"Contains summary of the alerted problem." + +### fn spec.receivers.victoropsConfigs.withMessageType + +```ts +withMessageType(messageType) +``` + +"Describes the behavior of the alert (CRITICAL, WARNING, INFO)." + +### fn spec.receivers.victoropsConfigs.withMonitoringTool + +```ts +withMonitoringTool(monitoringTool) +``` + +"The monitoring tool the state message is from." + +### fn spec.receivers.victoropsConfigs.withRoutingKey + +```ts +withRoutingKey(routingKey) +``` + +"A key used to map the alert to a team." + +### fn spec.receivers.victoropsConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.victoropsConfigs.withStateMessage + +```ts +withStateMessage(stateMessage) +``` + +"Contains long explanation of the alerted problem." + +## obj spec.receivers.victoropsConfigs.apiKey + +"The secret's key that contains the API key to use when talking to the VictorOps API.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.victoropsConfigs.apiKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.apiKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.apiKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.customFields + +"Additional custom fields for notification." + +### fn spec.receivers.victoropsConfigs.customFields.withKey + +```ts +withKey(key) +``` + +"Key of the tuple." + +### fn spec.receivers.victoropsConfigs.customFields.withValue + +```ts +withValue(value) +``` + +"Value of the tuple." + +## obj spec.receivers.victoropsConfigs.httpConfig + +"The HTTP client's configuration." + +### fn spec.receivers.victoropsConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.victoropsConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.victoropsConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.victoropsConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.victoropsConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.victoropsConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.victoropsConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs + +"List of Webex configurations." + +### fn spec.receivers.webexConfigs.withApiURL + +```ts +withApiURL(apiURL) +``` + +"The Webex Teams API URL i.e. https://webexapis.com/v1/messages\nProvide if different from the default API URL." + +### fn spec.receivers.webexConfigs.withMessage + +```ts +withMessage(message) +``` + +"Message template" + +### fn spec.receivers.webexConfigs.withRoomID + +```ts +withRoomID(roomID) +``` + +"ID of the Webex Teams room where to send the messages." + +### fn spec.receivers.webexConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether to notify about resolved alerts." + +## obj spec.receivers.webexConfigs.httpConfig + +"The HTTP client's configuration.\nYou must supply the bot token via the `httpConfig.authorization` field." + +### fn spec.receivers.webexConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.webexConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.webexConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.webexConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.webexConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.webexConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.webexConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.webexConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.webexConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.webexConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.webexConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs + +"List of webhook configurations." + +### fn spec.receivers.webhookConfigs.withMaxAlerts + +```ts +withMaxAlerts(maxAlerts) +``` + +"Maximum number of alerts to be sent per webhook message. When 0, all alerts are included." + +### fn spec.receivers.webhookConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.webhookConfigs.withUrl + +```ts +withUrl(url) +``` + +"The URL to send HTTP POST requests to. `urlSecret` takes precedence over\n`url`. One of `urlSecret` and `url` should be defined." + +## obj spec.receivers.webhookConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.webhookConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.webhookConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.webhookConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.webhookConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.webhookConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.webhookConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.webhookConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.webhookConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.webhookConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.webhookConfigs.urlSecret + +"The secret's key that contains the webhook URL to send HTTP requests to.\n`urlSecret` takes precedence over `url`. One of `urlSecret` and `url`\nshould be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.webhookConfigs.urlSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.webhookConfigs.urlSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.webhookConfigs.urlSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs + +"List of WeChat configurations." + +### fn spec.receivers.wechatConfigs.withAgentID + +```ts +withAgentID(agentID) +``` + + + +### fn spec.receivers.wechatConfigs.withApiURL + +```ts +withApiURL(apiURL) +``` + +"The WeChat API URL." + +### fn spec.receivers.wechatConfigs.withCorpID + +```ts +withCorpID(corpID) +``` + +"The corp id for authentication." + +### fn spec.receivers.wechatConfigs.withMessage + +```ts +withMessage(message) +``` + +"API request data as defined by the WeChat API." + +### fn spec.receivers.wechatConfigs.withMessageType + +```ts +withMessageType(messageType) +``` + + + +### fn spec.receivers.wechatConfigs.withSendResolved + +```ts +withSendResolved(sendResolved) +``` + +"Whether or not to notify about resolved alerts." + +### fn spec.receivers.wechatConfigs.withToParty + +```ts +withToParty(toParty) +``` + + + +### fn spec.receivers.wechatConfigs.withToTag + +```ts +withToTag(toTag) +``` + + + +### fn spec.receivers.wechatConfigs.withToUser + +```ts +withToUser(toUser) +``` + + + +## obj spec.receivers.wechatConfigs.apiSecret + +"The secret's key that contains the WeChat API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.wechatConfigs.apiSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.apiSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.apiSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig + +"HTTP client configuration." + +### fn spec.receivers.wechatConfigs.httpConfig.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"FollowRedirects specifies whether the client should follow HTTP 3xx redirects." + +### fn spec.receivers.wechatConfigs.httpConfig.withProxyURL + +```ts +withProxyURL(proxyURL) +``` + +"Optional proxy URL." + +## obj spec.receivers.wechatConfigs.httpConfig.authorization + +"Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+." + +### fn spec.receivers.wechatConfigs.httpConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.receivers.wechatConfigs.httpConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.receivers.wechatConfigs.httpConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.basicAuth + +"BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence." + +## obj spec.receivers.wechatConfigs.httpConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.receivers.wechatConfigs.httpConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.receivers.wechatConfigs.httpConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret + +"The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator." + +### fn spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.tlsConfig + +"TLS configuration for the client." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.route + +"The Alertmanager route definition for alerts matching the resource's\nnamespace. If present, it will be added to the generated Alertmanager\nconfiguration as a first-level route." + +### fn spec.route.withActiveTimeIntervals + +```ts +withActiveTimeIntervals(activeTimeIntervals) +``` + +"ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active." + +### fn spec.route.withActiveTimeIntervalsMixin + +```ts +withActiveTimeIntervalsMixin(activeTimeIntervals) +``` + +"ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active." + +**Note:** This function appends passed data to existing values + +### fn spec.route.withContinue + +```ts +withContinue(continue) +``` + +"Boolean indicating whether an alert should continue matching subsequent\nsibling nodes. It will always be overridden to true for the first-level\nroute by the Prometheus operator." + +### fn spec.route.withGroupBy + +```ts +withGroupBy(groupBy) +``` + +"List of labels to group by.\nLabels must not be repeated (unique list).\nSpecial label \"...\" (aggregate by all possible labels), if provided, must be the only element in the list." + +### fn spec.route.withGroupByMixin + +```ts +withGroupByMixin(groupBy) +``` + +"List of labels to group by.\nLabels must not be repeated (unique list).\nSpecial label \"...\" (aggregate by all possible labels), if provided, must be the only element in the list." + +**Note:** This function appends passed data to existing values + +### fn spec.route.withGroupInterval + +```ts +withGroupInterval(groupInterval) +``` + +"How long to wait before sending an updated notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: \"5m\ + +### fn spec.route.withGroupWait + +```ts +withGroupWait(groupWait) +``` + +"How long to wait before sending the initial notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: \"30s\ + +### fn spec.route.withMatchers + +```ts +withMatchers(matchers) +``` + +"List of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the `namespace` label and adds a `namespace: ` matcher." + +### fn spec.route.withMatchersMixin + +```ts +withMatchersMixin(matchers) +``` + +"List of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the `namespace` label and adds a `namespace: ` matcher." + +**Note:** This function appends passed data to existing values + +### fn spec.route.withMuteTimeIntervals + +```ts +withMuteTimeIntervals(muteTimeIntervals) +``` + +"Note: this comment applies to the field definition above but appears\nbelow otherwise it gets included in the generated manifest.\nCRD schema doesn't support self-referential types for now (see\nhttps://github.com/kubernetes/kubernetes/issues/62872). We have to use\nan alternative type to circumvent the limitation. The downside is that\nthe Kube API can't validate the data beyond the fact that it is a valid\nJSON representation.\nMuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched," + +### fn spec.route.withMuteTimeIntervalsMixin + +```ts +withMuteTimeIntervalsMixin(muteTimeIntervals) +``` + +"Note: this comment applies to the field definition above but appears\nbelow otherwise it gets included in the generated manifest.\nCRD schema doesn't support self-referential types for now (see\nhttps://github.com/kubernetes/kubernetes/issues/62872). We have to use\nan alternative type to circumvent the limitation. The downside is that\nthe Kube API can't validate the data beyond the fact that it is a valid\nJSON representation.\nMuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched," + +**Note:** This function appends passed data to existing values + +### fn spec.route.withReceiver + +```ts +withReceiver(receiver) +``` + +"Name of the receiver for this route. If not empty, it should be listed in\nthe `receivers` field." + +### fn spec.route.withRepeatInterval + +```ts +withRepeatInterval(repeatInterval) +``` + +"How long to wait before repeating the last notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: \"4h\ + +### fn spec.route.withRoutes + +```ts +withRoutes(routes) +``` + +"Child routes." + +### fn spec.route.withRoutesMixin + +```ts +withRoutesMixin(routes) +``` + +"Child routes." + +**Note:** This function appends passed data to existing values + +## obj spec.route.matchers + +"List of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the `namespace` label and adds a `namespace: ` matcher." + +### fn spec.route.matchers.withMatchType + +```ts +withMatchType(matchType) +``` + +"Match operation available with AlertManager >= v0.22.0 and\ntakes precedence over Regex (deprecated) if non-empty." + +### fn spec.route.matchers.withName + +```ts +withName(name) +``` + +"Label to match." + +### fn spec.route.matchers.withRegex + +```ts +withRegex(regex) +``` + +"Whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead." + +### fn spec.route.matchers.withValue + +```ts +withValue(value) +``` + +"Label value to match." \ No newline at end of file diff --git a/docs/0.14/monitoring/v1alpha1/endpoint.md b/docs/0.14/monitoring/v1alpha1/endpoint.md new file mode 100644 index 0000000..38ed201 --- /dev/null +++ b/docs/0.14/monitoring/v1alpha1/endpoint.md @@ -0,0 +1,629 @@ +--- +permalink: /0.14/monitoring/v1alpha1/endpoint/ +--- + +# monitoring.v1alpha1.endpoint + +Endpoint is a helper to create endpoint configurations in ServiceMonitors. An endpoint defines a scrapeable endpoint serving Prometheus metrics. + +## Index + +* [`fn withBearerTokenFile(path)`](#fn-withbearertokenfile) +* [`fn withHonorLabels(honor_labels)`](#fn-withhonorlabels) +* [`fn withHonorTimestamps(honor_timestamps)`](#fn-withhonortimestamps) +* [`fn withInterval(interval)`](#fn-withinterval) +* [`fn withMetricRelabelings(relabelings)`](#fn-withmetricrelabelings) +* [`fn withParams(params)`](#fn-withparams) +* [`fn withPath(path)`](#fn-withpath) +* [`fn withPort(port)`](#fn-withport) +* [`fn withProxyUrl(url)`](#fn-withproxyurl) +* [`fn withRelabelings(relabelings)`](#fn-withrelabelings) +* [`fn withScheme(scheme)`](#fn-withscheme) +* [`fn withScrapeTimeout(timeout)`](#fn-withscrapetimeout) +* [`fn withTargetPort(port)`](#fn-withtargetport) +* [`obj authorization`](#obj-authorization) + * [`fn withType(type)`](#fn-authorizationwithtype) + * [`obj authorization.credentials`](#obj-authorizationcredentials) + * [`fn withKey(key)`](#fn-authorizationcredentialswithkey) + * [`fn withName(name)`](#fn-authorizationcredentialswithname) + * [`fn withOptional(is_optional)`](#fn-authorizationcredentialswithoptional) +* [`obj basicAuth`](#obj-basicauth) + * [`obj basicAuth.password`](#obj-basicauthpassword) + * [`fn withKey(key)`](#fn-basicauthpasswordwithkey) + * [`fn withName(name)`](#fn-basicauthpasswordwithname) + * [`fn withOptional(is_optional)`](#fn-basicauthpasswordwithoptional) + * [`obj basicAuth.username`](#obj-basicauthusername) + * [`fn withKey(key)`](#fn-basicauthusernamewithkey) + * [`fn withName(name)`](#fn-basicauthusernamewithname) + * [`fn withOptional(is_optional)`](#fn-basicauthusernamewithoptional) +* [`obj bearerTokenSecret`](#obj-bearertokensecret) + * [`fn withKey(key)`](#fn-bearertokensecretwithkey) + * [`fn withName(name)`](#fn-bearertokensecretwithname) + * [`fn withOptional(is_optional)`](#fn-bearertokensecretwithoptional) +* [`obj oauth2`](#obj-oauth2) + * [`fn withEndpointParams(params)`](#fn-oauth2withendpointparams) + * [`fn withScopes(scopes)`](#fn-oauth2withscopes) + * [`fn withTokenUrl(url)`](#fn-oauth2withtokenurl) + * [`obj oauth2.clientId`](#obj-oauth2clientid) + * [`obj oauth2.clientId.configMap`](#obj-oauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-oauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-oauth2clientidconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientidconfigmapwithoptional) + * [`obj oauth2.clientId.secret`](#obj-oauth2clientidsecret) + * [`fn withKey(key)`](#fn-oauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-oauth2clientidsecretwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientidsecretwithoptional) + * [`obj oauth2.clientSecret`](#obj-oauth2clientsecret) + * [`fn withKey(key)`](#fn-oauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-oauth2clientsecretwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientsecretwithoptional) +* [`obj tlsConfig`](#obj-tlsconfig) + * [`fn withCaFile(path)`](#fn-tlsconfigwithcafile) + * [`fn withCertFile(path)`](#fn-tlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(skip_verify)`](#fn-tlsconfigwithinsecureskipverify) + * [`fn withKeyFile(path)`](#fn-tlsconfigwithkeyfile) + * [`fn withServerName(name)`](#fn-tlsconfigwithservername) + * [`obj tlsConfig.ca`](#obj-tlsconfigca) + * [`obj tlsConfig.ca.configMap`](#obj-tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-tlsconfigcaconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcaconfigmapwithoptional) + * [`obj tlsConfig.ca.secret`](#obj-tlsconfigcasecret) + * [`fn withKey(key)`](#fn-tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigcasecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcasecretwithoptional) + * [`obj tlsConfig.cert`](#obj-tlsconfigcert) + * [`obj tlsConfig.cert.configMap`](#obj-tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-tlsconfigcertconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcertconfigmapwithoptional) + * [`obj tlsConfig.cert.secret`](#obj-tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigcertsecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcertsecretwithoptional) + * [`obj tlsConfig.keySecret`](#obj-tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigkeysecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigkeysecretwithoptional) + +## Fields + +### fn withBearerTokenFile + +```ts +withBearerTokenFile(path) +``` + +File to read bearer token for scraping targets. + +### fn withHonorLabels + +```ts +withHonorLabels(honor_labels) +``` + +HonorLabels chooses the metric’s labels on collisions with target labels. + +### fn withHonorTimestamps + +```ts +withHonorTimestamps(honor_timestamps) +``` + +HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. + +### fn withInterval + +```ts +withInterval(interval) +``` + +Interval at which metrics should be scraped. + +### fn withMetricRelabelings + +```ts +withMetricRelabelings(relabelings) +``` + +MetricRelabelConfigs to apply to samples before ingestion. + +### fn withParams + +```ts +withParams(params) +``` + +Optional HTTP URL parameters. + +### fn withPath + +```ts +withPath(path) +``` + +HTTP path to scrape for metrics. + +### fn withPort + +```ts +withPort(port) +``` + +Name of the service port this endpoint refers to. Mutually exclusive with withTargetPort. + +### fn withProxyUrl + +```ts +withProxyUrl(url) +``` + +ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. + +### fn withRelabelings + +```ts +withRelabelings(relabelings) +``` + +RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config + +### fn withScheme + +```ts +withScheme(scheme) +``` + +HTTP scheme to use for scraping. + +### fn withScrapeTimeout + +```ts +withScrapeTimeout(timeout) +``` + +Timeout after which the scrape is ended. + +### fn withTargetPort + +```ts +withTargetPort(port) +``` + +Name or number of the target port of the Pod behind the Service, the port must be specified with container port property. Mutually exclusive with withPort. + +## obj authorization + +Authorization section for this endpoint + +### fn authorization.withType + +```ts +withType(type) +``` + +Set the authentication type. Defaults to Bearer, Basic will cause an error + +## obj authorization.credentials + +The secret's key that contains the credentials of the request + +### fn authorization.credentials.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn authorization.credentials.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn authorization.credentials.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj basicAuth + +BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints + +## obj basicAuth.password + +The secret in the service monitor namespace that contains the password for authentication. + +### fn basicAuth.password.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn basicAuth.password.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn basicAuth.password.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj basicAuth.username + +The secret in the service monitor namespace that contains the username for authentication. + +### fn basicAuth.username.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn basicAuth.username.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn basicAuth.username.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj bearerTokenSecret + +Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator. + +### fn bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn bearerTokenSecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn bearerTokenSecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj oauth2 + +OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + +### fn oauth2.withEndpointParams + +```ts +withEndpointParams(params) +``` + +Parameters to append to the token URL + +### fn oauth2.withScopes + +```ts +withScopes(scopes) +``` + +OAuth2 scopes used for the token request. + +### fn oauth2.withTokenUrl + +```ts +withTokenUrl(url) +``` + +The URL to fetch the token from. + +## obj oauth2.clientId + +The secret or configmap containing the OAuth2 client id. + +## obj oauth2.clientId.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientId.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj oauth2.clientId.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientId.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj oauth2.clientSecret + +The secret containing the OAuth2 client secret. + +### fn oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn oauth2.clientSecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientSecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig + +TLS configuration to use when scraping the endpoint + +### fn tlsConfig.withCaFile + +```ts +withCaFile(path) +``` + +Path to the CA cert in the Prometheus container to use for the targets. + +### fn tlsConfig.withCertFile + +```ts +withCertFile(path) +``` + +Path to the client cert file in the Prometheus container for the targets. + +### fn tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(skip_verify) +``` + +Disable target certificate validation. + +### fn tlsConfig.withKeyFile + +```ts +withKeyFile(path) +``` + +Path to the client key file in the Prometheus container for the targets. + +### fn tlsConfig.withServerName + +```ts +withServerName(name) +``` + +Used to verify the hostname for the targets. + +## obj tlsConfig.ca + +Struct containing the CA cert to use for the targets. + +## obj tlsConfig.ca.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.ca.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj tlsConfig.ca.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.ca.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig.cert + +Struct containing the client cert file for the targets. + +## obj tlsConfig.cert.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.cert.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj tlsConfig.cert.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.cert.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig.keySecret + +Secret containing the client key file for the targets. + +### fn tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.keySecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined \ No newline at end of file diff --git a/docs/0.14/monitoring/v1alpha1/index.md b/docs/0.14/monitoring/v1alpha1/index.md new file mode 100644 index 0000000..d382cac --- /dev/null +++ b/docs/0.14/monitoring/v1alpha1/index.md @@ -0,0 +1,14 @@ +--- +permalink: /0.14/monitoring/v1alpha1/ +--- + +# monitoring.v1alpha1 + + + +* [alertmanagerConfig](alertmanagerConfig.md) +* [endpoint](endpoint.md) +* [podMetricsEndpoint](podMetricsEndpoint.md) +* [prometheusAgent](prometheusAgent.md) +* [relabelConfig](relabelConfig.md) +* [scrapeConfig](scrapeConfig.md) \ No newline at end of file diff --git a/docs/0.14/monitoring/v1alpha1/podMetricsEndpoint.md b/docs/0.14/monitoring/v1alpha1/podMetricsEndpoint.md new file mode 100644 index 0000000..f4a531e --- /dev/null +++ b/docs/0.14/monitoring/v1alpha1/podMetricsEndpoint.md @@ -0,0 +1,602 @@ +--- +permalink: /0.14/monitoring/v1alpha1/podMetricsEndpoint/ +--- + +# monitoring.v1alpha1.podMetricsEndpoint + +PodMetricsEndpoint defines a scrapeable endpoint of a Kubernetes Pod serving Prometheus metrics. + +## Index + +* [`fn withBearerTokenFile(path)`](#fn-withbearertokenfile) +* [`fn withHonorLabels(honor_labels)`](#fn-withhonorlabels) +* [`fn withHonorTimestamps(honor_timestamps)`](#fn-withhonortimestamps) +* [`fn withInterval(interval)`](#fn-withinterval) +* [`fn withMetricRelabelings(relabelings)`](#fn-withmetricrelabelings) +* [`fn withParams(params)`](#fn-withparams) +* [`fn withPath(path)`](#fn-withpath) +* [`fn withPort(port)`](#fn-withport) +* [`fn withProxyUrl(url)`](#fn-withproxyurl) +* [`fn withRelabelings(relabelings)`](#fn-withrelabelings) +* [`fn withScheme(scheme)`](#fn-withscheme) +* [`fn withScrapeTimeout(timeout)`](#fn-withscrapetimeout) +* [`fn withTargetPort(port)`](#fn-withtargetport) +* [`obj authorization`](#obj-authorization) + * [`fn withType(type)`](#fn-authorizationwithtype) + * [`obj authorization.credentials`](#obj-authorizationcredentials) + * [`fn withKey(key)`](#fn-authorizationcredentialswithkey) + * [`fn withName(name)`](#fn-authorizationcredentialswithname) + * [`fn withOptional(is_optional)`](#fn-authorizationcredentialswithoptional) +* [`obj basicAuth`](#obj-basicauth) + * [`obj basicAuth.password`](#obj-basicauthpassword) + * [`fn withKey(key)`](#fn-basicauthpasswordwithkey) + * [`fn withName(name)`](#fn-basicauthpasswordwithname) + * [`fn withOptional(is_optional)`](#fn-basicauthpasswordwithoptional) + * [`obj basicAuth.username`](#obj-basicauthusername) + * [`fn withKey(key)`](#fn-basicauthusernamewithkey) + * [`fn withName(name)`](#fn-basicauthusernamewithname) + * [`fn withOptional(is_optional)`](#fn-basicauthusernamewithoptional) +* [`obj bearerTokenSecret`](#obj-bearertokensecret) + * [`fn withKey(key)`](#fn-bearertokensecretwithkey) + * [`fn withName(name)`](#fn-bearertokensecretwithname) + * [`fn withOptional(is_optional)`](#fn-bearertokensecretwithoptional) +* [`obj oauth2`](#obj-oauth2) + * [`fn withEndpointParams(params)`](#fn-oauth2withendpointparams) + * [`fn withScopes(scopes)`](#fn-oauth2withscopes) + * [`fn withTokenUrl(url)`](#fn-oauth2withtokenurl) + * [`obj oauth2.clientId`](#obj-oauth2clientid) + * [`obj oauth2.clientId.configMap`](#obj-oauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-oauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-oauth2clientidconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientidconfigmapwithoptional) + * [`obj oauth2.clientId.secret`](#obj-oauth2clientidsecret) + * [`fn withKey(key)`](#fn-oauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-oauth2clientidsecretwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientidsecretwithoptional) + * [`obj oauth2.clientSecret`](#obj-oauth2clientsecret) + * [`fn withKey(key)`](#fn-oauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-oauth2clientsecretwithname) + * [`fn withOptional(is_optional)`](#fn-oauth2clientsecretwithoptional) +* [`obj tlsConfig`](#obj-tlsconfig) + * [`fn withInsecureSkipVerify(skip_verify)`](#fn-tlsconfigwithinsecureskipverify) + * [`fn withServerName(name)`](#fn-tlsconfigwithservername) + * [`obj tlsConfig.ca`](#obj-tlsconfigca) + * [`obj tlsConfig.ca.configMap`](#obj-tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-tlsconfigcaconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcaconfigmapwithoptional) + * [`obj tlsConfig.ca.secret`](#obj-tlsconfigcasecret) + * [`fn withKey(key)`](#fn-tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigcasecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcasecretwithoptional) + * [`obj tlsConfig.cert`](#obj-tlsconfigcert) + * [`obj tlsConfig.cert.configMap`](#obj-tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-tlsconfigcertconfigmapwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcertconfigmapwithoptional) + * [`obj tlsConfig.cert.secret`](#obj-tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigcertsecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigcertsecretwithoptional) + * [`obj tlsConfig.keySecret`](#obj-tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-tlsconfigkeysecretwithname) + * [`fn withOptional(is_optional)`](#fn-tlsconfigkeysecretwithoptional) + +## Fields + +### fn withBearerTokenFile + +```ts +withBearerTokenFile(path) +``` + +File to read bearer token for scraping targets. + +### fn withHonorLabels + +```ts +withHonorLabels(honor_labels) +``` + +HonorLabels chooses the metric’s labels on collisions with target labels. + +### fn withHonorTimestamps + +```ts +withHonorTimestamps(honor_timestamps) +``` + +HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. + +### fn withInterval + +```ts +withInterval(interval) +``` + +Interval at which metrics should be scraped. + +### fn withMetricRelabelings + +```ts +withMetricRelabelings(relabelings) +``` + +MetricRelabelConfigs to apply to samples before ingestion. + +### fn withParams + +```ts +withParams(params) +``` + +Optional HTTP URL parameters. + +### fn withPath + +```ts +withPath(path) +``` + +HTTP path to scrape for metrics. + +### fn withPort + +```ts +withPort(port) +``` + +Name of the pod port this endpoint refers to. Mutually exclusive with targetPort. + +### fn withProxyUrl + +```ts +withProxyUrl(url) +``` + +ProxyURL eg http://proxyserver:2195 Directs scrapes to proxy through this endpoint. + +### fn withRelabelings + +```ts +withRelabelings(relabelings) +``` + +RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields and replaces original scrape job name with __tmp_prometheus_job_name. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config + +### fn withScheme + +```ts +withScheme(scheme) +``` + +HTTP scheme to use for scraping. + +### fn withScrapeTimeout + +```ts +withScrapeTimeout(timeout) +``` + +Timeout after which the scrape is ended. + +### fn withTargetPort + +```ts +withTargetPort(port) +``` + +Deprecated: Use ‘port’ instead. + +## obj authorization + +Authorization section for this endpoint + +### fn authorization.withType + +```ts +withType(type) +``` + +Set the authentication type. Defaults to Bearer, Basic will cause an error + +## obj authorization.credentials + +The secret's key that contains the credentials of the request + +### fn authorization.credentials.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn authorization.credentials.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn authorization.credentials.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj basicAuth + +BasicAuth allow an endpoint to authenticate over basic authentication More info: https://prometheus.io/docs/operating/configuration/#endpoints + +## obj basicAuth.password + +The secret in the service monitor namespace that contains the password for authentication. + +### fn basicAuth.password.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn basicAuth.password.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn basicAuth.password.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj basicAuth.username + +The secret in the service monitor namespace that contains the username for authentication. + +### fn basicAuth.username.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn basicAuth.username.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn basicAuth.username.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj bearerTokenSecret + +Secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the service monitor and accessible by the Prometheus Operator. + +### fn bearerTokenSecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn bearerTokenSecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn bearerTokenSecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj oauth2 + +OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + +### fn oauth2.withEndpointParams + +```ts +withEndpointParams(params) +``` + +Parameters to append to the token URL + +### fn oauth2.withScopes + +```ts +withScopes(scopes) +``` + +OAuth2 scopes used for the token request. + +### fn oauth2.withTokenUrl + +```ts +withTokenUrl(url) +``` + +The URL to fetch the token from. + +## obj oauth2.clientId + +The secret or configmap containing the OAuth2 client id. + +## obj oauth2.clientId.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientId.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj oauth2.clientId.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientId.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj oauth2.clientSecret + +The secret containing the OAuth2 client secret. + +### fn oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn oauth2.clientSecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn oauth2.clientSecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig + +TLS configuration to use when scraping the endpoint + +### fn tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(skip_verify) +``` + +Disable target certificate validation. + +### fn tlsConfig.withServerName + +```ts +withServerName(name) +``` + +Used to verify the hostname for the targets. + +## obj tlsConfig.ca + +Struct containing the CA cert to use for the targets. + +## obj tlsConfig.ca.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.ca.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj tlsConfig.ca.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.ca.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig.cert + +Struct containing the client cert file for the targets. + +## obj tlsConfig.cert.configMap + +ConfigMap containing data to use for the targets. Mutually exclusive with secret. + +### fn tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +The key to select. + +### fn tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.cert.configMap.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the ConfigMap or its key must be defined. + +## obj tlsConfig.cert.secret + +Secret containing data to use for the targets. Mutually exclusive with configMap. + +### fn tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.cert.secret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined + +## obj tlsConfig.keySecret + +Secret containing the client key file for the targets. + +### fn tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +The key of the secret to select from. Must be a valid secret key. + +### fn tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names + +### fn tlsConfig.keySecret.withOptional + +```ts +withOptional(is_optional) +``` + +Specify whether the Secret or its key must be defined \ No newline at end of file diff --git a/docs/0.14/monitoring/v1alpha1/prometheusAgent.md b/docs/0.14/monitoring/v1alpha1/prometheusAgent.md new file mode 100644 index 0000000..612a7cf --- /dev/null +++ b/docs/0.14/monitoring/v1alpha1/prometheusAgent.md @@ -0,0 +1,13578 @@ +--- +permalink: /0.14/monitoring/v1alpha1/prometheusAgent/ +--- + +# monitoring.v1alpha1.prometheusAgent + +"The `PrometheusAgent` custom resource definition (CRD) defines a desired [Prometheus Agent](https://prometheus.io/blog/2021/11/16/agent/) setup to run in a Kubernetes cluster.\n\n\nThe CRD is very similar to the `Prometheus` CRD except for features which aren't available in agent mode like rule evaluation, persistent storage and Thanos sidecar." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withAdditionalArgs(additionalArgs)`](#fn-specwithadditionalargs) + * [`fn withAdditionalArgsMixin(additionalArgs)`](#fn-specwithadditionalargsmixin) + * [`fn withAutomountServiceAccountToken(automountServiceAccountToken)`](#fn-specwithautomountserviceaccounttoken) + * [`fn withBodySizeLimit(bodySizeLimit)`](#fn-specwithbodysizelimit) + * [`fn withConfigMaps(configMaps)`](#fn-specwithconfigmaps) + * [`fn withConfigMapsMixin(configMaps)`](#fn-specwithconfigmapsmixin) + * [`fn withContainers(containers)`](#fn-specwithcontainers) + * [`fn withContainersMixin(containers)`](#fn-specwithcontainersmixin) + * [`fn withEnableFeatures(enableFeatures)`](#fn-specwithenablefeatures) + * [`fn withEnableFeaturesMixin(enableFeatures)`](#fn-specwithenablefeaturesmixin) + * [`fn withEnableRemoteWriteReceiver(enableRemoteWriteReceiver)`](#fn-specwithenableremotewritereceiver) + * [`fn withEnforcedBodySizeLimit(enforcedBodySizeLimit)`](#fn-specwithenforcedbodysizelimit) + * [`fn withEnforcedKeepDroppedTargets(enforcedKeepDroppedTargets)`](#fn-specwithenforcedkeepdroppedtargets) + * [`fn withEnforcedLabelLimit(enforcedLabelLimit)`](#fn-specwithenforcedlabellimit) + * [`fn withEnforcedLabelNameLengthLimit(enforcedLabelNameLengthLimit)`](#fn-specwithenforcedlabelnamelengthlimit) + * [`fn withEnforcedLabelValueLengthLimit(enforcedLabelValueLengthLimit)`](#fn-specwithenforcedlabelvaluelengthlimit) + * [`fn withEnforcedNamespaceLabel(enforcedNamespaceLabel)`](#fn-specwithenforcednamespacelabel) + * [`fn withEnforcedSampleLimit(enforcedSampleLimit)`](#fn-specwithenforcedsamplelimit) + * [`fn withEnforcedTargetLimit(enforcedTargetLimit)`](#fn-specwithenforcedtargetlimit) + * [`fn withExcludedFromEnforcement(excludedFromEnforcement)`](#fn-specwithexcludedfromenforcement) + * [`fn withExcludedFromEnforcementMixin(excludedFromEnforcement)`](#fn-specwithexcludedfromenforcementmixin) + * [`fn withExternalLabels(externalLabels)`](#fn-specwithexternallabels) + * [`fn withExternalLabelsMixin(externalLabels)`](#fn-specwithexternallabelsmixin) + * [`fn withExternalUrl(externalUrl)`](#fn-specwithexternalurl) + * [`fn withHostAliases(hostAliases)`](#fn-specwithhostaliases) + * [`fn withHostAliasesMixin(hostAliases)`](#fn-specwithhostaliasesmixin) + * [`fn withHostNetwork(hostNetwork)`](#fn-specwithhostnetwork) + * [`fn withIgnoreNamespaceSelectors(ignoreNamespaceSelectors)`](#fn-specwithignorenamespaceselectors) + * [`fn withImage(image)`](#fn-specwithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-specwithimagepullpolicy) + * [`fn withImagePullSecrets(imagePullSecrets)`](#fn-specwithimagepullsecrets) + * [`fn withImagePullSecretsMixin(imagePullSecrets)`](#fn-specwithimagepullsecretsmixin) + * [`fn withInitContainers(initContainers)`](#fn-specwithinitcontainers) + * [`fn withInitContainersMixin(initContainers)`](#fn-specwithinitcontainersmixin) + * [`fn withKeepDroppedTargets(keepDroppedTargets)`](#fn-specwithkeepdroppedtargets) + * [`fn withLabelLimit(labelLimit)`](#fn-specwithlabellimit) + * [`fn withLabelNameLengthLimit(labelNameLengthLimit)`](#fn-specwithlabelnamelengthlimit) + * [`fn withLabelValueLengthLimit(labelValueLengthLimit)`](#fn-specwithlabelvaluelengthlimit) + * [`fn withListenLocal(listenLocal)`](#fn-specwithlistenlocal) + * [`fn withLogFormat(logFormat)`](#fn-specwithlogformat) + * [`fn withLogLevel(logLevel)`](#fn-specwithloglevel) + * [`fn withMaximumStartupDurationSeconds(maximumStartupDurationSeconds)`](#fn-specwithmaximumstartupdurationseconds) + * [`fn withMinReadySeconds(minReadySeconds)`](#fn-specwithminreadyseconds) + * [`fn withMode(mode)`](#fn-specwithmode) + * [`fn withNodeSelector(nodeSelector)`](#fn-specwithnodeselector) + * [`fn withNodeSelectorMixin(nodeSelector)`](#fn-specwithnodeselectormixin) + * [`fn withOverrideHonorLabels(overrideHonorLabels)`](#fn-specwithoverridehonorlabels) + * [`fn withOverrideHonorTimestamps(overrideHonorTimestamps)`](#fn-specwithoverridehonortimestamps) + * [`fn withPaused(paused)`](#fn-specwithpaused) + * [`fn withPodTargetLabels(podTargetLabels)`](#fn-specwithpodtargetlabels) + * [`fn withPodTargetLabelsMixin(podTargetLabels)`](#fn-specwithpodtargetlabelsmixin) + * [`fn withPortName(portName)`](#fn-specwithportname) + * [`fn withPriorityClassName(priorityClassName)`](#fn-specwithpriorityclassname) + * [`fn withPrometheusExternalLabelName(prometheusExternalLabelName)`](#fn-specwithprometheusexternallabelname) + * [`fn withReloadStrategy(reloadStrategy)`](#fn-specwithreloadstrategy) + * [`fn withRemoteWrite(remoteWrite)`](#fn-specwithremotewrite) + * [`fn withRemoteWriteMixin(remoteWrite)`](#fn-specwithremotewritemixin) + * [`fn withReplicaExternalLabelName(replicaExternalLabelName)`](#fn-specwithreplicaexternallabelname) + * [`fn withReplicas(replicas)`](#fn-specwithreplicas) + * [`fn withRoutePrefix(routePrefix)`](#fn-specwithrouteprefix) + * [`fn withSampleLimit(sampleLimit)`](#fn-specwithsamplelimit) + * [`fn withScrapeClasses(scrapeClasses)`](#fn-specwithscrapeclasses) + * [`fn withScrapeClassesMixin(scrapeClasses)`](#fn-specwithscrapeclassesmixin) + * [`fn withScrapeInterval(scrapeInterval)`](#fn-specwithscrapeinterval) + * [`fn withScrapeProtocols(scrapeProtocols)`](#fn-specwithscrapeprotocols) + * [`fn withScrapeProtocolsMixin(scrapeProtocols)`](#fn-specwithscrapeprotocolsmixin) + * [`fn withScrapeTimeout(scrapeTimeout)`](#fn-specwithscrapetimeout) + * [`fn withSecrets(secrets)`](#fn-specwithsecrets) + * [`fn withSecretsMixin(secrets)`](#fn-specwithsecretsmixin) + * [`fn withServiceAccountName(serviceAccountName)`](#fn-specwithserviceaccountname) + * [`fn withServiceDiscoveryRole(serviceDiscoveryRole)`](#fn-specwithservicediscoveryrole) + * [`fn withShards(shards)`](#fn-specwithshards) + * [`fn withTargetLimit(targetLimit)`](#fn-specwithtargetlimit) + * [`fn withTolerations(tolerations)`](#fn-specwithtolerations) + * [`fn withTolerationsMixin(tolerations)`](#fn-specwithtolerationsmixin) + * [`fn withTopologySpreadConstraints(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraints) + * [`fn withTopologySpreadConstraintsMixin(topologySpreadConstraints)`](#fn-specwithtopologyspreadconstraintsmixin) + * [`fn withVersion(version)`](#fn-specwithversion) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specwithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specwithvolumemountsmixin) + * [`fn withVolumes(volumes)`](#fn-specwithvolumes) + * [`fn withVolumesMixin(volumes)`](#fn-specwithvolumesmixin) + * [`fn withWalCompression(walCompression)`](#fn-specwithwalcompression) + * [`obj spec.additionalArgs`](#obj-specadditionalargs) + * [`fn withName(name)`](#fn-specadditionalargswithname) + * [`fn withValue(value)`](#fn-specadditionalargswithvalue) + * [`obj spec.additionalScrapeConfigs`](#obj-specadditionalscrapeconfigs) + * [`fn withKey(key)`](#fn-specadditionalscrapeconfigswithkey) + * [`fn withName(name)`](#fn-specadditionalscrapeconfigswithname) + * [`fn withOptional(optional)`](#fn-specadditionalscrapeconfigswithoptional) + * [`obj spec.affinity`](#obj-specaffinity) + * [`obj spec.affinity.nodeAffinity`](#obj-specaffinitynodeaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitynodeaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreference) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencewithmatchfieldsmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressions) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchexpressionswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields`](#obj-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfields) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinitypreferredduringschedulingignoredduringexecutionpreferencematchfieldswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withNodeSelectorTerms(nodeSelectorTerms)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectorterms) + * [`fn withNodeSelectorTermsMixin(nodeSelectorTerms)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionwithnodeselectortermsmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectorterms) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchexpressionsmixin) + * [`fn withMatchFields(matchFields)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfields) + * [`fn withMatchFieldsMixin(matchFields)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermswithmatchfieldsmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchexpressionswithvaluesmixin) + * [`obj spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields`](#obj-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfields) + * [`fn withKey(key)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithoperator) + * [`fn withValues(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitynodeaffinityrequiredduringschedulingignoredduringexecutionnodeselectortermsmatchfieldswithvaluesmixin) + * [`obj spec.affinity.podAffinity`](#obj-specaffinitypodaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity`](#obj-specaffinitypodantiaffinity) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecution) + * [`fn withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithpreferredduringschedulingignoredduringexecutionmixin) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecution) + * [`fn withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution)`](#fn-specaffinitypodantiaffinitywithrequiredduringschedulingignoredduringexecutionmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecution) + * [`fn withWeight(weight)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionwithweight) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinityterm) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermwithtopologykey) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions`](#obj-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinitypreferredduringschedulingignoredduringexecutionpodaffinitytermnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecution) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmatchlabelkeysmixin) + * [`fn withMismatchLabelKeys(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeys) + * [`fn withMismatchLabelKeysMixin(mismatchLabelKeys)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithmismatchlabelkeysmixin) + * [`fn withNamespaces(namespaces)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespaces) + * [`fn withNamespacesMixin(namespaces)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithnamespacesmixin) + * [`fn withTopologyKey(topologyKey)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionwithtopologykey) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionlabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectorwithmatchlabelsmixin) + * [`obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions`](#obj-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specaffinitypodantiaffinityrequiredduringschedulingignoredduringexecutionnamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.apiserverConfig`](#obj-specapiserverconfig) + * [`fn withBearerToken(bearerToken)`](#fn-specapiserverconfigwithbearertoken) + * [`fn withBearerTokenFile(bearerTokenFile)`](#fn-specapiserverconfigwithbearertokenfile) + * [`fn withHost(host)`](#fn-specapiserverconfigwithhost) + * [`obj spec.apiserverConfig.authorization`](#obj-specapiserverconfigauthorization) + * [`fn withCredentialsFile(credentialsFile)`](#fn-specapiserverconfigauthorizationwithcredentialsfile) + * [`fn withType(type)`](#fn-specapiserverconfigauthorizationwithtype) + * [`obj spec.apiserverConfig.authorization.credentials`](#obj-specapiserverconfigauthorizationcredentials) + * [`fn withKey(key)`](#fn-specapiserverconfigauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specapiserverconfigauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigauthorizationcredentialswithoptional) + * [`obj spec.apiserverConfig.basicAuth`](#obj-specapiserverconfigbasicauth) + * [`obj spec.apiserverConfig.basicAuth.password`](#obj-specapiserverconfigbasicauthpassword) + * [`fn withKey(key)`](#fn-specapiserverconfigbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigbasicauthpasswordwithoptional) + * [`obj spec.apiserverConfig.basicAuth.username`](#obj-specapiserverconfigbasicauthusername) + * [`fn withKey(key)`](#fn-specapiserverconfigbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specapiserverconfigbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigbasicauthusernamewithoptional) + * [`obj spec.apiserverConfig.tlsConfig`](#obj-specapiserverconfigtlsconfig) + * [`fn withCaFile(caFile)`](#fn-specapiserverconfigtlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specapiserverconfigtlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specapiserverconfigtlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specapiserverconfigtlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specapiserverconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specapiserverconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specapiserverconfigtlsconfigwithservername) + * [`obj spec.apiserverConfig.tlsConfig.ca`](#obj-specapiserverconfigtlsconfigca) + * [`obj spec.apiserverConfig.tlsConfig.ca.configMap`](#obj-specapiserverconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.apiserverConfig.tlsConfig.ca.secret`](#obj-specapiserverconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigcasecretwithoptional) + * [`obj spec.apiserverConfig.tlsConfig.cert`](#obj-specapiserverconfigtlsconfigcert) + * [`obj spec.apiserverConfig.tlsConfig.cert.configMap`](#obj-specapiserverconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.apiserverConfig.tlsConfig.cert.secret`](#obj-specapiserverconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigcertsecretwithoptional) + * [`obj spec.apiserverConfig.tlsConfig.keySecret`](#obj-specapiserverconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specapiserverconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specapiserverconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specapiserverconfigtlsconfigkeysecretwithoptional) + * [`obj spec.arbitraryFSAccessThroughSMs`](#obj-specarbitraryfsaccessthroughsms) + * [`fn withDeny(deny)`](#fn-specarbitraryfsaccessthroughsmswithdeny) + * [`obj spec.containers`](#obj-speccontainers) + * [`fn withArgs(args)`](#fn-speccontainerswithargs) + * [`fn withArgsMixin(args)`](#fn-speccontainerswithargsmixin) + * [`fn withCommand(command)`](#fn-speccontainerswithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerswithcommandmixin) + * [`fn withEnv(env)`](#fn-speccontainerswithenv) + * [`fn withEnvFrom(envFrom)`](#fn-speccontainerswithenvfrom) + * [`fn withEnvFromMixin(envFrom)`](#fn-speccontainerswithenvfrommixin) + * [`fn withEnvMixin(env)`](#fn-speccontainerswithenvmixin) + * [`fn withImage(image)`](#fn-speccontainerswithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-speccontainerswithimagepullpolicy) + * [`fn withName(name)`](#fn-speccontainerswithname) + * [`fn withPorts(ports)`](#fn-speccontainerswithports) + * [`fn withPortsMixin(ports)`](#fn-speccontainerswithportsmixin) + * [`fn withResizePolicy(resizePolicy)`](#fn-speccontainerswithresizepolicy) + * [`fn withResizePolicyMixin(resizePolicy)`](#fn-speccontainerswithresizepolicymixin) + * [`fn withRestartPolicy(restartPolicy)`](#fn-speccontainerswithrestartpolicy) + * [`fn withStdin(stdin)`](#fn-speccontainerswithstdin) + * [`fn withStdinOnce(stdinOnce)`](#fn-speccontainerswithstdinonce) + * [`fn withTerminationMessagePath(terminationMessagePath)`](#fn-speccontainerswithterminationmessagepath) + * [`fn withTerminationMessagePolicy(terminationMessagePolicy)`](#fn-speccontainerswithterminationmessagepolicy) + * [`fn withTty(tty)`](#fn-speccontainerswithtty) + * [`fn withVolumeDevices(volumeDevices)`](#fn-speccontainerswithvolumedevices) + * [`fn withVolumeDevicesMixin(volumeDevices)`](#fn-speccontainerswithvolumedevicesmixin) + * [`fn withVolumeMounts(volumeMounts)`](#fn-speccontainerswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-speccontainerswithvolumemountsmixin) + * [`fn withWorkingDir(workingDir)`](#fn-speccontainerswithworkingdir) + * [`obj spec.containers.env`](#obj-speccontainersenv) + * [`fn withName(name)`](#fn-speccontainersenvwithname) + * [`fn withValue(value)`](#fn-speccontainersenvwithvalue) + * [`obj spec.containers.env.valueFrom`](#obj-speccontainersenvvaluefrom) + * [`obj spec.containers.env.valueFrom.configMapKeyRef`](#obj-speccontainersenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.containers.env.valueFrom.fieldRef`](#obj-speccontainersenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-speccontainersenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-speccontainersenvvaluefromfieldrefwithfieldpath) + * [`obj spec.containers.env.valueFrom.resourceFieldRef`](#obj-speccontainersenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-speccontainersenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-speccontainersenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-speccontainersenvvaluefromresourcefieldrefwithresource) + * [`obj spec.containers.env.valueFrom.secretKeyRef`](#obj-speccontainersenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-speccontainersenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-speccontainersenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.containers.envFrom`](#obj-speccontainersenvfrom) + * [`fn withPrefix(prefix)`](#fn-speccontainersenvfromwithprefix) + * [`obj spec.containers.envFrom.configMapRef`](#obj-speccontainersenvfromconfigmapref) + * [`fn withName(name)`](#fn-speccontainersenvfromconfigmaprefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvfromconfigmaprefwithoptional) + * [`obj spec.containers.envFrom.secretRef`](#obj-speccontainersenvfromsecretref) + * [`fn withName(name)`](#fn-speccontainersenvfromsecretrefwithname) + * [`fn withOptional(optional)`](#fn-speccontainersenvfromsecretrefwithoptional) + * [`obj spec.containers.lifecycle`](#obj-speccontainerslifecycle) + * [`obj spec.containers.lifecycle.postStart`](#obj-speccontainerslifecyclepoststart) + * [`obj spec.containers.lifecycle.postStart.exec`](#obj-speccontainerslifecyclepoststartexec) + * [`fn withCommand(command)`](#fn-speccontainerslifecyclepoststartexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslifecyclepoststartexecwithcommandmixin) + * [`obj spec.containers.lifecycle.postStart.httpGet`](#obj-speccontainerslifecyclepoststarthttpget) + * [`fn withHost(host)`](#fn-speccontainerslifecyclepoststarthttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslifecyclepoststarthttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslifecyclepoststarthttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslifecyclepoststarthttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslifecyclepoststarthttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslifecyclepoststarthttpgetwithscheme) + * [`obj spec.containers.lifecycle.postStart.httpGet.httpHeaders`](#obj-speccontainerslifecyclepoststarthttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslifecyclepoststarthttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslifecyclepoststarthttpgethttpheaderswithvalue) + * [`obj spec.containers.lifecycle.postStart.sleep`](#obj-speccontainerslifecyclepoststartsleep) + * [`fn withSeconds(seconds)`](#fn-speccontainerslifecyclepoststartsleepwithseconds) + * [`obj spec.containers.lifecycle.postStart.tcpSocket`](#obj-speccontainerslifecyclepoststarttcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslifecyclepoststarttcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslifecyclepoststarttcpsocketwithport) + * [`obj spec.containers.lifecycle.preStop`](#obj-speccontainerslifecycleprestop) + * [`obj spec.containers.lifecycle.preStop.exec`](#obj-speccontainerslifecycleprestopexec) + * [`fn withCommand(command)`](#fn-speccontainerslifecycleprestopexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslifecycleprestopexecwithcommandmixin) + * [`obj spec.containers.lifecycle.preStop.httpGet`](#obj-speccontainerslifecycleprestophttpget) + * [`fn withHost(host)`](#fn-speccontainerslifecycleprestophttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslifecycleprestophttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslifecycleprestophttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslifecycleprestophttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslifecycleprestophttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslifecycleprestophttpgetwithscheme) + * [`obj spec.containers.lifecycle.preStop.httpGet.httpHeaders`](#obj-speccontainerslifecycleprestophttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslifecycleprestophttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslifecycleprestophttpgethttpheaderswithvalue) + * [`obj spec.containers.lifecycle.preStop.sleep`](#obj-speccontainerslifecycleprestopsleep) + * [`fn withSeconds(seconds)`](#fn-speccontainerslifecycleprestopsleepwithseconds) + * [`obj spec.containers.lifecycle.preStop.tcpSocket`](#obj-speccontainerslifecycleprestoptcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslifecycleprestoptcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslifecycleprestoptcpsocketwithport) + * [`obj spec.containers.livenessProbe`](#obj-speccontainerslivenessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainerslivenessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainerslivenessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainerslivenessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainerslivenessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainerslivenessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainerslivenessprobewithtimeoutseconds) + * [`obj spec.containers.livenessProbe.exec`](#obj-speccontainerslivenessprobeexec) + * [`fn withCommand(command)`](#fn-speccontainerslivenessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainerslivenessprobeexecwithcommandmixin) + * [`obj spec.containers.livenessProbe.grpc`](#obj-speccontainerslivenessprobegrpc) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainerslivenessprobegrpcwithservice) + * [`obj spec.containers.livenessProbe.httpGet`](#obj-speccontainerslivenessprobehttpget) + * [`fn withHost(host)`](#fn-speccontainerslivenessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainerslivenessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainerslivenessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainerslivenessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainerslivenessprobehttpgetwithscheme) + * [`obj spec.containers.livenessProbe.httpGet.httpHeaders`](#obj-speccontainerslivenessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainerslivenessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainerslivenessprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.livenessProbe.tcpSocket`](#obj-speccontainerslivenessprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainerslivenessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainerslivenessprobetcpsocketwithport) + * [`obj spec.containers.ports`](#obj-speccontainersports) + * [`fn withContainerPort(containerPort)`](#fn-speccontainersportswithcontainerport) + * [`fn withHostIP(hostIP)`](#fn-speccontainersportswithhostip) + * [`fn withHostPort(hostPort)`](#fn-speccontainersportswithhostport) + * [`fn withName(name)`](#fn-speccontainersportswithname) + * [`fn withProtocol(protocol)`](#fn-speccontainersportswithprotocol) + * [`obj spec.containers.readinessProbe`](#obj-speccontainersreadinessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainersreadinessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainersreadinessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainersreadinessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainersreadinessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainersreadinessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainersreadinessprobewithtimeoutseconds) + * [`obj spec.containers.readinessProbe.exec`](#obj-speccontainersreadinessprobeexec) + * [`fn withCommand(command)`](#fn-speccontainersreadinessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainersreadinessprobeexecwithcommandmixin) + * [`obj spec.containers.readinessProbe.grpc`](#obj-speccontainersreadinessprobegrpc) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainersreadinessprobegrpcwithservice) + * [`obj spec.containers.readinessProbe.httpGet`](#obj-speccontainersreadinessprobehttpget) + * [`fn withHost(host)`](#fn-speccontainersreadinessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainersreadinessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainersreadinessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainersreadinessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainersreadinessprobehttpgetwithscheme) + * [`obj spec.containers.readinessProbe.httpGet.httpHeaders`](#obj-speccontainersreadinessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainersreadinessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainersreadinessprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.readinessProbe.tcpSocket`](#obj-speccontainersreadinessprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainersreadinessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainersreadinessprobetcpsocketwithport) + * [`obj spec.containers.resizePolicy`](#obj-speccontainersresizepolicy) + * [`fn withResourceName(resourceName)`](#fn-speccontainersresizepolicywithresourcename) + * [`fn withRestartPolicy(restartPolicy)`](#fn-speccontainersresizepolicywithrestartpolicy) + * [`obj spec.containers.resources`](#obj-speccontainersresources) + * [`fn withClaims(claims)`](#fn-speccontainersresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-speccontainersresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-speccontainersresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-speccontainersresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-speccontainersresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-speccontainersresourceswithrequestsmixin) + * [`obj spec.containers.resources.claims`](#obj-speccontainersresourcesclaims) + * [`fn withName(name)`](#fn-speccontainersresourcesclaimswithname) + * [`obj spec.containers.securityContext`](#obj-speccontainerssecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-speccontainerssecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-speccontainerssecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-speccontainerssecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-speccontainerssecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-speccontainerssecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-speccontainerssecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-speccontainerssecuritycontextwithrunasuser) + * [`obj spec.containers.securityContext.appArmorProfile`](#obj-speccontainerssecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-speccontainerssecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextapparmorprofilewithtype) + * [`obj spec.containers.securityContext.capabilities`](#obj-speccontainerssecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-speccontainerssecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-speccontainerssecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-speccontainerssecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-speccontainerssecuritycontextcapabilitieswithdropmixin) + * [`obj spec.containers.securityContext.seLinuxOptions`](#obj-speccontainerssecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-speccontainerssecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-speccontainerssecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-speccontainerssecuritycontextselinuxoptionswithuser) + * [`obj spec.containers.securityContext.seccompProfile`](#obj-speccontainerssecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-speccontainerssecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-speccontainerssecuritycontextseccompprofilewithtype) + * [`obj spec.containers.securityContext.windowsOptions`](#obj-speccontainerssecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-speccontainerssecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-speccontainerssecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-speccontainerssecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-speccontainerssecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.containers.startupProbe`](#obj-speccontainersstartupprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-speccontainersstartupprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-speccontainersstartupprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-speccontainersstartupprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-speccontainersstartupprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-speccontainersstartupprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-speccontainersstartupprobewithtimeoutseconds) + * [`obj spec.containers.startupProbe.exec`](#obj-speccontainersstartupprobeexec) + * [`fn withCommand(command)`](#fn-speccontainersstartupprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-speccontainersstartupprobeexecwithcommandmixin) + * [`obj spec.containers.startupProbe.grpc`](#obj-speccontainersstartupprobegrpc) + * [`fn withPort(port)`](#fn-speccontainersstartupprobegrpcwithport) + * [`fn withService(service)`](#fn-speccontainersstartupprobegrpcwithservice) + * [`obj spec.containers.startupProbe.httpGet`](#obj-speccontainersstartupprobehttpget) + * [`fn withHost(host)`](#fn-speccontainersstartupprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-speccontainersstartupprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-speccontainersstartupprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-speccontainersstartupprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-speccontainersstartupprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-speccontainersstartupprobehttpgetwithscheme) + * [`obj spec.containers.startupProbe.httpGet.httpHeaders`](#obj-speccontainersstartupprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-speccontainersstartupprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-speccontainersstartupprobehttpgethttpheaderswithvalue) + * [`obj spec.containers.startupProbe.tcpSocket`](#obj-speccontainersstartupprobetcpsocket) + * [`fn withHost(host)`](#fn-speccontainersstartupprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-speccontainersstartupprobetcpsocketwithport) + * [`obj spec.containers.volumeDevices`](#obj-speccontainersvolumedevices) + * [`fn withDevicePath(devicePath)`](#fn-speccontainersvolumedeviceswithdevicepath) + * [`fn withName(name)`](#fn-speccontainersvolumedeviceswithname) + * [`obj spec.containers.volumeMounts`](#obj-speccontainersvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-speccontainersvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-speccontainersvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-speccontainersvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-speccontainersvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-speccontainersvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-speccontainersvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-speccontainersvolumemountswithsubpathexpr) + * [`obj spec.excludedFromEnforcement`](#obj-specexcludedfromenforcement) + * [`fn withGroup(group)`](#fn-specexcludedfromenforcementwithgroup) + * [`fn withName(name)`](#fn-specexcludedfromenforcementwithname) + * [`fn withNamespace(namespace)`](#fn-specexcludedfromenforcementwithnamespace) + * [`fn withResource(resource)`](#fn-specexcludedfromenforcementwithresource) + * [`obj spec.hostAliases`](#obj-spechostaliases) + * [`fn withHostnames(hostnames)`](#fn-spechostaliaseswithhostnames) + * [`fn withHostnamesMixin(hostnames)`](#fn-spechostaliaseswithhostnamesmixin) + * [`fn withIp(ip)`](#fn-spechostaliaseswithip) + * [`obj spec.imagePullSecrets`](#obj-specimagepullsecrets) + * [`fn withName(name)`](#fn-specimagepullsecretswithname) + * [`obj spec.initContainers`](#obj-specinitcontainers) + * [`fn withArgs(args)`](#fn-specinitcontainerswithargs) + * [`fn withArgsMixin(args)`](#fn-specinitcontainerswithargsmixin) + * [`fn withCommand(command)`](#fn-specinitcontainerswithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerswithcommandmixin) + * [`fn withEnv(env)`](#fn-specinitcontainerswithenv) + * [`fn withEnvFrom(envFrom)`](#fn-specinitcontainerswithenvfrom) + * [`fn withEnvFromMixin(envFrom)`](#fn-specinitcontainerswithenvfrommixin) + * [`fn withEnvMixin(env)`](#fn-specinitcontainerswithenvmixin) + * [`fn withImage(image)`](#fn-specinitcontainerswithimage) + * [`fn withImagePullPolicy(imagePullPolicy)`](#fn-specinitcontainerswithimagepullpolicy) + * [`fn withName(name)`](#fn-specinitcontainerswithname) + * [`fn withPorts(ports)`](#fn-specinitcontainerswithports) + * [`fn withPortsMixin(ports)`](#fn-specinitcontainerswithportsmixin) + * [`fn withResizePolicy(resizePolicy)`](#fn-specinitcontainerswithresizepolicy) + * [`fn withResizePolicyMixin(resizePolicy)`](#fn-specinitcontainerswithresizepolicymixin) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specinitcontainerswithrestartpolicy) + * [`fn withStdin(stdin)`](#fn-specinitcontainerswithstdin) + * [`fn withStdinOnce(stdinOnce)`](#fn-specinitcontainerswithstdinonce) + * [`fn withTerminationMessagePath(terminationMessagePath)`](#fn-specinitcontainerswithterminationmessagepath) + * [`fn withTerminationMessagePolicy(terminationMessagePolicy)`](#fn-specinitcontainerswithterminationmessagepolicy) + * [`fn withTty(tty)`](#fn-specinitcontainerswithtty) + * [`fn withVolumeDevices(volumeDevices)`](#fn-specinitcontainerswithvolumedevices) + * [`fn withVolumeDevicesMixin(volumeDevices)`](#fn-specinitcontainerswithvolumedevicesmixin) + * [`fn withVolumeMounts(volumeMounts)`](#fn-specinitcontainerswithvolumemounts) + * [`fn withVolumeMountsMixin(volumeMounts)`](#fn-specinitcontainerswithvolumemountsmixin) + * [`fn withWorkingDir(workingDir)`](#fn-specinitcontainerswithworkingdir) + * [`obj spec.initContainers.env`](#obj-specinitcontainersenv) + * [`fn withName(name)`](#fn-specinitcontainersenvwithname) + * [`fn withValue(value)`](#fn-specinitcontainersenvwithvalue) + * [`obj spec.initContainers.env.valueFrom`](#obj-specinitcontainersenvvaluefrom) + * [`obj spec.initContainers.env.valueFrom.configMapKeyRef`](#obj-specinitcontainersenvvaluefromconfigmapkeyref) + * [`fn withKey(key)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithkey) + * [`fn withName(name)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvvaluefromconfigmapkeyrefwithoptional) + * [`obj spec.initContainers.env.valueFrom.fieldRef`](#obj-specinitcontainersenvvaluefromfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specinitcontainersenvvaluefromfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specinitcontainersenvvaluefromfieldrefwithfieldpath) + * [`obj spec.initContainers.env.valueFrom.resourceFieldRef`](#obj-specinitcontainersenvvaluefromresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specinitcontainersenvvaluefromresourcefieldrefwithresource) + * [`obj spec.initContainers.env.valueFrom.secretKeyRef`](#obj-specinitcontainersenvvaluefromsecretkeyref) + * [`fn withKey(key)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithkey) + * [`fn withName(name)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvvaluefromsecretkeyrefwithoptional) + * [`obj spec.initContainers.envFrom`](#obj-specinitcontainersenvfrom) + * [`fn withPrefix(prefix)`](#fn-specinitcontainersenvfromwithprefix) + * [`obj spec.initContainers.envFrom.configMapRef`](#obj-specinitcontainersenvfromconfigmapref) + * [`fn withName(name)`](#fn-specinitcontainersenvfromconfigmaprefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvfromconfigmaprefwithoptional) + * [`obj spec.initContainers.envFrom.secretRef`](#obj-specinitcontainersenvfromsecretref) + * [`fn withName(name)`](#fn-specinitcontainersenvfromsecretrefwithname) + * [`fn withOptional(optional)`](#fn-specinitcontainersenvfromsecretrefwithoptional) + * [`obj spec.initContainers.lifecycle`](#obj-specinitcontainerslifecycle) + * [`obj spec.initContainers.lifecycle.postStart`](#obj-specinitcontainerslifecyclepoststart) + * [`obj spec.initContainers.lifecycle.postStart.exec`](#obj-specinitcontainerslifecyclepoststartexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslifecyclepoststartexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslifecyclepoststartexecwithcommandmixin) + * [`obj spec.initContainers.lifecycle.postStart.httpGet`](#obj-specinitcontainerslifecyclepoststarthttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslifecyclepoststarthttpgetwithscheme) + * [`obj spec.initContainers.lifecycle.postStart.httpGet.httpHeaders`](#obj-specinitcontainerslifecyclepoststarthttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslifecyclepoststarthttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslifecyclepoststarthttpgethttpheaderswithvalue) + * [`obj spec.initContainers.lifecycle.postStart.sleep`](#obj-specinitcontainerslifecyclepoststartsleep) + * [`fn withSeconds(seconds)`](#fn-specinitcontainerslifecyclepoststartsleepwithseconds) + * [`obj spec.initContainers.lifecycle.postStart.tcpSocket`](#obj-specinitcontainerslifecyclepoststarttcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslifecyclepoststarttcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslifecyclepoststarttcpsocketwithport) + * [`obj spec.initContainers.lifecycle.preStop`](#obj-specinitcontainerslifecycleprestop) + * [`obj spec.initContainers.lifecycle.preStop.exec`](#obj-specinitcontainerslifecycleprestopexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslifecycleprestopexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslifecycleprestopexecwithcommandmixin) + * [`obj spec.initContainers.lifecycle.preStop.httpGet`](#obj-specinitcontainerslifecycleprestophttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslifecycleprestophttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslifecycleprestophttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslifecycleprestophttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslifecycleprestophttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslifecycleprestophttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslifecycleprestophttpgetwithscheme) + * [`obj spec.initContainers.lifecycle.preStop.httpGet.httpHeaders`](#obj-specinitcontainerslifecycleprestophttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslifecycleprestophttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslifecycleprestophttpgethttpheaderswithvalue) + * [`obj spec.initContainers.lifecycle.preStop.sleep`](#obj-specinitcontainerslifecycleprestopsleep) + * [`fn withSeconds(seconds)`](#fn-specinitcontainerslifecycleprestopsleepwithseconds) + * [`obj spec.initContainers.lifecycle.preStop.tcpSocket`](#obj-specinitcontainerslifecycleprestoptcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslifecycleprestoptcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslifecycleprestoptcpsocketwithport) + * [`obj spec.initContainers.livenessProbe`](#obj-specinitcontainerslivenessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainerslivenessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainerslivenessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainerslivenessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainerslivenessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainerslivenessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainerslivenessprobewithtimeoutseconds) + * [`obj spec.initContainers.livenessProbe.exec`](#obj-specinitcontainerslivenessprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainerslivenessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainerslivenessprobeexecwithcommandmixin) + * [`obj spec.initContainers.livenessProbe.grpc`](#obj-specinitcontainerslivenessprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainerslivenessprobegrpcwithservice) + * [`obj spec.initContainers.livenessProbe.httpGet`](#obj-specinitcontainerslivenessprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainerslivenessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainerslivenessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainerslivenessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainerslivenessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainerslivenessprobehttpgetwithscheme) + * [`obj spec.initContainers.livenessProbe.httpGet.httpHeaders`](#obj-specinitcontainerslivenessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainerslivenessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainerslivenessprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.livenessProbe.tcpSocket`](#obj-specinitcontainerslivenessprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainerslivenessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainerslivenessprobetcpsocketwithport) + * [`obj spec.initContainers.ports`](#obj-specinitcontainersports) + * [`fn withContainerPort(containerPort)`](#fn-specinitcontainersportswithcontainerport) + * [`fn withHostIP(hostIP)`](#fn-specinitcontainersportswithhostip) + * [`fn withHostPort(hostPort)`](#fn-specinitcontainersportswithhostport) + * [`fn withName(name)`](#fn-specinitcontainersportswithname) + * [`fn withProtocol(protocol)`](#fn-specinitcontainersportswithprotocol) + * [`obj spec.initContainers.readinessProbe`](#obj-specinitcontainersreadinessprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainersreadinessprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainersreadinessprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainersreadinessprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainersreadinessprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainersreadinessprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainersreadinessprobewithtimeoutseconds) + * [`obj spec.initContainers.readinessProbe.exec`](#obj-specinitcontainersreadinessprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainersreadinessprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainersreadinessprobeexecwithcommandmixin) + * [`obj spec.initContainers.readinessProbe.grpc`](#obj-specinitcontainersreadinessprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainersreadinessprobegrpcwithservice) + * [`obj spec.initContainers.readinessProbe.httpGet`](#obj-specinitcontainersreadinessprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainersreadinessprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainersreadinessprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainersreadinessprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainersreadinessprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainersreadinessprobehttpgetwithscheme) + * [`obj spec.initContainers.readinessProbe.httpGet.httpHeaders`](#obj-specinitcontainersreadinessprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainersreadinessprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainersreadinessprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.readinessProbe.tcpSocket`](#obj-specinitcontainersreadinessprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainersreadinessprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainersreadinessprobetcpsocketwithport) + * [`obj spec.initContainers.resizePolicy`](#obj-specinitcontainersresizepolicy) + * [`fn withResourceName(resourceName)`](#fn-specinitcontainersresizepolicywithresourcename) + * [`fn withRestartPolicy(restartPolicy)`](#fn-specinitcontainersresizepolicywithrestartpolicy) + * [`obj spec.initContainers.resources`](#obj-specinitcontainersresources) + * [`fn withClaims(claims)`](#fn-specinitcontainersresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specinitcontainersresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specinitcontainersresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specinitcontainersresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specinitcontainersresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specinitcontainersresourceswithrequestsmixin) + * [`obj spec.initContainers.resources.claims`](#obj-specinitcontainersresourcesclaims) + * [`fn withName(name)`](#fn-specinitcontainersresourcesclaimswithname) + * [`obj spec.initContainers.securityContext`](#obj-specinitcontainerssecuritycontext) + * [`fn withAllowPrivilegeEscalation(allowPrivilegeEscalation)`](#fn-specinitcontainerssecuritycontextwithallowprivilegeescalation) + * [`fn withPrivileged(privileged)`](#fn-specinitcontainerssecuritycontextwithprivileged) + * [`fn withProcMount(procMount)`](#fn-specinitcontainerssecuritycontextwithprocmount) + * [`fn withReadOnlyRootFilesystem(readOnlyRootFilesystem)`](#fn-specinitcontainerssecuritycontextwithreadonlyrootfilesystem) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specinitcontainerssecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specinitcontainerssecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specinitcontainerssecuritycontextwithrunasuser) + * [`obj spec.initContainers.securityContext.appArmorProfile`](#obj-specinitcontainerssecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specinitcontainerssecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextapparmorprofilewithtype) + * [`obj spec.initContainers.securityContext.capabilities`](#obj-specinitcontainerssecuritycontextcapabilities) + * [`fn withAdd(add)`](#fn-specinitcontainerssecuritycontextcapabilitieswithadd) + * [`fn withAddMixin(add)`](#fn-specinitcontainerssecuritycontextcapabilitieswithaddmixin) + * [`fn withDrop(drop)`](#fn-specinitcontainerssecuritycontextcapabilitieswithdrop) + * [`fn withDropMixin(drop)`](#fn-specinitcontainerssecuritycontextcapabilitieswithdropmixin) + * [`obj spec.initContainers.securityContext.seLinuxOptions`](#obj-specinitcontainerssecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specinitcontainerssecuritycontextselinuxoptionswithuser) + * [`obj spec.initContainers.securityContext.seccompProfile`](#obj-specinitcontainerssecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specinitcontainerssecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specinitcontainerssecuritycontextseccompprofilewithtype) + * [`obj spec.initContainers.securityContext.windowsOptions`](#obj-specinitcontainerssecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specinitcontainerssecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.initContainers.startupProbe`](#obj-specinitcontainersstartupprobe) + * [`fn withFailureThreshold(failureThreshold)`](#fn-specinitcontainersstartupprobewithfailurethreshold) + * [`fn withInitialDelaySeconds(initialDelaySeconds)`](#fn-specinitcontainersstartupprobewithinitialdelayseconds) + * [`fn withPeriodSeconds(periodSeconds)`](#fn-specinitcontainersstartupprobewithperiodseconds) + * [`fn withSuccessThreshold(successThreshold)`](#fn-specinitcontainersstartupprobewithsuccessthreshold) + * [`fn withTerminationGracePeriodSeconds(terminationGracePeriodSeconds)`](#fn-specinitcontainersstartupprobewithterminationgraceperiodseconds) + * [`fn withTimeoutSeconds(timeoutSeconds)`](#fn-specinitcontainersstartupprobewithtimeoutseconds) + * [`obj spec.initContainers.startupProbe.exec`](#obj-specinitcontainersstartupprobeexec) + * [`fn withCommand(command)`](#fn-specinitcontainersstartupprobeexecwithcommand) + * [`fn withCommandMixin(command)`](#fn-specinitcontainersstartupprobeexecwithcommandmixin) + * [`obj spec.initContainers.startupProbe.grpc`](#obj-specinitcontainersstartupprobegrpc) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobegrpcwithport) + * [`fn withService(service)`](#fn-specinitcontainersstartupprobegrpcwithservice) + * [`obj spec.initContainers.startupProbe.httpGet`](#obj-specinitcontainersstartupprobehttpget) + * [`fn withHost(host)`](#fn-specinitcontainersstartupprobehttpgetwithhost) + * [`fn withHttpHeaders(httpHeaders)`](#fn-specinitcontainersstartupprobehttpgetwithhttpheaders) + * [`fn withHttpHeadersMixin(httpHeaders)`](#fn-specinitcontainersstartupprobehttpgetwithhttpheadersmixin) + * [`fn withPath(path)`](#fn-specinitcontainersstartupprobehttpgetwithpath) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobehttpgetwithport) + * [`fn withScheme(scheme)`](#fn-specinitcontainersstartupprobehttpgetwithscheme) + * [`obj spec.initContainers.startupProbe.httpGet.httpHeaders`](#obj-specinitcontainersstartupprobehttpgethttpheaders) + * [`fn withName(name)`](#fn-specinitcontainersstartupprobehttpgethttpheaderswithname) + * [`fn withValue(value)`](#fn-specinitcontainersstartupprobehttpgethttpheaderswithvalue) + * [`obj spec.initContainers.startupProbe.tcpSocket`](#obj-specinitcontainersstartupprobetcpsocket) + * [`fn withHost(host)`](#fn-specinitcontainersstartupprobetcpsocketwithhost) + * [`fn withPort(port)`](#fn-specinitcontainersstartupprobetcpsocketwithport) + * [`obj spec.initContainers.volumeDevices`](#obj-specinitcontainersvolumedevices) + * [`fn withDevicePath(devicePath)`](#fn-specinitcontainersvolumedeviceswithdevicepath) + * [`fn withName(name)`](#fn-specinitcontainersvolumedeviceswithname) + * [`obj spec.initContainers.volumeMounts`](#obj-specinitcontainersvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specinitcontainersvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specinitcontainersvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specinitcontainersvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specinitcontainersvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-specinitcontainersvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-specinitcontainersvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specinitcontainersvolumemountswithsubpathexpr) + * [`obj spec.persistentVolumeClaimRetentionPolicy`](#obj-specpersistentvolumeclaimretentionpolicy) + * [`fn withWhenDeleted(whenDeleted)`](#fn-specpersistentvolumeclaimretentionpolicywithwhendeleted) + * [`fn withWhenScaled(whenScaled)`](#fn-specpersistentvolumeclaimretentionpolicywithwhenscaled) + * [`obj spec.podMetadata`](#obj-specpodmetadata) + * [`fn withAnnotations(annotations)`](#fn-specpodmetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specpodmetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specpodmetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specpodmetadatawithlabelsmixin) + * [`fn withName(name)`](#fn-specpodmetadatawithname) + * [`obj spec.podMonitorNamespaceSelector`](#obj-specpodmonitornamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specpodmonitornamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specpodmonitornamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specpodmonitornamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specpodmonitornamespaceselectorwithmatchlabelsmixin) + * [`obj spec.podMonitorNamespaceSelector.matchExpressions`](#obj-specpodmonitornamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specpodmonitornamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specpodmonitornamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specpodmonitornamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specpodmonitornamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.podMonitorSelector`](#obj-specpodmonitorselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specpodmonitorselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specpodmonitorselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specpodmonitorselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specpodmonitorselectorwithmatchlabelsmixin) + * [`obj spec.podMonitorSelector.matchExpressions`](#obj-specpodmonitorselectormatchexpressions) + * [`fn withKey(key)`](#fn-specpodmonitorselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specpodmonitorselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specpodmonitorselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specpodmonitorselectormatchexpressionswithvaluesmixin) + * [`obj spec.probeNamespaceSelector`](#obj-specprobenamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specprobenamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specprobenamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specprobenamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specprobenamespaceselectorwithmatchlabelsmixin) + * [`obj spec.probeNamespaceSelector.matchExpressions`](#obj-specprobenamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specprobenamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specprobenamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specprobenamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specprobenamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.probeSelector`](#obj-specprobeselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specprobeselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specprobeselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specprobeselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specprobeselectorwithmatchlabelsmixin) + * [`obj spec.probeSelector.matchExpressions`](#obj-specprobeselectormatchexpressions) + * [`fn withKey(key)`](#fn-specprobeselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specprobeselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specprobeselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specprobeselectormatchexpressionswithvaluesmixin) + * [`obj spec.remoteWrite`](#obj-specremotewrite) + * [`fn withBearerToken(bearerToken)`](#fn-specremotewritewithbearertoken) + * [`fn withBearerTokenFile(bearerTokenFile)`](#fn-specremotewritewithbearertokenfile) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-specremotewritewithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-specremotewritewithfollowredirects) + * [`fn withHeaders(headers)`](#fn-specremotewritewithheaders) + * [`fn withHeadersMixin(headers)`](#fn-specremotewritewithheadersmixin) + * [`fn withName(name)`](#fn-specremotewritewithname) + * [`fn withNoProxy(noProxy)`](#fn-specremotewritewithnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specremotewritewithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specremotewritewithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specremotewritewithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specremotewritewithproxyurl) + * [`fn withRemoteTimeout(remoteTimeout)`](#fn-specremotewritewithremotetimeout) + * [`fn withSendExemplars(sendExemplars)`](#fn-specremotewritewithsendexemplars) + * [`fn withSendNativeHistograms(sendNativeHistograms)`](#fn-specremotewritewithsendnativehistograms) + * [`fn withUrl(url)`](#fn-specremotewritewithurl) + * [`fn withWriteRelabelConfigs(writeRelabelConfigs)`](#fn-specremotewritewithwriterelabelconfigs) + * [`fn withWriteRelabelConfigsMixin(writeRelabelConfigs)`](#fn-specremotewritewithwriterelabelconfigsmixin) + * [`obj spec.remoteWrite.authorization`](#obj-specremotewriteauthorization) + * [`fn withCredentialsFile(credentialsFile)`](#fn-specremotewriteauthorizationwithcredentialsfile) + * [`fn withType(type)`](#fn-specremotewriteauthorizationwithtype) + * [`obj spec.remoteWrite.authorization.credentials`](#obj-specremotewriteauthorizationcredentials) + * [`fn withKey(key)`](#fn-specremotewriteauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specremotewriteauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specremotewriteauthorizationcredentialswithoptional) + * [`obj spec.remoteWrite.azureAd`](#obj-specremotewriteazuread) + * [`fn withCloud(cloud)`](#fn-specremotewriteazureadwithcloud) + * [`obj spec.remoteWrite.azureAd.managedIdentity`](#obj-specremotewriteazureadmanagedidentity) + * [`fn withClientId(clientId)`](#fn-specremotewriteazureadmanagedidentitywithclientid) + * [`obj spec.remoteWrite.azureAd.oauth`](#obj-specremotewriteazureadoauth) + * [`fn withClientId(clientId)`](#fn-specremotewriteazureadoauthwithclientid) + * [`fn withTenantId(tenantId)`](#fn-specremotewriteazureadoauthwithtenantid) + * [`obj spec.remoteWrite.azureAd.oauth.clientSecret`](#obj-specremotewriteazureadoauthclientsecret) + * [`fn withKey(key)`](#fn-specremotewriteazureadoauthclientsecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteazureadoauthclientsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteazureadoauthclientsecretwithoptional) + * [`obj spec.remoteWrite.azureAd.sdk`](#obj-specremotewriteazureadsdk) + * [`fn withTenantId(tenantId)`](#fn-specremotewriteazureadsdkwithtenantid) + * [`obj spec.remoteWrite.basicAuth`](#obj-specremotewritebasicauth) + * [`obj spec.remoteWrite.basicAuth.password`](#obj-specremotewritebasicauthpassword) + * [`fn withKey(key)`](#fn-specremotewritebasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specremotewritebasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specremotewritebasicauthpasswordwithoptional) + * [`obj spec.remoteWrite.basicAuth.username`](#obj-specremotewritebasicauthusername) + * [`fn withKey(key)`](#fn-specremotewritebasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specremotewritebasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specremotewritebasicauthusernamewithoptional) + * [`obj spec.remoteWrite.metadataConfig`](#obj-specremotewritemetadataconfig) + * [`fn withSend(send)`](#fn-specremotewritemetadataconfigwithsend) + * [`fn withSendInterval(sendInterval)`](#fn-specremotewritemetadataconfigwithsendinterval) + * [`obj spec.remoteWrite.oauth2`](#obj-specremotewriteoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specremotewriteoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specremotewriteoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specremotewriteoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specremotewriteoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specremotewriteoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specremotewriteoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specremotewriteoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specremotewriteoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specremotewriteoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specremotewriteoauth2withtokenurl) + * [`obj spec.remoteWrite.oauth2.clientId`](#obj-specremotewriteoauth2clientid) + * [`obj spec.remoteWrite.oauth2.clientId.configMap`](#obj-specremotewriteoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specremotewriteoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2clientidconfigmapwithoptional) + * [`obj spec.remoteWrite.oauth2.clientId.secret`](#obj-specremotewriteoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2clientidsecretwithoptional) + * [`obj spec.remoteWrite.oauth2.clientSecret`](#obj-specremotewriteoauth2clientsecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2clientsecretwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig`](#obj-specremotewriteoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specremotewriteoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specremotewriteoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specremotewriteoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specremotewriteoauth2tlsconfigwithservername) + * [`obj spec.remoteWrite.oauth2.tlsConfig.ca`](#obj-specremotewriteoauth2tlsconfigca) + * [`obj spec.remoteWrite.oauth2.tlsConfig.ca.configMap`](#obj-specremotewriteoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig.ca.secret`](#obj-specremotewriteoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigcasecretwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig.cert`](#obj-specremotewriteoauth2tlsconfigcert) + * [`obj spec.remoteWrite.oauth2.tlsConfig.cert.configMap`](#obj-specremotewriteoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig.cert.secret`](#obj-specremotewriteoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.remoteWrite.oauth2.tlsConfig.keySecret`](#obj-specremotewriteoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specremotewriteoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specremotewriteoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewriteoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.remoteWrite.queueConfig`](#obj-specremotewritequeueconfig) + * [`fn withBatchSendDeadline(batchSendDeadline)`](#fn-specremotewritequeueconfigwithbatchsenddeadline) + * [`fn withCapacity(capacity)`](#fn-specremotewritequeueconfigwithcapacity) + * [`fn withMaxBackoff(maxBackoff)`](#fn-specremotewritequeueconfigwithmaxbackoff) + * [`fn withMaxRetries(maxRetries)`](#fn-specremotewritequeueconfigwithmaxretries) + * [`fn withMaxSamplesPerSend(maxSamplesPerSend)`](#fn-specremotewritequeueconfigwithmaxsamplespersend) + * [`fn withMaxShards(maxShards)`](#fn-specremotewritequeueconfigwithmaxshards) + * [`fn withMinBackoff(minBackoff)`](#fn-specremotewritequeueconfigwithminbackoff) + * [`fn withMinShards(minShards)`](#fn-specremotewritequeueconfigwithminshards) + * [`fn withRetryOnRateLimit(retryOnRateLimit)`](#fn-specremotewritequeueconfigwithretryonratelimit) + * [`fn withSampleAgeLimit(sampleAgeLimit)`](#fn-specremotewritequeueconfigwithsampleagelimit) + * [`obj spec.remoteWrite.sigv4`](#obj-specremotewritesigv4) + * [`fn withProfile(profile)`](#fn-specremotewritesigv4withprofile) + * [`fn withRegion(region)`](#fn-specremotewritesigv4withregion) + * [`fn withRoleArn(roleArn)`](#fn-specremotewritesigv4withrolearn) + * [`obj spec.remoteWrite.sigv4.accessKey`](#obj-specremotewritesigv4accesskey) + * [`fn withKey(key)`](#fn-specremotewritesigv4accesskeywithkey) + * [`fn withName(name)`](#fn-specremotewritesigv4accesskeywithname) + * [`fn withOptional(optional)`](#fn-specremotewritesigv4accesskeywithoptional) + * [`obj spec.remoteWrite.sigv4.secretKey`](#obj-specremotewritesigv4secretkey) + * [`fn withKey(key)`](#fn-specremotewritesigv4secretkeywithkey) + * [`fn withName(name)`](#fn-specremotewritesigv4secretkeywithname) + * [`fn withOptional(optional)`](#fn-specremotewritesigv4secretkeywithoptional) + * [`obj spec.remoteWrite.tlsConfig`](#obj-specremotewritetlsconfig) + * [`fn withCaFile(caFile)`](#fn-specremotewritetlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specremotewritetlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specremotewritetlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specremotewritetlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specremotewritetlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specremotewritetlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specremotewritetlsconfigwithservername) + * [`obj spec.remoteWrite.tlsConfig.ca`](#obj-specremotewritetlsconfigca) + * [`obj spec.remoteWrite.tlsConfig.ca.configMap`](#obj-specremotewritetlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigcaconfigmapwithoptional) + * [`obj spec.remoteWrite.tlsConfig.ca.secret`](#obj-specremotewritetlsconfigcasecret) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigcasecretwithoptional) + * [`obj spec.remoteWrite.tlsConfig.cert`](#obj-specremotewritetlsconfigcert) + * [`obj spec.remoteWrite.tlsConfig.cert.configMap`](#obj-specremotewritetlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigcertconfigmapwithoptional) + * [`obj spec.remoteWrite.tlsConfig.cert.secret`](#obj-specremotewritetlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigcertsecretwithoptional) + * [`obj spec.remoteWrite.tlsConfig.keySecret`](#obj-specremotewritetlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specremotewritetlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specremotewritetlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specremotewritetlsconfigkeysecretwithoptional) + * [`obj spec.remoteWrite.writeRelabelConfigs`](#obj-specremotewritewriterelabelconfigs) + * [`fn withAction(action)`](#fn-specremotewritewriterelabelconfigswithaction) + * [`fn withModulus(modulus)`](#fn-specremotewritewriterelabelconfigswithmodulus) + * [`fn withRegex(regex)`](#fn-specremotewritewriterelabelconfigswithregex) + * [`fn withReplacement(replacement)`](#fn-specremotewritewriterelabelconfigswithreplacement) + * [`fn withSeparator(separator)`](#fn-specremotewritewriterelabelconfigswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specremotewritewriterelabelconfigswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specremotewritewriterelabelconfigswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specremotewritewriterelabelconfigswithtargetlabel) + * [`obj spec.resources`](#obj-specresources) + * [`fn withClaims(claims)`](#fn-specresourceswithclaims) + * [`fn withClaimsMixin(claims)`](#fn-specresourceswithclaimsmixin) + * [`fn withLimits(limits)`](#fn-specresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specresourceswithrequestsmixin) + * [`obj spec.resources.claims`](#obj-specresourcesclaims) + * [`fn withName(name)`](#fn-specresourcesclaimswithname) + * [`obj spec.scrapeClasses`](#obj-specscrapeclasses) + * [`fn withDefault(default)`](#fn-specscrapeclasseswithdefault) + * [`fn withMetricRelabelings(metricRelabelings)`](#fn-specscrapeclasseswithmetricrelabelings) + * [`fn withMetricRelabelingsMixin(metricRelabelings)`](#fn-specscrapeclasseswithmetricrelabelingsmixin) + * [`fn withName(name)`](#fn-specscrapeclasseswithname) + * [`fn withRelabelings(relabelings)`](#fn-specscrapeclasseswithrelabelings) + * [`fn withRelabelingsMixin(relabelings)`](#fn-specscrapeclasseswithrelabelingsmixin) + * [`obj spec.scrapeClasses.attachMetadata`](#obj-specscrapeclassesattachmetadata) + * [`fn withNode(node)`](#fn-specscrapeclassesattachmetadatawithnode) + * [`obj spec.scrapeClasses.metricRelabelings`](#obj-specscrapeclassesmetricrelabelings) + * [`fn withAction(action)`](#fn-specscrapeclassesmetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specscrapeclassesmetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specscrapeclassesmetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specscrapeclassesmetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specscrapeclassesmetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specscrapeclassesmetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specscrapeclassesmetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specscrapeclassesmetricrelabelingswithtargetlabel) + * [`obj spec.scrapeClasses.relabelings`](#obj-specscrapeclassesrelabelings) + * [`fn withAction(action)`](#fn-specscrapeclassesrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specscrapeclassesrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specscrapeclassesrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specscrapeclassesrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specscrapeclassesrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specscrapeclassesrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specscrapeclassesrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specscrapeclassesrelabelingswithtargetlabel) + * [`obj spec.scrapeClasses.tlsConfig`](#obj-specscrapeclassestlsconfig) + * [`fn withCaFile(caFile)`](#fn-specscrapeclassestlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-specscrapeclassestlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specscrapeclassestlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-specscrapeclassestlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-specscrapeclassestlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specscrapeclassestlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specscrapeclassestlsconfigwithservername) + * [`obj spec.scrapeClasses.tlsConfig.ca`](#obj-specscrapeclassestlsconfigca) + * [`obj spec.scrapeClasses.tlsConfig.ca.configMap`](#obj-specscrapeclassestlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigcaconfigmapwithoptional) + * [`obj spec.scrapeClasses.tlsConfig.ca.secret`](#obj-specscrapeclassestlsconfigcasecret) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigcasecretwithoptional) + * [`obj spec.scrapeClasses.tlsConfig.cert`](#obj-specscrapeclassestlsconfigcert) + * [`obj spec.scrapeClasses.tlsConfig.cert.configMap`](#obj-specscrapeclassestlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigcertconfigmapwithoptional) + * [`obj spec.scrapeClasses.tlsConfig.cert.secret`](#obj-specscrapeclassestlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigcertsecretwithoptional) + * [`obj spec.scrapeClasses.tlsConfig.keySecret`](#obj-specscrapeclassestlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specscrapeclassestlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specscrapeclassestlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specscrapeclassestlsconfigkeysecretwithoptional) + * [`obj spec.scrapeConfigNamespaceSelector`](#obj-specscrapeconfignamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specscrapeconfignamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specscrapeconfignamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specscrapeconfignamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specscrapeconfignamespaceselectorwithmatchlabelsmixin) + * [`obj spec.scrapeConfigNamespaceSelector.matchExpressions`](#obj-specscrapeconfignamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specscrapeconfignamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specscrapeconfignamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specscrapeconfignamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specscrapeconfignamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.scrapeConfigSelector`](#obj-specscrapeconfigselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specscrapeconfigselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specscrapeconfigselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specscrapeconfigselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specscrapeconfigselectorwithmatchlabelsmixin) + * [`obj spec.scrapeConfigSelector.matchExpressions`](#obj-specscrapeconfigselectormatchexpressions) + * [`fn withKey(key)`](#fn-specscrapeconfigselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specscrapeconfigselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specscrapeconfigselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specscrapeconfigselectormatchexpressionswithvaluesmixin) + * [`obj spec.securityContext`](#obj-specsecuritycontext) + * [`fn withFsGroup(fsGroup)`](#fn-specsecuritycontextwithfsgroup) + * [`fn withFsGroupChangePolicy(fsGroupChangePolicy)`](#fn-specsecuritycontextwithfsgroupchangepolicy) + * [`fn withRunAsGroup(runAsGroup)`](#fn-specsecuritycontextwithrunasgroup) + * [`fn withRunAsNonRoot(runAsNonRoot)`](#fn-specsecuritycontextwithrunasnonroot) + * [`fn withRunAsUser(runAsUser)`](#fn-specsecuritycontextwithrunasuser) + * [`fn withSupplementalGroups(supplementalGroups)`](#fn-specsecuritycontextwithsupplementalgroups) + * [`fn withSupplementalGroupsMixin(supplementalGroups)`](#fn-specsecuritycontextwithsupplementalgroupsmixin) + * [`fn withSysctls(sysctls)`](#fn-specsecuritycontextwithsysctls) + * [`fn withSysctlsMixin(sysctls)`](#fn-specsecuritycontextwithsysctlsmixin) + * [`obj spec.securityContext.appArmorProfile`](#obj-specsecuritycontextapparmorprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specsecuritycontextapparmorprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specsecuritycontextapparmorprofilewithtype) + * [`obj spec.securityContext.seLinuxOptions`](#obj-specsecuritycontextselinuxoptions) + * [`fn withLevel(level)`](#fn-specsecuritycontextselinuxoptionswithlevel) + * [`fn withRole(role)`](#fn-specsecuritycontextselinuxoptionswithrole) + * [`fn withType(type)`](#fn-specsecuritycontextselinuxoptionswithtype) + * [`fn withUser(user)`](#fn-specsecuritycontextselinuxoptionswithuser) + * [`obj spec.securityContext.seccompProfile`](#obj-specsecuritycontextseccompprofile) + * [`fn withLocalhostProfile(localhostProfile)`](#fn-specsecuritycontextseccompprofilewithlocalhostprofile) + * [`fn withType(type)`](#fn-specsecuritycontextseccompprofilewithtype) + * [`obj spec.securityContext.sysctls`](#obj-specsecuritycontextsysctls) + * [`fn withName(name)`](#fn-specsecuritycontextsysctlswithname) + * [`fn withValue(value)`](#fn-specsecuritycontextsysctlswithvalue) + * [`obj spec.securityContext.windowsOptions`](#obj-specsecuritycontextwindowsoptions) + * [`fn withGmsaCredentialSpec(gmsaCredentialSpec)`](#fn-specsecuritycontextwindowsoptionswithgmsacredentialspec) + * [`fn withGmsaCredentialSpecName(gmsaCredentialSpecName)`](#fn-specsecuritycontextwindowsoptionswithgmsacredentialspecname) + * [`fn withHostProcess(hostProcess)`](#fn-specsecuritycontextwindowsoptionswithhostprocess) + * [`fn withRunAsUserName(runAsUserName)`](#fn-specsecuritycontextwindowsoptionswithrunasusername) + * [`obj spec.serviceMonitorNamespaceSelector`](#obj-specservicemonitornamespaceselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specservicemonitornamespaceselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specservicemonitornamespaceselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specservicemonitornamespaceselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specservicemonitornamespaceselectorwithmatchlabelsmixin) + * [`obj spec.serviceMonitorNamespaceSelector.matchExpressions`](#obj-specservicemonitornamespaceselectormatchexpressions) + * [`fn withKey(key)`](#fn-specservicemonitornamespaceselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specservicemonitornamespaceselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specservicemonitornamespaceselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specservicemonitornamespaceselectormatchexpressionswithvaluesmixin) + * [`obj spec.serviceMonitorSelector`](#obj-specservicemonitorselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specservicemonitorselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specservicemonitorselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specservicemonitorselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specservicemonitorselectorwithmatchlabelsmixin) + * [`obj spec.serviceMonitorSelector.matchExpressions`](#obj-specservicemonitorselectormatchexpressions) + * [`fn withKey(key)`](#fn-specservicemonitorselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specservicemonitorselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specservicemonitorselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specservicemonitorselectormatchexpressionswithvaluesmixin) + * [`obj spec.storage`](#obj-specstorage) + * [`fn withDisableMountSubPath(disableMountSubPath)`](#fn-specstoragewithdisablemountsubpath) + * [`obj spec.storage.emptyDir`](#obj-specstorageemptydir) + * [`fn withMedium(medium)`](#fn-specstorageemptydirwithmedium) + * [`fn withSizeLimit(sizeLimit)`](#fn-specstorageemptydirwithsizelimit) + * [`obj spec.storage.ephemeral`](#obj-specstorageephemeral) + * [`obj spec.storage.ephemeral.volumeClaimTemplate`](#obj-specstorageephemeralvolumeclaimtemplate) + * [`fn withMetadata(metadata)`](#fn-specstorageephemeralvolumeclaimtemplatewithmetadata) + * [`fn withMetadataMixin(metadata)`](#fn-specstorageephemeralvolumeclaimtemplatewithmetadatamixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec`](#obj-specstorageephemeralvolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specstorageephemeralvolumeclaimtemplatespecwithvolumename) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource`](#obj-specstorageephemeralvolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef`](#obj-specstorageephemeralvolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specstorageephemeralvolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.resources`](#obj-specstorageephemeralvolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specstorageephemeralvolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector`](#obj-specstorageephemeralvolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specstorageephemeralvolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.storage.volumeClaimTemplate`](#obj-specstoragevolumeclaimtemplate) + * [`fn withApiVersion(apiVersion)`](#fn-specstoragevolumeclaimtemplatewithapiversion) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatewithkind) + * [`obj spec.storage.volumeClaimTemplate.metadata`](#obj-specstoragevolumeclaimtemplatemetadata) + * [`fn withAnnotations(annotations)`](#fn-specstoragevolumeclaimtemplatemetadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-specstoragevolumeclaimtemplatemetadatawithannotationsmixin) + * [`fn withLabels(labels)`](#fn-specstoragevolumeclaimtemplatemetadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specstoragevolumeclaimtemplatemetadatawithlabelsmixin) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatemetadatawithname) + * [`obj spec.storage.volumeClaimTemplate.spec`](#obj-specstoragevolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specstoragevolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specstoragevolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specstoragevolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specstoragevolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specstoragevolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specstoragevolumeclaimtemplatespecwithvolumename) + * [`obj spec.storage.volumeClaimTemplate.spec.dataSource`](#obj-specstoragevolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.storage.volumeClaimTemplate.spec.dataSourceRef`](#obj-specstoragevolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specstoragevolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.storage.volumeClaimTemplate.spec.resources`](#obj-specstoragevolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specstoragevolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specstoragevolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specstoragevolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specstoragevolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.storage.volumeClaimTemplate.spec.selector`](#obj-specstoragevolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specstoragevolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.storage.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specstoragevolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specstoragevolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.tolerations`](#obj-spectolerations) + * [`fn withEffect(effect)`](#fn-spectolerationswitheffect) + * [`fn withKey(key)`](#fn-spectolerationswithkey) + * [`fn withOperator(operator)`](#fn-spectolerationswithoperator) + * [`fn withTolerationSeconds(tolerationSeconds)`](#fn-spectolerationswithtolerationseconds) + * [`fn withValue(value)`](#fn-spectolerationswithvalue) + * [`obj spec.topologySpreadConstraints`](#obj-spectopologyspreadconstraints) + * [`fn withAdditionalLabelSelectors(additionalLabelSelectors)`](#fn-spectopologyspreadconstraintswithadditionallabelselectors) + * [`fn withMatchLabelKeys(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeys) + * [`fn withMatchLabelKeysMixin(matchLabelKeys)`](#fn-spectopologyspreadconstraintswithmatchlabelkeysmixin) + * [`fn withMaxSkew(maxSkew)`](#fn-spectopologyspreadconstraintswithmaxskew) + * [`fn withMinDomains(minDomains)`](#fn-spectopologyspreadconstraintswithmindomains) + * [`fn withNodeAffinityPolicy(nodeAffinityPolicy)`](#fn-spectopologyspreadconstraintswithnodeaffinitypolicy) + * [`fn withNodeTaintsPolicy(nodeTaintsPolicy)`](#fn-spectopologyspreadconstraintswithnodetaintspolicy) + * [`fn withTopologyKey(topologyKey)`](#fn-spectopologyspreadconstraintswithtopologykey) + * [`fn withWhenUnsatisfiable(whenUnsatisfiable)`](#fn-spectopologyspreadconstraintswithwhenunsatisfiable) + * [`obj spec.topologySpreadConstraints.labelSelector`](#obj-spectopologyspreadconstraintslabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-spectopologyspreadconstraintslabelselectorwithmatchlabelsmixin) + * [`obj spec.topologySpreadConstraints.labelSelector.matchExpressions`](#obj-spectopologyspreadconstraintslabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-spectopologyspreadconstraintslabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.tracingConfig`](#obj-spectracingconfig) + * [`fn withClientType(clientType)`](#fn-spectracingconfigwithclienttype) + * [`fn withCompression(compression)`](#fn-spectracingconfigwithcompression) + * [`fn withEndpoint(endpoint)`](#fn-spectracingconfigwithendpoint) + * [`fn withHeaders(headers)`](#fn-spectracingconfigwithheaders) + * [`fn withHeadersMixin(headers)`](#fn-spectracingconfigwithheadersmixin) + * [`fn withInsecure(insecure)`](#fn-spectracingconfigwithinsecure) + * [`fn withSamplingFraction(samplingFraction)`](#fn-spectracingconfigwithsamplingfraction) + * [`fn withTimeout(timeout)`](#fn-spectracingconfigwithtimeout) + * [`obj spec.tracingConfig.tlsConfig`](#obj-spectracingconfigtlsconfig) + * [`fn withCaFile(caFile)`](#fn-spectracingconfigtlsconfigwithcafile) + * [`fn withCertFile(certFile)`](#fn-spectracingconfigtlsconfigwithcertfile) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-spectracingconfigtlsconfigwithinsecureskipverify) + * [`fn withKeyFile(keyFile)`](#fn-spectracingconfigtlsconfigwithkeyfile) + * [`fn withMaxVersion(maxVersion)`](#fn-spectracingconfigtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-spectracingconfigtlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-spectracingconfigtlsconfigwithservername) + * [`obj spec.tracingConfig.tlsConfig.ca`](#obj-spectracingconfigtlsconfigca) + * [`obj spec.tracingConfig.tlsConfig.ca.configMap`](#obj-spectracingconfigtlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigcaconfigmapwithoptional) + * [`obj spec.tracingConfig.tlsConfig.ca.secret`](#obj-spectracingconfigtlsconfigcasecret) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigcasecretwithoptional) + * [`obj spec.tracingConfig.tlsConfig.cert`](#obj-spectracingconfigtlsconfigcert) + * [`obj spec.tracingConfig.tlsConfig.cert.configMap`](#obj-spectracingconfigtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigcertconfigmapwithoptional) + * [`obj spec.tracingConfig.tlsConfig.cert.secret`](#obj-spectracingconfigtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigcertsecretwithoptional) + * [`obj spec.tracingConfig.tlsConfig.keySecret`](#obj-spectracingconfigtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-spectracingconfigtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-spectracingconfigtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-spectracingconfigtlsconfigkeysecretwithoptional) + * [`obj spec.volumeMounts`](#obj-specvolumemounts) + * [`fn withMountPath(mountPath)`](#fn-specvolumemountswithmountpath) + * [`fn withMountPropagation(mountPropagation)`](#fn-specvolumemountswithmountpropagation) + * [`fn withName(name)`](#fn-specvolumemountswithname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumemountswithreadonly) + * [`fn withRecursiveReadOnly(recursiveReadOnly)`](#fn-specvolumemountswithrecursivereadonly) + * [`fn withSubPath(subPath)`](#fn-specvolumemountswithsubpath) + * [`fn withSubPathExpr(subPathExpr)`](#fn-specvolumemountswithsubpathexpr) + * [`obj spec.volumes`](#obj-specvolumes) + * [`fn withName(name)`](#fn-specvolumeswithname) + * [`obj spec.volumes.awsElasticBlockStore`](#obj-specvolumesawselasticblockstore) + * [`fn withFsType(fsType)`](#fn-specvolumesawselasticblockstorewithfstype) + * [`fn withPartition(partition)`](#fn-specvolumesawselasticblockstorewithpartition) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesawselasticblockstorewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumesawselasticblockstorewithvolumeid) + * [`obj spec.volumes.azureDisk`](#obj-specvolumesazuredisk) + * [`fn withCachingMode(cachingMode)`](#fn-specvolumesazurediskwithcachingmode) + * [`fn withDiskName(diskName)`](#fn-specvolumesazurediskwithdiskname) + * [`fn withDiskURI(diskURI)`](#fn-specvolumesazurediskwithdiskuri) + * [`fn withFsType(fsType)`](#fn-specvolumesazurediskwithfstype) + * [`fn withKind(kind)`](#fn-specvolumesazurediskwithkind) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesazurediskwithreadonly) + * [`obj spec.volumes.azureFile`](#obj-specvolumesazurefile) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesazurefilewithreadonly) + * [`fn withSecretName(secretName)`](#fn-specvolumesazurefilewithsecretname) + * [`fn withShareName(shareName)`](#fn-specvolumesazurefilewithsharename) + * [`obj spec.volumes.cephfs`](#obj-specvolumescephfs) + * [`fn withMonitors(monitors)`](#fn-specvolumescephfswithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specvolumescephfswithmonitorsmixin) + * [`fn withPath(path)`](#fn-specvolumescephfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescephfswithreadonly) + * [`fn withSecretFile(secretFile)`](#fn-specvolumescephfswithsecretfile) + * [`fn withUser(user)`](#fn-specvolumescephfswithuser) + * [`obj spec.volumes.cephfs.secretRef`](#obj-specvolumescephfssecretref) + * [`fn withName(name)`](#fn-specvolumescephfssecretrefwithname) + * [`obj spec.volumes.cinder`](#obj-specvolumescinder) + * [`fn withFsType(fsType)`](#fn-specvolumescinderwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescinderwithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumescinderwithvolumeid) + * [`obj spec.volumes.cinder.secretRef`](#obj-specvolumescindersecretref) + * [`fn withName(name)`](#fn-specvolumescindersecretrefwithname) + * [`obj spec.volumes.configMap`](#obj-specvolumesconfigmap) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesconfigmapwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specvolumesconfigmapwithoptional) + * [`obj spec.volumes.configMap.items`](#obj-specvolumesconfigmapitems) + * [`fn withKey(key)`](#fn-specvolumesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesconfigmapitemswithpath) + * [`obj spec.volumes.csi`](#obj-specvolumescsi) + * [`fn withDriver(driver)`](#fn-specvolumescsiwithdriver) + * [`fn withFsType(fsType)`](#fn-specvolumescsiwithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumescsiwithreadonly) + * [`fn withVolumeAttributes(volumeAttributes)`](#fn-specvolumescsiwithvolumeattributes) + * [`fn withVolumeAttributesMixin(volumeAttributes)`](#fn-specvolumescsiwithvolumeattributesmixin) + * [`obj spec.volumes.csi.nodePublishSecretRef`](#obj-specvolumescsinodepublishsecretref) + * [`fn withName(name)`](#fn-specvolumescsinodepublishsecretrefwithname) + * [`obj spec.volumes.downwardAPI`](#obj-specvolumesdownwardapi) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesdownwardapiwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesdownwardapiwithitemsmixin) + * [`obj spec.volumes.downwardAPI.items`](#obj-specvolumesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specvolumesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesdownwardapiitemswithpath) + * [`obj spec.volumes.downwardAPI.items.fieldRef`](#obj-specvolumesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specvolumesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specvolumesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.volumes.downwardAPI.items.resourceFieldRef`](#obj-specvolumesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specvolumesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.volumes.emptyDir`](#obj-specvolumesemptydir) + * [`fn withMedium(medium)`](#fn-specvolumesemptydirwithmedium) + * [`fn withSizeLimit(sizeLimit)`](#fn-specvolumesemptydirwithsizelimit) + * [`obj spec.volumes.ephemeral`](#obj-specvolumesephemeral) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate`](#obj-specvolumesephemeralvolumeclaimtemplate) + * [`fn withMetadata(metadata)`](#fn-specvolumesephemeralvolumeclaimtemplatewithmetadata) + * [`fn withMetadataMixin(metadata)`](#fn-specvolumesephemeralvolumeclaimtemplatewithmetadatamixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec`](#obj-specvolumesephemeralvolumeclaimtemplatespec) + * [`fn withAccessModes(accessModes)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithaccessmodes) + * [`fn withAccessModesMixin(accessModes)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithaccessmodesmixin) + * [`fn withStorageClassName(storageClassName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithstorageclassname) + * [`fn withVolumeAttributesClassName(volumeAttributesClassName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumeattributesclassname) + * [`fn withVolumeMode(volumeMode)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumemode) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesephemeralvolumeclaimtemplatespecwithvolumename) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource`](#obj-specvolumesephemeralvolumeclaimtemplatespecdatasource) + * [`fn withApiGroup(apiGroup)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithapigroup) + * [`fn withKind(kind)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithkind) + * [`fn withName(name)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcewithname) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef`](#obj-specvolumesephemeralvolumeclaimtemplatespecdatasourceref) + * [`fn withApiGroup(apiGroup)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithapigroup) + * [`fn withKind(kind)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithkind) + * [`fn withName(name)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithname) + * [`fn withNamespace(namespace)`](#fn-specvolumesephemeralvolumeclaimtemplatespecdatasourcerefwithnamespace) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.resources`](#obj-specvolumesephemeralvolumeclaimtemplatespecresources) + * [`fn withLimits(limits)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithlimits) + * [`fn withLimitsMixin(limits)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithlimitsmixin) + * [`fn withRequests(requests)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithrequests) + * [`fn withRequestsMixin(requests)`](#fn-specvolumesephemeralvolumeclaimtemplatespecresourceswithrequestsmixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector`](#obj-specvolumesephemeralvolumeclaimtemplatespecselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectorwithmatchlabelsmixin) + * [`obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions`](#obj-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressions) + * [`fn withKey(key)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specvolumesephemeralvolumeclaimtemplatespecselectormatchexpressionswithvaluesmixin) + * [`obj spec.volumes.fc`](#obj-specvolumesfc) + * [`fn withFsType(fsType)`](#fn-specvolumesfcwithfstype) + * [`fn withLun(lun)`](#fn-specvolumesfcwithlun) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesfcwithreadonly) + * [`fn withTargetWWNs(targetWWNs)`](#fn-specvolumesfcwithtargetwwns) + * [`fn withTargetWWNsMixin(targetWWNs)`](#fn-specvolumesfcwithtargetwwnsmixin) + * [`fn withWwids(wwids)`](#fn-specvolumesfcwithwwids) + * [`fn withWwidsMixin(wwids)`](#fn-specvolumesfcwithwwidsmixin) + * [`obj spec.volumes.flexVolume`](#obj-specvolumesflexvolume) + * [`fn withDriver(driver)`](#fn-specvolumesflexvolumewithdriver) + * [`fn withFsType(fsType)`](#fn-specvolumesflexvolumewithfstype) + * [`fn withOptions(options)`](#fn-specvolumesflexvolumewithoptions) + * [`fn withOptionsMixin(options)`](#fn-specvolumesflexvolumewithoptionsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesflexvolumewithreadonly) + * [`obj spec.volumes.flexVolume.secretRef`](#obj-specvolumesflexvolumesecretref) + * [`fn withName(name)`](#fn-specvolumesflexvolumesecretrefwithname) + * [`obj spec.volumes.flocker`](#obj-specvolumesflocker) + * [`fn withDatasetName(datasetName)`](#fn-specvolumesflockerwithdatasetname) + * [`fn withDatasetUUID(datasetUUID)`](#fn-specvolumesflockerwithdatasetuuid) + * [`obj spec.volumes.gcePersistentDisk`](#obj-specvolumesgcepersistentdisk) + * [`fn withFsType(fsType)`](#fn-specvolumesgcepersistentdiskwithfstype) + * [`fn withPartition(partition)`](#fn-specvolumesgcepersistentdiskwithpartition) + * [`fn withPdName(pdName)`](#fn-specvolumesgcepersistentdiskwithpdname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesgcepersistentdiskwithreadonly) + * [`obj spec.volumes.gitRepo`](#obj-specvolumesgitrepo) + * [`fn withDirectory(directory)`](#fn-specvolumesgitrepowithdirectory) + * [`fn withRepository(repository)`](#fn-specvolumesgitrepowithrepository) + * [`fn withRevision(revision)`](#fn-specvolumesgitrepowithrevision) + * [`obj spec.volumes.glusterfs`](#obj-specvolumesglusterfs) + * [`fn withEndpoints(endpoints)`](#fn-specvolumesglusterfswithendpoints) + * [`fn withPath(path)`](#fn-specvolumesglusterfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesglusterfswithreadonly) + * [`obj spec.volumes.hostPath`](#obj-specvolumeshostpath) + * [`fn withPath(path)`](#fn-specvolumeshostpathwithpath) + * [`fn withType(type)`](#fn-specvolumeshostpathwithtype) + * [`obj spec.volumes.iscsi`](#obj-specvolumesiscsi) + * [`fn withChapAuthDiscovery(chapAuthDiscovery)`](#fn-specvolumesiscsiwithchapauthdiscovery) + * [`fn withChapAuthSession(chapAuthSession)`](#fn-specvolumesiscsiwithchapauthsession) + * [`fn withFsType(fsType)`](#fn-specvolumesiscsiwithfstype) + * [`fn withInitiatorName(initiatorName)`](#fn-specvolumesiscsiwithinitiatorname) + * [`fn withIqn(iqn)`](#fn-specvolumesiscsiwithiqn) + * [`fn withIscsiInterface(iscsiInterface)`](#fn-specvolumesiscsiwithiscsiinterface) + * [`fn withLun(lun)`](#fn-specvolumesiscsiwithlun) + * [`fn withPortals(portals)`](#fn-specvolumesiscsiwithportals) + * [`fn withPortalsMixin(portals)`](#fn-specvolumesiscsiwithportalsmixin) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesiscsiwithreadonly) + * [`fn withTargetPortal(targetPortal)`](#fn-specvolumesiscsiwithtargetportal) + * [`obj spec.volumes.iscsi.secretRef`](#obj-specvolumesiscsisecretref) + * [`fn withName(name)`](#fn-specvolumesiscsisecretrefwithname) + * [`obj spec.volumes.nfs`](#obj-specvolumesnfs) + * [`fn withPath(path)`](#fn-specvolumesnfswithpath) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesnfswithreadonly) + * [`fn withServer(server)`](#fn-specvolumesnfswithserver) + * [`obj spec.volumes.persistentVolumeClaim`](#obj-specvolumespersistentvolumeclaim) + * [`fn withClaimName(claimName)`](#fn-specvolumespersistentvolumeclaimwithclaimname) + * [`fn withReadOnly(readOnly)`](#fn-specvolumespersistentvolumeclaimwithreadonly) + * [`obj spec.volumes.photonPersistentDisk`](#obj-specvolumesphotonpersistentdisk) + * [`fn withFsType(fsType)`](#fn-specvolumesphotonpersistentdiskwithfstype) + * [`fn withPdID(pdID)`](#fn-specvolumesphotonpersistentdiskwithpdid) + * [`obj spec.volumes.portworxVolume`](#obj-specvolumesportworxvolume) + * [`fn withFsType(fsType)`](#fn-specvolumesportworxvolumewithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesportworxvolumewithreadonly) + * [`fn withVolumeID(volumeID)`](#fn-specvolumesportworxvolumewithvolumeid) + * [`obj spec.volumes.projected`](#obj-specvolumesprojected) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumesprojectedwithdefaultmode) + * [`fn withSources(sources)`](#fn-specvolumesprojectedwithsources) + * [`fn withSourcesMixin(sources)`](#fn-specvolumesprojectedwithsourcesmixin) + * [`obj spec.volumes.projected.sources`](#obj-specvolumesprojectedsources) + * [`obj spec.volumes.projected.sources.clusterTrustBundle`](#obj-specvolumesprojectedsourcesclustertrustbundle) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithoptional) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithpath) + * [`fn withSignerName(signerName)`](#fn-specvolumesprojectedsourcesclustertrustbundlewithsignername) + * [`obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector`](#obj-specvolumesprojectedsourcesclustertrustbundlelabelselector) + * [`fn withMatchExpressions(matchExpressions)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchexpressions) + * [`fn withMatchExpressionsMixin(matchExpressions)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchexpressionsmixin) + * [`fn withMatchLabels(matchLabels)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchlabels) + * [`fn withMatchLabelsMixin(matchLabels)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectorwithmatchlabelsmixin) + * [`obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions`](#obj-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressions) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithkey) + * [`fn withOperator(operator)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithoperator) + * [`fn withValues(values)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithvalues) + * [`fn withValuesMixin(values)`](#fn-specvolumesprojectedsourcesclustertrustbundlelabelselectormatchexpressionswithvaluesmixin) + * [`obj spec.volumes.projected.sources.configMap`](#obj-specvolumesprojectedsourcesconfigmap) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcesconfigmapwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcesconfigmapwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcesconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcesconfigmapwithoptional) + * [`obj spec.volumes.projected.sources.configMap.items`](#obj-specvolumesprojectedsourcesconfigmapitems) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcesconfigmapitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcesconfigmapitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesconfigmapitemswithpath) + * [`obj spec.volumes.projected.sources.downwardAPI`](#obj-specvolumesprojectedsourcesdownwardapi) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcesdownwardapiwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcesdownwardapiwithitemsmixin) + * [`obj spec.volumes.projected.sources.downwardAPI.items`](#obj-specvolumesprojectedsourcesdownwardapiitems) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcesdownwardapiitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesdownwardapiitemswithpath) + * [`obj spec.volumes.projected.sources.downwardAPI.items.fieldRef`](#obj-specvolumesprojectedsourcesdownwardapiitemsfieldref) + * [`fn withApiVersion(apiVersion)`](#fn-specvolumesprojectedsourcesdownwardapiitemsfieldrefwithapiversion) + * [`fn withFieldPath(fieldPath)`](#fn-specvolumesprojectedsourcesdownwardapiitemsfieldrefwithfieldpath) + * [`obj spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef`](#obj-specvolumesprojectedsourcesdownwardapiitemsresourcefieldref) + * [`fn withContainerName(containerName)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithcontainername) + * [`fn withDivisor(divisor)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithdivisor) + * [`fn withResource(resource)`](#fn-specvolumesprojectedsourcesdownwardapiitemsresourcefieldrefwithresource) + * [`obj spec.volumes.projected.sources.secret`](#obj-specvolumesprojectedsourcessecret) + * [`fn withItems(items)`](#fn-specvolumesprojectedsourcessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumesprojectedsourcessecretwithitemsmixin) + * [`fn withName(name)`](#fn-specvolumesprojectedsourcessecretwithname) + * [`fn withOptional(optional)`](#fn-specvolumesprojectedsourcessecretwithoptional) + * [`obj spec.volumes.projected.sources.secret.items`](#obj-specvolumesprojectedsourcessecretitems) + * [`fn withKey(key)`](#fn-specvolumesprojectedsourcessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumesprojectedsourcessecretitemswithmode) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcessecretitemswithpath) + * [`obj spec.volumes.projected.sources.serviceAccountToken`](#obj-specvolumesprojectedsourcesserviceaccounttoken) + * [`fn withAudience(audience)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithaudience) + * [`fn withExpirationSeconds(expirationSeconds)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithexpirationseconds) + * [`fn withPath(path)`](#fn-specvolumesprojectedsourcesserviceaccounttokenwithpath) + * [`obj spec.volumes.quobyte`](#obj-specvolumesquobyte) + * [`fn withGroup(group)`](#fn-specvolumesquobytewithgroup) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesquobytewithreadonly) + * [`fn withRegistry(registry)`](#fn-specvolumesquobytewithregistry) + * [`fn withTenant(tenant)`](#fn-specvolumesquobytewithtenant) + * [`fn withUser(user)`](#fn-specvolumesquobytewithuser) + * [`fn withVolume(volume)`](#fn-specvolumesquobytewithvolume) + * [`obj spec.volumes.rbd`](#obj-specvolumesrbd) + * [`fn withFsType(fsType)`](#fn-specvolumesrbdwithfstype) + * [`fn withImage(image)`](#fn-specvolumesrbdwithimage) + * [`fn withKeyring(keyring)`](#fn-specvolumesrbdwithkeyring) + * [`fn withMonitors(monitors)`](#fn-specvolumesrbdwithmonitors) + * [`fn withMonitorsMixin(monitors)`](#fn-specvolumesrbdwithmonitorsmixin) + * [`fn withPool(pool)`](#fn-specvolumesrbdwithpool) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesrbdwithreadonly) + * [`fn withUser(user)`](#fn-specvolumesrbdwithuser) + * [`obj spec.volumes.rbd.secretRef`](#obj-specvolumesrbdsecretref) + * [`fn withName(name)`](#fn-specvolumesrbdsecretrefwithname) + * [`obj spec.volumes.scaleIO`](#obj-specvolumesscaleio) + * [`fn withFsType(fsType)`](#fn-specvolumesscaleiowithfstype) + * [`fn withGateway(gateway)`](#fn-specvolumesscaleiowithgateway) + * [`fn withProtectionDomain(protectionDomain)`](#fn-specvolumesscaleiowithprotectiondomain) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesscaleiowithreadonly) + * [`fn withSslEnabled(sslEnabled)`](#fn-specvolumesscaleiowithsslenabled) + * [`fn withStorageMode(storageMode)`](#fn-specvolumesscaleiowithstoragemode) + * [`fn withStoragePool(storagePool)`](#fn-specvolumesscaleiowithstoragepool) + * [`fn withSystem(system)`](#fn-specvolumesscaleiowithsystem) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesscaleiowithvolumename) + * [`obj spec.volumes.scaleIO.secretRef`](#obj-specvolumesscaleiosecretref) + * [`fn withName(name)`](#fn-specvolumesscaleiosecretrefwithname) + * [`obj spec.volumes.secret`](#obj-specvolumessecret) + * [`fn withDefaultMode(defaultMode)`](#fn-specvolumessecretwithdefaultmode) + * [`fn withItems(items)`](#fn-specvolumessecretwithitems) + * [`fn withItemsMixin(items)`](#fn-specvolumessecretwithitemsmixin) + * [`fn withOptional(optional)`](#fn-specvolumessecretwithoptional) + * [`fn withSecretName(secretName)`](#fn-specvolumessecretwithsecretname) + * [`obj spec.volumes.secret.items`](#obj-specvolumessecretitems) + * [`fn withKey(key)`](#fn-specvolumessecretitemswithkey) + * [`fn withMode(mode)`](#fn-specvolumessecretitemswithmode) + * [`fn withPath(path)`](#fn-specvolumessecretitemswithpath) + * [`obj spec.volumes.storageos`](#obj-specvolumesstorageos) + * [`fn withFsType(fsType)`](#fn-specvolumesstorageoswithfstype) + * [`fn withReadOnly(readOnly)`](#fn-specvolumesstorageoswithreadonly) + * [`fn withVolumeName(volumeName)`](#fn-specvolumesstorageoswithvolumename) + * [`fn withVolumeNamespace(volumeNamespace)`](#fn-specvolumesstorageoswithvolumenamespace) + * [`obj spec.volumes.storageos.secretRef`](#obj-specvolumesstorageossecretref) + * [`fn withName(name)`](#fn-specvolumesstorageossecretrefwithname) + * [`obj spec.volumes.vsphereVolume`](#obj-specvolumesvspherevolume) + * [`fn withFsType(fsType)`](#fn-specvolumesvspherevolumewithfstype) + * [`fn withStoragePolicyID(storagePolicyID)`](#fn-specvolumesvspherevolumewithstoragepolicyid) + * [`fn withStoragePolicyName(storagePolicyName)`](#fn-specvolumesvspherevolumewithstoragepolicyname) + * [`fn withVolumePath(volumePath)`](#fn-specvolumesvspherevolumewithvolumepath) + * [`obj spec.web`](#obj-specweb) + * [`fn withMaxConnections(maxConnections)`](#fn-specwebwithmaxconnections) + * [`fn withPageTitle(pageTitle)`](#fn-specwebwithpagetitle) + * [`obj spec.web.httpConfig`](#obj-specwebhttpconfig) + * [`fn withHttp2(http2)`](#fn-specwebhttpconfigwithhttp2) + * [`obj spec.web.httpConfig.headers`](#obj-specwebhttpconfigheaders) + * [`fn withContentSecurityPolicy(contentSecurityPolicy)`](#fn-specwebhttpconfigheaderswithcontentsecuritypolicy) + * [`fn withStrictTransportSecurity(strictTransportSecurity)`](#fn-specwebhttpconfigheaderswithstricttransportsecurity) + * [`fn withXContentTypeOptions(xContentTypeOptions)`](#fn-specwebhttpconfigheaderswithxcontenttypeoptions) + * [`fn withXFrameOptions(xFrameOptions)`](#fn-specwebhttpconfigheaderswithxframeoptions) + * [`fn withXXSSProtection(xXSSProtection)`](#fn-specwebhttpconfigheaderswithxxssprotection) + * [`obj spec.web.tlsConfig`](#obj-specwebtlsconfig) + * [`fn withCipherSuites(cipherSuites)`](#fn-specwebtlsconfigwithciphersuites) + * [`fn withCipherSuitesMixin(cipherSuites)`](#fn-specwebtlsconfigwithciphersuitesmixin) + * [`fn withClientAuthType(clientAuthType)`](#fn-specwebtlsconfigwithclientauthtype) + * [`fn withCurvePreferences(curvePreferences)`](#fn-specwebtlsconfigwithcurvepreferences) + * [`fn withCurvePreferencesMixin(curvePreferences)`](#fn-specwebtlsconfigwithcurvepreferencesmixin) + * [`fn withMaxVersion(maxVersion)`](#fn-specwebtlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specwebtlsconfigwithminversion) + * [`fn withPreferServerCipherSuites(preferServerCipherSuites)`](#fn-specwebtlsconfigwithpreferserverciphersuites) + * [`obj spec.web.tlsConfig.cert`](#obj-specwebtlsconfigcert) + * [`obj spec.web.tlsConfig.cert.configMap`](#obj-specwebtlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specwebtlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigcertconfigmapwithoptional) + * [`obj spec.web.tlsConfig.cert.secret`](#obj-specwebtlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigcertsecretwithoptional) + * [`obj spec.web.tlsConfig.client_ca`](#obj-specwebtlsconfigclient_ca) + * [`obj spec.web.tlsConfig.client_ca.configMap`](#obj-specwebtlsconfigclient_caconfigmap) + * [`fn withKey(key)`](#fn-specwebtlsconfigclient_caconfigmapwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigclient_caconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigclient_caconfigmapwithoptional) + * [`obj spec.web.tlsConfig.client_ca.secret`](#obj-specwebtlsconfigclient_casecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigclient_casecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigclient_casecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigclient_casecretwithoptional) + * [`obj spec.web.tlsConfig.keySecret`](#obj-specwebtlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specwebtlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specwebtlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specwebtlsconfigkeysecretwithoptional) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of PrometheusAgent + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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 agent. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status" + +### fn spec.withAdditionalArgs + +```ts +withAdditionalArgs(additionalArgs) +``` + +"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\n\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged." + +### fn spec.withAdditionalArgsMixin + +```ts +withAdditionalArgsMixin(additionalArgs) +``` + +"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\n\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged." + +**Note:** This function appends passed data to existing values + +### fn spec.withAutomountServiceAccountToken + +```ts +withAutomountServiceAccountToken(automountServiceAccountToken) +``` + +"AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\nIf the field isn't set, the operator mounts the service account token by default.\n\n\n**Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery.\nIt is possible to use strategic merge patch to project the service account token into the 'prometheus' container." + +### fn spec.withBodySizeLimit + +```ts +withBodySizeLimit(bodySizeLimit) +``` + +"BodySizeLimit defines per-scrape on response body size.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit." + +### fn spec.withConfigMaps + +```ts +withConfigMaps(configMaps) +``` + +"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container." + +### fn spec.withConfigMapsMixin + +```ts +withConfigMapsMixin(configMaps) +``` + +"ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container." + +**Note:** This function appends passed data to existing values + +### fn spec.withContainers + +```ts +withContainers(containers) +``` + +"Containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +### fn spec.withContainersMixin + +```ts +withContainersMixin(containers) +``` + +"Containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +**Note:** This function appends passed data to existing values + +### fn spec.withEnableFeatures + +```ts +withEnableFeatures(enableFeatures) +``` + +"Enable access to Prometheus feature flags. By default, no features are enabled.\n\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\n\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/" + +### fn spec.withEnableFeaturesMixin + +```ts +withEnableFeaturesMixin(enableFeatures) +``` + +"Enable access to Prometheus feature flags. By default, no features are enabled.\n\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\n\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/" + +**Note:** This function appends passed data to existing values + +### fn spec.withEnableRemoteWriteReceiver + +```ts +withEnableRemoteWriteReceiver(enableRemoteWriteReceiver) +``` + +"Enable Prometheus to be used as a receiver for the Prometheus remote\nwrite protocol.\n\n\nWARNING: This is not considered an efficient way of ingesting samples.\nUse it with caution for specific low-volume use cases.\nIt is not suitable for replacing the ingestion via scraping and turning\nPrometheus into a push-based metrics collection system.\nFor more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver\n\n\nIt requires Prometheus >= v2.33.0." + +### fn spec.withEnforcedBodySizeLimit + +```ts +withEnforcedBodySizeLimit(enforcedBodySizeLimit) +``` + +"When defined, enforcedBodySizeLimit specifies a global limit on the size\nof uncompressed response body that will be accepted by Prometheus.\nTargets responding with a body larger than this many bytes will cause\nthe scrape to fail.\n\n\nIt requires Prometheus >= v2.28.0.\n\n\nWhen both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.\n* Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value.\n* Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit." + +### fn spec.withEnforcedKeepDroppedTargets + +```ts +withEnforcedKeepDroppedTargets(enforcedKeepDroppedTargets) +``` + +"When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets\ndropped by relabeling that will be kept in memory. The value overrides\nany `spec.keepDroppedTargets` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is\ngreater than zero and less than `spec.enforcedKeepDroppedTargets`.\n\n\nIt requires Prometheus >= v2.47.0.\n\n\nWhen both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.\n* Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value.\n* Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets." + +### fn spec.withEnforcedLabelLimit + +```ts +withEnforcedLabelLimit(enforcedLabelLimit) +``` + +"When defined, enforcedLabelLimit specifies a global limit on the number\nof labels per sample. The value overrides any `spec.labelLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is\ngreater than zero and less than `spec.enforcedLabelLimit`.\n\n\nIt requires Prometheus >= v2.27.0.\n\n\nWhen both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.\n* Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value.\n* Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit." + +### fn spec.withEnforcedLabelNameLengthLimit + +```ts +withEnforcedLabelNameLengthLimit(enforcedLabelNameLengthLimit) +``` + +"When defined, enforcedLabelNameLengthLimit specifies a global limit on the length\nof labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelNameLengthLimit`.\n\n\nIt requires Prometheus >= v2.27.0.\n\n\nWhen both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.\n* Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value.\n* Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit." + +### fn spec.withEnforcedLabelValueLengthLimit + +```ts +withEnforcedLabelValueLengthLimit(enforcedLabelValueLengthLimit) +``` + +"When not null, enforcedLabelValueLengthLimit defines a global limit on the length\nof labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelValueLengthLimit`.\n\n\nIt requires Prometheus >= v2.27.0.\n\n\nWhen both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.\n* Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value.\n* Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit." + +### fn spec.withEnforcedNamespaceLabel + +```ts +withEnforcedNamespaceLabel(enforcedNamespaceLabel) +``` + +"When not empty, a label will be added to:\n\n\n1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects.\n2. All metrics generated from recording rules defined in `PrometheusRule` objects.\n3. All alerts generated from alerting rules defined in `PrometheusRule` objects.\n4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.\n\n\nThe label will not added for objects referenced in `spec.excludedFromEnforcement`.\n\n\nThe label's name is this field's value.\nThe label's value is the namespace of the `ServiceMonitor`,\n`PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object." + +### fn spec.withEnforcedSampleLimit + +```ts +withEnforcedSampleLimit(enforcedSampleLimit) +``` + +"When defined, enforcedSampleLimit specifies a global limit on the number\nof scraped samples that will be accepted. This overrides any\n`spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects\nunless `spec.sampleLimit` is greater than zero and less than\n`spec.enforcedSampleLimit`.\n\n\nIt is meant to be used by admins to keep the overall number of\nsamples/series under a desired limit.\n\n\nWhen both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.\n* Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value.\n* Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit." + +### fn spec.withEnforcedTargetLimit + +```ts +withEnforcedTargetLimit(enforcedTargetLimit) +``` + +"When defined, enforcedTargetLimit specifies a global limit on the number\nof scraped targets. The value overrides any `spec.targetLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is\ngreater than zero and less than `spec.enforcedTargetLimit`.\n\n\nIt is meant to be used by admins to to keep the overall number of\ntargets under a desired limit.\n\n\nWhen both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.\n* Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value.\n* Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit." + +### fn spec.withExcludedFromEnforcement + +```ts +withExcludedFromEnforcement(excludedFromEnforcement) +``` + +"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true." + +### fn spec.withExcludedFromEnforcementMixin + +```ts +withExcludedFromEnforcementMixin(excludedFromEnforcement) +``` + +"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true." + +**Note:** This function appends passed data to existing values + +### fn spec.withExternalLabels + +```ts +withExternalLabels(externalLabels) +``` + +"The labels to add to any time series or alerts when communicating with\nexternal systems (federation, remote storage, Alertmanager).\nLabels defined by `spec.replicaExternalLabelName` and\n`spec.prometheusExternalLabelName` take precedence over this list." + +### fn spec.withExternalLabelsMixin + +```ts +withExternalLabelsMixin(externalLabels) +``` + +"The labels to add to any time series or alerts when communicating with\nexternal systems (federation, remote storage, Alertmanager).\nLabels defined by `spec.replicaExternalLabelName` and\n`spec.prometheusExternalLabelName` take precedence over this list." + +**Note:** This function appends passed data to existing values + +### fn spec.withExternalUrl + +```ts +withExternalUrl(externalUrl) +``` + +"The external URL under which the Prometheus service is externally\navailable. This is necessary to generate correct URLs (for instance if\nPrometheus is accessible behind an Ingress resource)." + +### fn spec.withHostAliases + +```ts +withHostAliases(hostAliases) +``` + +"Optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified." + +### fn spec.withHostAliasesMixin + +```ts +withHostAliasesMixin(hostAliases) +``` + +"Optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified." + +**Note:** This function appends passed data to existing values + +### fn spec.withHostNetwork + +```ts +withHostNetwork(hostNetwork) +``` + +"Use the host's network namespace if true.\n\n\nMake sure to understand the security implications if you want to enable\nit (https://kubernetes.io/docs/concepts/configuration/overview/).\n\n\nWhen hostNetwork is enabled, this will set the DNS policy to\n`ClusterFirstWithHostNet` automatically." + +### fn spec.withIgnoreNamespaceSelectors + +```ts +withIgnoreNamespaceSelectors(ignoreNamespaceSelectors) +``` + +"When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor\nand Probe objects will be ignored. They will only discover targets\nwithin the namespace of the PodMonitor, ServiceMonitor and Probe\nobject." + +### fn spec.withImage + +```ts +withImage(image) +``` + +"Container image name for Prometheus. If specified, it takes precedence\nover the `spec.baseImage`, `spec.tag` and `spec.sha` fields.\n\n\nSpecifying `spec.version` is still necessary to ensure the Prometheus\nOperator knows which version of Prometheus is being configured.\n\n\nIf neither `spec.image` nor `spec.baseImage` are defined, the operator\nwill use the latest upstream version of Prometheus available at the time\nwhen the operator was released." + +### fn spec.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details." + +### fn spec.withImagePullSecrets + +```ts +withImagePullSecrets(imagePullSecrets) +``` + +"An optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +### fn spec.withImagePullSecretsMixin + +```ts +withImagePullSecretsMixin(imagePullSecrets) +``` + +"An optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +**Note:** This function appends passed data to existing values + +### fn spec.withInitContainers + +```ts +withInitContainers(initContainers) +``` + +"InitContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +### fn spec.withInitContainersMixin + +```ts +withInitContainersMixin(initContainers) +``` + +"InitContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +**Note:** This function appends passed data to existing values + +### fn spec.withKeepDroppedTargets + +```ts +withKeepDroppedTargets(keepDroppedTargets) +``` + +"Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\n\nIt requires Prometheus >= v2.47.0.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets." + +### fn spec.withLabelLimit + +```ts +withLabelLimit(labelLimit) +``` + +"Per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit." + +### fn spec.withLabelNameLengthLimit + +```ts +withLabelNameLengthLimit(labelNameLengthLimit) +``` + +"Per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit." + +### fn spec.withLabelValueLengthLimit + +```ts +withLabelValueLengthLimit(labelValueLengthLimit) +``` + +"Per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit." + +### fn spec.withListenLocal + +```ts +withListenLocal(listenLocal) +``` + +"When true, the Prometheus server listens on the loopback address\ninstead of the Pod IP's address." + +### fn spec.withLogFormat + +```ts +withLogFormat(logFormat) +``` + +"Log format for Log level for Prometheus and the config-reloader sidecar." + +### fn spec.withLogLevel + +```ts +withLogLevel(logLevel) +``` + +"Log level for Prometheus and the config-reloader sidecar." + +### fn spec.withMaximumStartupDurationSeconds + +```ts +withMaximumStartupDurationSeconds(maximumStartupDurationSeconds) +``` + +"Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete.\nIf set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes)." + +### fn spec.withMinReadySeconds + +```ts +withMinReadySeconds(minReadySeconds) +``` + +"Minimum number of seconds for which a newly created Pod should be ready\nwithout any of its container crashing for it to be considered available.\nDefaults to 0 (pod will be considered available as soon as it is ready)\n\n\nThis is an alpha field from kubernetes 1.22 until 1.24 which requires\nenabling the StatefulSetMinReadySeconds feature gate." + +### fn spec.withMode + +```ts +withMode(mode) +``` + +"Mode defines how the Prometheus operator deploys the PrometheusAgent pod(s).\nFor now this field has no effect.\n\n\n(Alpha) Using this field requires the `PrometheusAgentDaemonSet` feature gate to be enabled." + +### fn spec.withNodeSelector + +```ts +withNodeSelector(nodeSelector) +``` + +"Defines on which Nodes the Pods are scheduled." + +### fn spec.withNodeSelectorMixin + +```ts +withNodeSelectorMixin(nodeSelector) +``` + +"Defines on which Nodes the Pods are scheduled." + +**Note:** This function appends passed data to existing values + +### fn spec.withOverrideHonorLabels + +```ts +withOverrideHonorLabels(overrideHonorLabels) +``` + +"When true, Prometheus resolves label conflicts by renaming the labels in the scraped data\n to “exported_” for all targets created from ServiceMonitor, PodMonitor and\nScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies.\nIn practice,`overrideHonorLaels:true` enforces `honorLabels:false`\nfor all ServiceMonitor, PodMonitor and ScrapeConfig objects." + +### fn spec.withOverrideHonorTimestamps + +```ts +withOverrideHonorTimestamps(overrideHonorTimestamps) +``` + +"When true, Prometheus ignores the timestamps for all the targets created\nfrom service and pod monitors.\nOtherwise the HonorTimestamps field of the service or pod monitor applies." + +### fn spec.withPaused + +```ts +withPaused(paused) +``` + +"When a Prometheus deployment is paused, no actions except for deletion\nwill be performed on the underlying objects." + +### fn spec.withPodTargetLabels + +```ts +withPodTargetLabels(podTargetLabels) +``` + +"PodTargetLabels are appended to the `spec.podTargetLabels` field of all\nPodMonitor and ServiceMonitor objects." + +### fn spec.withPodTargetLabelsMixin + +```ts +withPodTargetLabelsMixin(podTargetLabels) +``` + +"PodTargetLabels are appended to the `spec.podTargetLabels` field of all\nPodMonitor and ServiceMonitor objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withPortName + +```ts +withPortName(portName) +``` + +"Port name used for the pods and governing service.\nDefault: \"web\ + +### fn spec.withPriorityClassName + +```ts +withPriorityClassName(priorityClassName) +``` + +"Priority class assigned to the Pods." + +### fn spec.withPrometheusExternalLabelName + +```ts +withPrometheusExternalLabelName(prometheusExternalLabelName) +``` + +"Name of Prometheus external label used to denote the Prometheus instance\nname. The external label will _not_ be added when the field is set to\nthe empty string (`\"\"`).\n\n\nDefault: \"prometheus\ + +### fn spec.withReloadStrategy + +```ts +withReloadStrategy(reloadStrategy) +``` + +"Defines the strategy used to reload the Prometheus configuration.\nIf not specified, the configuration is reloaded using the /-/reload HTTP endpoint." + +### fn spec.withRemoteWrite + +```ts +withRemoteWrite(remoteWrite) +``` + +"Defines the list of remote write configurations." + +### fn spec.withRemoteWriteMixin + +```ts +withRemoteWriteMixin(remoteWrite) +``` + +"Defines the list of remote write configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withReplicaExternalLabelName + +```ts +withReplicaExternalLabelName(replicaExternalLabelName) +``` + +"Name of Prometheus external label used to denote the replica name.\nThe external label will _not_ be added when the field is set to the\nempty string (`\"\"`).\n\n\nDefault: \"prometheus_replica\ + +### fn spec.withReplicas + +```ts +withReplicas(replicas) +``` + +"Number of replicas of each shard to deploy for a Prometheus deployment.\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\ncreated.\n\n\nDefault: 1" + +### fn spec.withRoutePrefix + +```ts +withRoutePrefix(routePrefix) +``` + +"The route prefix Prometheus registers HTTP handlers for.\n\n\nThis is useful when using `spec.externalURL`, and a proxy is rewriting\nHTTP routes of a request, and the actual ExternalURL is still true, but\nthe server serves requests under a different route prefix. For example\nfor use with `kubectl proxy`." + +### fn spec.withSampleLimit + +```ts +withSampleLimit(sampleLimit) +``` + +"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit." + +### fn spec.withScrapeClasses + +```ts +withScrapeClasses(scrapeClasses) +``` + +"List of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.withScrapeClassesMixin + +```ts +withScrapeClassesMixin(scrapeClasses) +``` + +"List of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +**Note:** This function appends passed data to existing values + +### fn spec.withScrapeInterval + +```ts +withScrapeInterval(scrapeInterval) +``` + +"Interval between consecutive scrapes.\n\n\nDefault: \"30s\ + +### fn spec.withScrapeProtocols + +```ts +withScrapeProtocols(scrapeProtocols) +``` + +"The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +### fn spec.withScrapeProtocolsMixin + +```ts +withScrapeProtocolsMixin(scrapeProtocols) +``` + +"The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +**Note:** This function appends passed data to existing values + +### fn spec.withScrapeTimeout + +```ts +withScrapeTimeout(scrapeTimeout) +``` + +"Number of seconds to wait until a scrape request times out." + +### fn spec.withSecrets + +```ts +withSecrets(secrets) +``` + +"Secrets is a list of Secrets in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container." + +### fn spec.withSecretsMixin + +```ts +withSecretsMixin(secrets) +``` + +"Secrets is a list of Secrets in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container." + +**Note:** This function appends passed data to existing values + +### fn spec.withServiceAccountName + +```ts +withServiceAccountName(serviceAccountName) +``` + +"ServiceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods." + +### fn spec.withServiceDiscoveryRole + +```ts +withServiceDiscoveryRole(serviceDiscoveryRole) +``` + +"Defines the service discovery role used to discover targets from\n`ServiceMonitor` objects and Alertmanager endpoints.\n\n\nIf set, the value should be either \"Endpoints\" or \"EndpointSlice\".\nIf unset, the operator assumes the \"Endpoints\" role." + +### fn spec.withShards + +```ts +withShards(shards) +``` + +"Number of shards to distribute targets onto. `spec.replicas`\nmultiplied by `spec.shards` is the total number of Pods created.\n\n\nNote that scaling down shards will not reshard data onto remaining\ninstances, it must be manually moved. Increasing shards will not reshard\ndata either but it will continue to be available from the same\ninstances. To query globally, use Thanos sidecar and Thanos querier or\nremote write data to a central location.\n\n\nSharding is performed on the content of the `__address__` target meta-label\nfor PodMonitors and ServiceMonitors and `__param_target__` for Probes.\n\n\nDefault: 1" + +### fn spec.withTargetLimit + +```ts +withTargetLimit(targetLimit) +``` + +"TargetLimit defines a limit on the number of scraped targets that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit." + +### fn spec.withTolerations + +```ts +withTolerations(tolerations) +``` + +"Defines the Pods' tolerations if specified." + +### fn spec.withTolerationsMixin + +```ts +withTolerationsMixin(tolerations) +``` + +"Defines the Pods' tolerations if specified." + +**Note:** This function appends passed data to existing values + +### fn spec.withTopologySpreadConstraints + +```ts +withTopologySpreadConstraints(topologySpreadConstraints) +``` + +"Defines the pod's topology spread constraints if specified." + +### fn spec.withTopologySpreadConstraintsMixin + +```ts +withTopologySpreadConstraintsMixin(topologySpreadConstraints) +``` + +"Defines the pod's topology spread constraints if specified." + +**Note:** This function appends passed data to existing values + +### fn spec.withVersion + +```ts +withVersion(version) +``` + +"Version of Prometheus being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\n\nIf not specified, the operator assumes the latest upstream version of\nPrometheus available at the time when the version of the operator was\nreleased." + +### fn spec.withVolumeMounts + +```ts +withVolumeMounts(volumeMounts) +``` + +"VolumeMounts allows the configuration of additional VolumeMounts.\n\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects." + +### fn spec.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"VolumeMounts allows the configuration of additional VolumeMounts.\n\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withVolumes + +```ts +withVolumes(volumes) +``` + +"Volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects." + +### fn spec.withVolumesMixin + +```ts +withVolumesMixin(volumes) +``` + +"Volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects." + +**Note:** This function appends passed data to existing values + +### fn spec.withWalCompression + +```ts +withWalCompression(walCompression) +``` + +"Configures compression of the write-ahead log (WAL) using Snappy.\n\n\nWAL compression is enabled by default for Prometheus >= 2.20.0\n\n\nRequires Prometheus v2.11.0 and above." + +## obj spec.additionalArgs + +"AdditionalArgs allows setting additional arguments for the 'prometheus' container.\n\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged." + +### fn spec.additionalArgs.withName + +```ts +withName(name) +``` + +"Name of the argument, e.g. \"scrape.discovery-reload-interval\"." + +### fn spec.additionalArgs.withValue + +```ts +withValue(value) +``` + +"Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)" + +## obj spec.additionalScrapeConfigs + +"AdditionalScrapeConfigs allows specifying a key of a Secret containing\nadditional Prometheus scrape configurations. Scrape configurations\nspecified are appended to the configurations generated by the Prometheus\nOperator. Job configurations specified must have the form as specified\nin the official Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.\nAs scrape configs are appended, the user is responsible to make sure it\nis valid. Note that using this feature may expose the possibility to\nbreak upgrades of Prometheus. It is advised to review Prometheus release\nnotes to ensure that no incompatible scrape configs are going to break\nPrometheus after the upgrade." + +### fn spec.additionalScrapeConfigs.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.additionalScrapeConfigs.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.additionalScrapeConfigs.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.affinity + +"Defines the Pods' affinity scheduling rules if specified." + +## obj spec.affinity.nodeAffinity + +"Describes node affinity scheduling rules for the pod." + +### fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecution + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.nodeAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(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\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +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 + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.withMatchFieldsMixin + +```ts +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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution.preference.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTerms + +```ts +withNodeSelectorTerms(nodeSelectorTerms) +``` + +"Required. A list of node selector terms. The terms are ORed." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNodeSelectorTermsMixin + +```ts +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 + +```ts +withMatchExpressions(matchExpressions) +``` + +"A list of node selector requirements by node's labels." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchFields(matchFields) +``` + +"A list of node selector requirements by node's fields." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.withMatchFieldsMixin + +```ts +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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withKey(key) +``` + +"The label key that the selector applies to." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withOperator + +```ts +withOperator(operator) +``` + +"Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValues + +```ts +withValues(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch." + +### fn spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms.matchFields.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis 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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm 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\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm,\nin 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.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withPreferredDuringSchedulingIgnoredDuringExecution(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAntiAffinity.withPreferredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withPreferredDuringSchedulingIgnoredDuringExecutionMixin(preferredDuringSchedulingIgnoredDuringExecution) +``` + +"The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecution + +```ts +withRequiredDuringSchedulingIgnoredDuringExecution(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAntiAffinity.withRequiredDuringSchedulingIgnoredDuringExecutionMixin + +```ts +withRequiredDuringSchedulingIgnoredDuringExecutionMixin(requiredDuringSchedulingIgnoredDuringExecution) +``` + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm 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\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.withWeight + +```ts +withWeight(weight) +``` + +"weight associated with matching the corresponding podAffinityTerm,\nin 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.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution.podAffinityTerm.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution + +"If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeys + +```ts +withMismatchLabelKeys(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withMismatchLabelKeysMixin + +```ts +withMismatchLabelKeysMixin(mismatchLabelKeys) +``` + +"MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.\nThis is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespaces + +```ts +withNamespaces(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withNamespacesMixin + +```ts +withNamespacesMixin(namespaces) +``` + +"namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\"." + +**Note:** This function appends passed data to existing values + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed." + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector + +"A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector + +"A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchExpressionsMixin + +```ts +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.namespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.namespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.apiserverConfig + +"APIServerConfig allows specifying a host and auth methods to access the\nKuberntees API server.\nIf null, Prometheus is assumed to run inside of the cluster: it will\ndiscover the API servers automatically and use the Pod's CA certificate\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/." + +### fn spec.apiserverConfig.withBearerToken + +```ts +withBearerToken(bearerToken) +``` + +"*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\n\nDeprecated: this will be removed in a future release." + +### fn spec.apiserverConfig.withBearerTokenFile + +```ts +withBearerTokenFile(bearerTokenFile) +``` + +"File to read bearer token for accessing apiserver.\n\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`.\n\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`." + +### fn spec.apiserverConfig.withHost + +```ts +withHost(host) +``` + +"Kubernetes API address consisting of a hostname or IP address followed\nby an optional port number." + +## obj spec.apiserverConfig.authorization + +"Authorization section for the API server.\n\n\nCannot be set at the same time as `basicAuth`, `bearerToken`, or\n`bearerTokenFile`." + +### fn spec.apiserverConfig.authorization.withCredentialsFile + +```ts +withCredentialsFile(credentialsFile) +``` + +"File to read a secret from, mutually exclusive with `credentials`." + +### fn spec.apiserverConfig.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.apiserverConfig.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.apiserverConfig.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.apiserverConfig.basicAuth + +"BasicAuth configuration for the API server.\n\n\nCannot be set at the same time as `authorization`, `bearerToken`, or\n`bearerTokenFile`." + +## obj spec.apiserverConfig.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.apiserverConfig.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.apiserverConfig.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.apiserverConfig.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.apiserverConfig.tlsConfig + +"TLS Config to use for the API server." + +### fn spec.apiserverConfig.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.apiserverConfig.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.apiserverConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.apiserverConfig.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.apiserverConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.apiserverConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.apiserverConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.apiserverConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.apiserverConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.apiserverConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.apiserverConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.apiserverConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.apiserverConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.apiserverConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.apiserverConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.apiserverConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.apiserverConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.arbitraryFSAccessThroughSMs + +"When true, ServiceMonitor, PodMonitor and Probe object are forbidden to\nreference arbitrary files on the file system of the 'prometheus'\ncontainer.\nWhen a ServiceMonitor's endpoint specifies a `bearerTokenFile` value\n(e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a\nmalicious target can get access to the Prometheus service account's\ntoken in the Prometheus' scrape request. Setting\n`spec.arbitraryFSAccessThroughSM` to 'true' would prevent the attack.\nUsers should instead provide the credentials using the\n`spec.bearerTokenSecret` field." + +### fn spec.arbitraryFSAccessThroughSMs.withDeny + +```ts +withDeny(deny) +``` + + + +## obj spec.containers + +"Containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +### fn spec.containers.withArgs + +```ts +withArgs(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.containers.withArgsMixin + +```ts +withArgsMixin(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withCommand(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.containers.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.containers.withEnvFrom + +```ts +withEnvFrom(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.containers.withEnvFromMixin + +```ts +withEnvFromMixin(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withImage + +```ts +withImage(image) +``` + +"Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets." + +### fn spec.containers.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + +### fn spec.containers.withName + +```ts +withName(name) +``` + +"Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + +### fn spec.containers.withPorts + +```ts +withPorts(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.containers.withPortsMixin + +```ts +withPortsMixin(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withResizePolicy + +```ts +withResizePolicy(resizePolicy) +``` + +"Resources resize policy for the container." + +### fn spec.containers.withResizePolicyMixin + +```ts +withResizePolicyMixin(resizePolicy) +``` + +"Resources resize policy for the container." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted." + +### fn spec.containers.withStdin + +```ts +withStdin(stdin) +``` + +"Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false." + +### fn spec.containers.withStdinOnce + +```ts +withStdinOnce(stdinOnce) +``` + +"Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false" + +### fn spec.containers.withTerminationMessagePath + +```ts +withTerminationMessagePath(terminationMessagePath) +``` + +"Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated." + +### fn spec.containers.withTerminationMessagePolicy + +```ts +withTerminationMessagePolicy(terminationMessagePolicy) +``` + +"Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated." + +### fn spec.containers.withTty + +```ts +withTty(tty) +``` + +"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false." + +### fn spec.containers.withVolumeDevices + +```ts +withVolumeDevices(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.containers.withVolumeDevicesMixin + +```ts +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 + +```ts +withVolumeMounts(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +### fn spec.containers.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.withWorkingDir + +```ts +withWorkingDir(workingDir) +``` + +"Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated." + +## obj spec.containers.env + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.containers.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.containers.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"." + +## obj spec.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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.containers.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.env.valueFrom.configMapKeyRef.withOptional + +```ts +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['']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.containers.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.containers.env.valueFrom.fieldRef.withFieldPath + +```ts +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\n(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 + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.containers.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.containers.env.valueFrom.resourceFieldRef.withResource + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.containers.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.env.valueFrom.secretKeyRef.withOptional + +```ts +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.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.containers.envFrom.withPrefix + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.envFrom.configMapRef.withOptional + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.containers.envFrom.secretRef.withOptional + +```ts +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.\nCannot be updated." + +## obj spec.containers.lifecycle.postStart + +"PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.containers.lifecycle.postStart.exec + +"Exec specifies the action to take." + +### fn spec.containers.lifecycle.postStart.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.lifecycle.postStart.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.lifecycle.postStart.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.lifecycle.postStart.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.lifecycle.postStart.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.lifecycle.postStart.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.lifecycle.postStart.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.lifecycle.postStart.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.containers.lifecycle.postStart.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.containers.lifecycle.postStart.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.containers.lifecycle.postStart.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.lifecycle.postStart.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.lifecycle.preStop + +"PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.containers.lifecycle.preStop.exec + +"Exec specifies the action to take." + +### fn spec.containers.lifecycle.preStop.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.lifecycle.preStop.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.lifecycle.preStop.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.lifecycle.preStop.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.lifecycle.preStop.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.lifecycle.preStop.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.lifecycle.preStop.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.lifecycle.preStop.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.containers.lifecycle.preStop.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.containers.lifecycle.preStop.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.containers.lifecycle.preStop.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.lifecycle.preStop.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.livenessProbe + +"Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.livenessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.livenessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.livenessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.livenessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.livenessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.livenessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.livenessProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.livenessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.livenessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.livenessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.livenessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.livenessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.livenessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.livenessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.livenessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.livenessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.livenessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.livenessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.livenessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.livenessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.livenessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.ports + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.containers.ports.withContainerPort + +```ts +withContainerPort(containerPort) +``` + +"Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536." + +### fn spec.containers.ports.withHostIP + +```ts +withHostIP(hostIP) +``` + +"What host IP to bind the external port to." + +### fn spec.containers.ports.withHostPort + +```ts +withHostPort(hostPort) +``` + +"Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this." + +### fn spec.containers.ports.withName + +```ts +withName(name) +``` + +"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services." + +### fn spec.containers.ports.withProtocol + +```ts +withProtocol(protocol) +``` + +"Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\"." + +## obj spec.containers.readinessProbe + +"Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.readinessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.readinessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.readinessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.readinessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.readinessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.readinessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.readinessProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.readinessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.readinessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.readinessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.readinessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.readinessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.readinessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.readinessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.readinessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.readinessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.readinessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.readinessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.readinessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.readinessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.readinessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.containers.resizePolicy + +"Resources resize policy for the container." + +### fn spec.containers.resizePolicy.withResourceName + +```ts +withResourceName(resourceName) +``` + +"Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + +### fn spec.containers.resizePolicy.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + +## obj spec.containers.resources + +"Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.containers.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.containers.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.containers.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.containers.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.containers.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.containers.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.containers.securityContext + +"SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.containers.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.containers.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +## obj spec.containers.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.containers.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.containers.securityContext.capabilities + +"The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.containers.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.containers.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.containers.securityContext.capabilities.withDropMixin + +```ts +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.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.containers.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.containers.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.containers.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.containers.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.containers.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.containers.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.containers.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.containers.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.containers.startupProbe + +"StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.startupProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.containers.startupProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.containers.startupProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.containers.startupProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.containers.startupProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.containers.startupProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.containers.startupProbe.exec + +"Exec specifies the action to take." + +### fn spec.containers.startupProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.containers.startupProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.containers.startupProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.containers.startupProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.containers.startupProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.containers.startupProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.containers.startupProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.containers.startupProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.containers.startupProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.containers.startupProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.containers.startupProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.containers.startupProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.containers.startupProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.containers.startupProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName 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 + +```ts +withDevicePath(devicePath) +``` + +"devicePath is the path inside of the container that the device will be mapped to." + +### fn spec.containers.volumeDevices.withName + +```ts +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.\nCannot be updated." + +### fn spec.containers.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.containers.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.containers.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.containers.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.containers.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.containers.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.containers.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.excludedFromEnforcement + +"List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true." + +### fn spec.excludedFromEnforcement.withGroup + +```ts +withGroup(group) +``` + +"Group of the referent. When not specified, it defaults to `monitoring.coreos.com`" + +### fn spec.excludedFromEnforcement.withName + +```ts +withName(name) +``` + +"Name of the referent. When not set, all resources in the namespace are matched." + +### fn spec.excludedFromEnforcement.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/" + +### fn spec.excludedFromEnforcement.withResource + +```ts +withResource(resource) +``` + +"Resource of the referent." + +## obj spec.hostAliases + +"Optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified." + +### fn spec.hostAliases.withHostnames + +```ts +withHostnames(hostnames) +``` + +"Hostnames for the above IP address." + +### fn spec.hostAliases.withHostnamesMixin + +```ts +withHostnamesMixin(hostnames) +``` + +"Hostnames for the above IP address." + +**Note:** This function appends passed data to existing values + +### fn spec.hostAliases.withIp + +```ts +withIp(ip) +``` + +"IP address of the host file entry." + +## obj spec.imagePullSecrets + +"An optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod" + +### fn spec.imagePullSecrets.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.initContainers + +"InitContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice." + +### fn spec.initContainers.withArgs + +```ts +withArgs(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.initContainers.withArgsMixin + +```ts +withArgsMixin(args) +``` + +"Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withCommand(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell" + +### fn spec.initContainers.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore 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 + +```ts +withEnv(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.initContainers.withEnvFrom + +```ts +withEnvFrom(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.initContainers.withEnvFromMixin + +```ts +withEnvFromMixin(envFrom) +``` + +"List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withEnvMixin + +```ts +withEnvMixin(env) +``` + +"List of environment variables to set in the container.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withImage + +```ts +withImage(image) +``` + +"Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets." + +### fn spec.initContainers.withImagePullPolicy + +```ts +withImagePullPolicy(imagePullPolicy) +``` + +"Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images" + +### fn spec.initContainers.withName + +```ts +withName(name) +``` + +"Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated." + +### fn spec.initContainers.withPorts + +```ts +withPorts(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.initContainers.withPortsMixin + +```ts +withPortsMixin(ports) +``` + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withResizePolicy + +```ts +withResizePolicy(resizePolicy) +``` + +"Resources resize policy for the container." + +### fn spec.initContainers.withResizePolicyMixin + +```ts +withResizePolicyMixin(resizePolicy) +``` + +"Resources resize policy for the container." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted." + +### fn spec.initContainers.withStdin + +```ts +withStdin(stdin) +``` + +"Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false." + +### fn spec.initContainers.withStdinOnce + +```ts +withStdinOnce(stdinOnce) +``` + +"Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false" + +### fn spec.initContainers.withTerminationMessagePath + +```ts +withTerminationMessagePath(terminationMessagePath) +``` + +"Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated." + +### fn spec.initContainers.withTerminationMessagePolicy + +```ts +withTerminationMessagePolicy(terminationMessagePolicy) +``` + +"Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated." + +### fn spec.initContainers.withTty + +```ts +withTty(tty) +``` + +"Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false." + +### fn spec.initContainers.withVolumeDevices + +```ts +withVolumeDevices(volumeDevices) +``` + +"volumeDevices is the list of block devices to be used by the container." + +### fn spec.initContainers.withVolumeDevicesMixin + +```ts +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 + +```ts +withVolumeMounts(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +### fn spec.initContainers.withVolumeMountsMixin + +```ts +withVolumeMountsMixin(volumeMounts) +``` + +"Pod volumes to mount into the container's filesystem.\nCannot be updated." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.withWorkingDir + +```ts +withWorkingDir(workingDir) +``` + +"Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated." + +## obj spec.initContainers.env + +"List of environment variables to set in the container.\nCannot be updated." + +### fn spec.initContainers.env.withName + +```ts +withName(name) +``` + +"Name of the environment variable. Must be a C_IDENTIFIER." + +### fn spec.initContainers.env.withValue + +```ts +withValue(value) +``` + +"Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\"." + +## obj spec.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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.initContainers.env.valueFrom.configMapKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.env.valueFrom.configMapKeyRef.withOptional + +```ts +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['']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs." + +### fn spec.initContainers.env.valueFrom.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.initContainers.env.valueFrom.fieldRef.withFieldPath + +```ts +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\n(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 + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.initContainers.env.valueFrom.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.initContainers.env.valueFrom.resourceFieldRef.withResource + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.initContainers.env.valueFrom.secretKeyRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.env.valueFrom.secretKeyRef.withOptional + +```ts +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.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated." + +### fn spec.initContainers.envFrom.withPrefix + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.envFrom.configMapRef.withOptional + +```ts +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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.initContainers.envFrom.secretRef.withOptional + +```ts +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.\nCannot be updated." + +## obj spec.initContainers.lifecycle.postStart + +"PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.initContainers.lifecycle.postStart.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.lifecycle.postStart.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.lifecycle.postStart.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.lifecycle.postStart.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.lifecycle.postStart.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.lifecycle.postStart.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.initContainers.lifecycle.postStart.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.initContainers.lifecycle.postStart.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.initContainers.lifecycle.postStart.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.lifecycle.postStart.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.lifecycle.preStop + +"PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks" + +## obj spec.initContainers.lifecycle.preStop.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.lifecycle.preStop.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.lifecycle.preStop.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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 + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.lifecycle.preStop.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.lifecycle.preStop.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.lifecycle.preStop.sleep + +"Sleep represents the duration that the container should sleep before being terminated." + +### fn spec.initContainers.lifecycle.preStop.sleep.withSeconds + +```ts +withSeconds(seconds) +``` + +"Seconds is the number of seconds to sleep." + +## obj spec.initContainers.lifecycle.preStop.tcpSocket + +"Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor the backward compatibility. There are no validation of this field and\nlifecycle hooks will fail in runtime when tcp handler is specified." + +### fn spec.initContainers.lifecycle.preStop.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.lifecycle.preStop.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.livenessProbe + +"Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.livenessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.livenessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.livenessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.livenessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.livenessProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.livenessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.livenessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.livenessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.livenessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.livenessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.livenessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.livenessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.livenessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.livenessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.livenessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.livenessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.livenessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.livenessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.livenessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.ports + +"List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated." + +### fn spec.initContainers.ports.withContainerPort + +```ts +withContainerPort(containerPort) +``` + +"Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 < x < 65536." + +### fn spec.initContainers.ports.withHostIP + +```ts +withHostIP(hostIP) +``` + +"What host IP to bind the external port to." + +### fn spec.initContainers.ports.withHostPort + +```ts +withHostPort(hostPort) +``` + +"Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 < x < 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this." + +### fn spec.initContainers.ports.withName + +```ts +withName(name) +``` + +"If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services." + +### fn spec.initContainers.ports.withProtocol + +```ts +withProtocol(protocol) +``` + +"Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\"." + +## obj spec.initContainers.readinessProbe + +"Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.readinessProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.readinessProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.readinessProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.readinessProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.readinessProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.readinessProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.readinessProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.readinessProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.readinessProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.readinessProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.readinessProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.readinessProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.readinessProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.readinessProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.readinessProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.readinessProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.readinessProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.readinessProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.readinessProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +## obj spec.initContainers.resizePolicy + +"Resources resize policy for the container." + +### fn spec.initContainers.resizePolicy.withResourceName + +```ts +withResourceName(resourceName) +``` + +"Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory." + +### fn spec.initContainers.resizePolicy.withRestartPolicy + +```ts +withRestartPolicy(restartPolicy) +``` + +"Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired." + +## obj spec.initContainers.resources + +"Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.initContainers.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.initContainers.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.initContainers.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.initContainers.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.initContainers.securityContext + +"SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/" + +### fn spec.initContainers.securityContext.withAllowPrivilegeEscalation + +```ts +withAllowPrivilegeEscalation(allowPrivilegeEscalation) +``` + +"AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withPrivileged + +```ts +withPrivileged(privileged) +``` + +"Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withProcMount + +```ts +withProcMount(procMount) +``` + +"procMount denotes the type of proc mount to use for the containers.\nThe default is DefaultProcMount which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withReadOnlyRootFilesystem + +```ts +withReadOnlyRootFilesystem(readOnlyRootFilesystem) +``` + +"Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.initContainers.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +## obj spec.initContainers.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.initContainers.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.initContainers.securityContext.capabilities + +"The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.capabilities.withAdd + +```ts +withAdd(add) +``` + +"Added capabilities" + +### fn spec.initContainers.securityContext.capabilities.withAddMixin + +```ts +withAddMixin(add) +``` + +"Added capabilities" + +**Note:** This function appends passed data to existing values + +### fn spec.initContainers.securityContext.capabilities.withDrop + +```ts +withDrop(drop) +``` + +"Removed capabilities" + +### fn spec.initContainers.securityContext.capabilities.withDropMixin + +```ts +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.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.initContainers.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.initContainers.securityContext.seccompProfile + +"The seccomp options to use by this container. If seccomp options are\nprovided at both the pod & container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.initContainers.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.initContainers.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.initContainers.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.initContainers.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.initContainers.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.initContainers.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.initContainers.startupProbe + +"StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.startupProbe.withFailureThreshold + +```ts +withFailureThreshold(failureThreshold) +``` + +"Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withInitialDelaySeconds + +```ts +withInitialDelaySeconds(initialDelaySeconds) +``` + +"Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +### fn spec.initContainers.startupProbe.withPeriodSeconds + +```ts +withPeriodSeconds(periodSeconds) +``` + +"How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withSuccessThreshold + +```ts +withSuccessThreshold(successThreshold) +``` + +"Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1." + +### fn spec.initContainers.startupProbe.withTerminationGracePeriodSeconds + +```ts +withTerminationGracePeriodSeconds(terminationGracePeriodSeconds) +``` + +"Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset." + +### fn spec.initContainers.startupProbe.withTimeoutSeconds + +```ts +withTimeoutSeconds(timeoutSeconds) +``` + +"Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes" + +## obj spec.initContainers.startupProbe.exec + +"Exec specifies the action to take." + +### fn spec.initContainers.startupProbe.exec.withCommand + +```ts +withCommand(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy." + +### fn spec.initContainers.startupProbe.exec.withCommandMixin + +```ts +withCommandMixin(command) +``` + +"Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit 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.grpc + +"GRPC specifies an action involving a GRPC port." + +### fn spec.initContainers.startupProbe.grpc.withPort + +```ts +withPort(port) +``` + +"Port number of the gRPC service. Number must be in the range 1 to 65535." + +### fn spec.initContainers.startupProbe.grpc.withService + +```ts +withService(service) +``` + +"Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\n\nIf this is not specified, the default behavior is defined by gRPC." + +## obj spec.initContainers.startupProbe.httpGet + +"HTTPGet specifies the http request to perform." + +### fn spec.initContainers.startupProbe.httpGet.withHost + +```ts +withHost(host) +``` + +"Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead." + +### fn spec.initContainers.startupProbe.httpGet.withHttpHeaders + +```ts +withHttpHeaders(httpHeaders) +``` + +"Custom headers to set in the request. HTTP allows repeated headers." + +### fn spec.initContainers.startupProbe.httpGet.withHttpHeadersMixin + +```ts +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 + +```ts +withPath(path) +``` + +"Path to access on the HTTP server." + +### fn spec.initContainers.startupProbe.httpGet.withPort + +```ts +withPort(port) +``` + +"Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME." + +### fn spec.initContainers.startupProbe.httpGet.withScheme + +```ts +withScheme(scheme) +``` + +"Scheme to use for connecting to the host.\nDefaults 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 + +```ts +withName(name) +``` + +"The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header." + +### fn spec.initContainers.startupProbe.httpGet.httpHeaders.withValue + +```ts +withValue(value) +``` + +"The header field value" + +## obj spec.initContainers.startupProbe.tcpSocket + +"TCPSocket specifies an action involving a TCP port." + +### fn spec.initContainers.startupProbe.tcpSocket.withHost + +```ts +withHost(host) +``` + +"Optional: Host name to connect to, defaults to the pod IP." + +### fn spec.initContainers.startupProbe.tcpSocket.withPort + +```ts +withPort(port) +``` + +"Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName 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 + +```ts +withDevicePath(devicePath) +``` + +"devicePath is the path inside of the container that the device will be mapped to." + +### fn spec.initContainers.volumeDevices.withName + +```ts +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.\nCannot be updated." + +### fn spec.initContainers.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.initContainers.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.initContainers.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.initContainers.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.initContainers.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.initContainers.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.initContainers.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.persistentVolumeClaimRetentionPolicy + +"The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\nThe default behavior is all PVCs are retained.\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\nIt requires enabling the StatefulSetAutoDeletePVC feature gate." + +### fn spec.persistentVolumeClaimRetentionPolicy.withWhenDeleted + +```ts +withWhenDeleted(whenDeleted) +``` + +"WhenDeleted specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is deleted. The default policy\nof `Retain` causes PVCs to not be affected by StatefulSet deletion. The\n`Delete` policy causes those PVCs to be deleted." + +### fn spec.persistentVolumeClaimRetentionPolicy.withWhenScaled + +```ts +withWhenScaled(whenScaled) +``` + +"WhenScaled specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is scaled down. The default\npolicy of `Retain` causes PVCs to not be affected by a scaledown. The\n`Delete` policy causes the associated PVCs for any excess pods above\nthe replica count to be deleted." + +## obj spec.podMetadata + +"PodMetadata configures labels and annotations which are propagated to the Prometheus pods.\n\n\nThe following items are reserved and cannot be overridden:\n* \"prometheus\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/instance\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"prometheus\".\n* \"app.kubernetes.io/version\" label, set to the Prometheus version.\n* \"operator.prometheus.io/name\" label, set to the name of the Prometheus object.\n* \"operator.prometheus.io/shard\" label, set to the shard number of the Prometheus object.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"prometheus\"." + +### fn spec.podMetadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +### fn spec.podMetadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn spec.podMetadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +### fn spec.podMetadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn spec.podMetadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + +## obj spec.podMonitorNamespaceSelector + +"Namespaces to match for PodMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only." + +### fn spec.podMonitorNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.podMonitorNamespaceSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.podMonitorNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.podMonitorNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.podMonitorNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.podMonitorNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.podMonitorNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.podMonitorNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.podMonitorSelector + +"PodMonitors to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead." + +### fn spec.podMonitorSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.podMonitorSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.podMonitorSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.podMonitorSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.podMonitorSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.podMonitorSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.podMonitorSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.podMonitorSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.probeNamespaceSelector + +"Namespaces to match for Probe discovery. An empty label\nselector matches all namespaces. A null label selector matches the\ncurrent namespace only." + +### fn spec.probeNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.probeNamespaceSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.probeNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.probeNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.probeNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.probeNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.probeNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.probeNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.probeSelector + +"Probes to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead." + +### fn spec.probeSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.probeSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.probeSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.probeSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.probeSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.probeSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.probeSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.probeSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.remoteWrite + +"Defines the list of remote write configurations." + +### fn spec.remoteWrite.withBearerToken + +```ts +withBearerToken(bearerToken) +``` + +"*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\n\nDeprecated: this will be removed in a future release." + +### fn spec.remoteWrite.withBearerTokenFile + +```ts +withBearerTokenFile(bearerTokenFile) +``` + +"File from which to read bearer token for the URL.\n\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`." + +### fn spec.remoteWrite.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.remoteWrite.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects.\n\n\nIt requires Prometheus >= v2.26.0." + +### fn spec.remoteWrite.withHeaders + +```ts +withHeaders(headers) +``` + +"Custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\n\nIt requires Prometheus >= v2.25.0." + +### fn spec.remoteWrite.withHeadersMixin + +```ts +withHeadersMixin(headers) +``` + +"Custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\n\nIt requires Prometheus >= v2.25.0." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.withName + +```ts +withName(name) +``` + +"The name of the remote write queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate queues.\n\n\nIt requires Prometheus >= v2.15.0." + +### fn spec.remoteWrite.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.withRemoteTimeout + +```ts +withRemoteTimeout(remoteTimeout) +``` + +"Timeout for requests to the remote write endpoint." + +### fn spec.remoteWrite.withSendExemplars + +```ts +withSendExemplars(sendExemplars) +``` + +"Enables sending of exemplars over remote write. Note that\nexemplar-storage itself must be enabled using the `spec.enableFeature`\noption for exemplars to be scraped in the first place.\n\n\nIt requires Prometheus >= v2.27.0." + +### fn spec.remoteWrite.withSendNativeHistograms + +```ts +withSendNativeHistograms(sendNativeHistograms) +``` + +"Enables sending of native histograms, also known as sparse histograms\nover remote write.\n\n\nIt requires Prometheus >= v2.40.0." + +### fn spec.remoteWrite.withUrl + +```ts +withUrl(url) +``` + +"The URL of the endpoint to send samples to." + +### fn spec.remoteWrite.withWriteRelabelConfigs + +```ts +withWriteRelabelConfigs(writeRelabelConfigs) +``` + +"The list of remote write relabel configurations." + +### fn spec.remoteWrite.withWriteRelabelConfigsMixin + +```ts +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 the URL.\n\n\nIt requires Prometheus >= v2.26.0.\n\n\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`." + +### fn spec.remoteWrite.authorization.withCredentialsFile + +```ts +withCredentialsFile(credentialsFile) +``` + +"File to read a secret from, mutually exclusive with `credentials`." + +### fn spec.remoteWrite.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.remoteWrite.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.remoteWrite.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.azureAd + +"AzureAD for the URL.\n\n\nIt requires Prometheus >= v2.45.0.\n\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`." + +### fn spec.remoteWrite.azureAd.withCloud + +```ts +withCloud(cloud) +``` + +"The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'." + +## obj spec.remoteWrite.azureAd.managedIdentity + +"ManagedIdentity defines the Azure User-assigned Managed identity.\nCannot be set at the same time as `oauth` or `sdk`." + +### fn spec.remoteWrite.azureAd.managedIdentity.withClientId + +```ts +withClientId(clientId) +``` + +"The client id" + +## obj spec.remoteWrite.azureAd.oauth + +"OAuth defines the oauth config that is being used to authenticate.\nCannot be set at the same time as `managedIdentity` or `sdk`.\n\n\nIt requires Prometheus >= v2.48.0." + +### fn spec.remoteWrite.azureAd.oauth.withClientId + +```ts +withClientId(clientId) +``` + +"`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate." + +### fn spec.remoteWrite.azureAd.oauth.withTenantId + +```ts +withTenantId(tenantId) +``` + +"`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate." + +## obj spec.remoteWrite.azureAd.oauth.clientSecret + +"`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate." + +### fn spec.remoteWrite.azureAd.oauth.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.azureAd.oauth.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.azureAd.oauth.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.azureAd.sdk + +"SDK defines the Azure SDK config that is being used to authenticate.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\nCannot be set at the same time as `oauth` or `managedIdentity`.\n\n\nIt requires Prometheus >= 2.52.0." + +### fn spec.remoteWrite.azureAd.sdk.withTenantId + +```ts +withTenantId(tenantId) +``` + +"`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate." + +## obj spec.remoteWrite.basicAuth + +"BasicAuth configuration for the URL.\n\n\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`." + +## obj spec.remoteWrite.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.remoteWrite.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.remoteWrite.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.metadataConfig + +"MetadataConfig configures the sending of series metadata to the remote storage." + +### fn spec.remoteWrite.metadataConfig.withSend + +```ts +withSend(send) +``` + +"Defines whether metric metadata is sent to the remote storage or not." + +### fn spec.remoteWrite.metadataConfig.withSendInterval + +```ts +withSendInterval(sendInterval) +``` + +"Defines how frequently metric metadata is sent to the remote storage." + +## obj spec.remoteWrite.oauth2 + +"OAuth2 configuration for the URL.\n\n\nIt requires Prometheus >= v2.27.0.\n\n\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`." + +### fn spec.remoteWrite.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.remoteWrite.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.remoteWrite.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.remoteWrite.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.remoteWrite.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.clientId.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.remoteWrite.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.remoteWrite.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.remoteWrite.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.remoteWrite.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.remoteWrite.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.remoteWrite.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.remoteWrite.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.remoteWrite.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.remoteWrite.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.oauth2.tlsConfig.keySecret.withOptional + +```ts +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 + +```ts +withBatchSendDeadline(batchSendDeadline) +``` + +"BatchSendDeadline is the maximum time a sample will wait in buffer." + +### fn spec.remoteWrite.queueConfig.withCapacity + +```ts +withCapacity(capacity) +``` + +"Capacity is the number of samples to buffer per shard before we start\ndropping them." + +### fn spec.remoteWrite.queueConfig.withMaxBackoff + +```ts +withMaxBackoff(maxBackoff) +``` + +"MaxBackoff is the maximum retry delay." + +### fn spec.remoteWrite.queueConfig.withMaxRetries + +```ts +withMaxRetries(maxRetries) +``` + +"MaxRetries is the maximum number of times to retry a batch on recoverable errors." + +### fn spec.remoteWrite.queueConfig.withMaxSamplesPerSend + +```ts +withMaxSamplesPerSend(maxSamplesPerSend) +``` + +"MaxSamplesPerSend is the maximum number of samples per send." + +### fn spec.remoteWrite.queueConfig.withMaxShards + +```ts +withMaxShards(maxShards) +``` + +"MaxShards is the maximum number of shards, i.e. amount of concurrency." + +### fn spec.remoteWrite.queueConfig.withMinBackoff + +```ts +withMinBackoff(minBackoff) +``` + +"MinBackoff is the initial retry delay. Gets doubled for every retry." + +### fn spec.remoteWrite.queueConfig.withMinShards + +```ts +withMinShards(minShards) +``` + +"MinShards is the minimum number of shards, i.e. amount of concurrency." + +### fn spec.remoteWrite.queueConfig.withRetryOnRateLimit + +```ts +withRetryOnRateLimit(retryOnRateLimit) +``` + +"Retry upon receiving a 429 status code from the remote-write storage.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.remoteWrite.queueConfig.withSampleAgeLimit + +```ts +withSampleAgeLimit(sampleAgeLimit) +``` + +"SampleAgeLimit drops samples older than the limit.\nIt requires Prometheus >= v2.50.0." + +## obj spec.remoteWrite.sigv4 + +"Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\n\n\nIt requires Prometheus >= v2.26.0.\n\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`." + +### fn spec.remoteWrite.sigv4.withProfile + +```ts +withProfile(profile) +``` + +"Profile is the named AWS profile used to authenticate." + +### fn spec.remoteWrite.sigv4.withRegion + +```ts +withRegion(region) +``` + +"Region is the AWS region. If blank, the region from the default credentials chain used." + +### fn spec.remoteWrite.sigv4.withRoleArn + +```ts +withRoleArn(roleArn) +``` + +"RoleArn is the named AWS profile used to authenticate." + +## obj spec.remoteWrite.sigv4.accessKey + +"AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used." + +### fn spec.remoteWrite.sigv4.accessKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.sigv4.accessKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.sigv4.accessKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.sigv4.secretKey + +"SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used." + +### fn spec.remoteWrite.sigv4.secretKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.sigv4.secretKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.sigv4.secretKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.tlsConfig + +"TLS Config to use for the URL." + +### fn spec.remoteWrite.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.remoteWrite.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.remoteWrite.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.remoteWrite.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.remoteWrite.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.remoteWrite.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.remoteWrite.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.remoteWrite.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.remoteWrite.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.remoteWrite.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.remoteWrite.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.remoteWrite.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.remoteWrite.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.remoteWrite.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.remoteWrite.tlsConfig.keySecret.withOptional + +```ts +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 + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.remoteWrite.writeRelabelConfigs.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.remoteWrite.writeRelabelConfigs.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.remoteWrite.writeRelabelConfigs.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.remoteWrite.writeRelabelConfigs.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.remoteWrite.writeRelabelConfigs.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.remoteWrite.writeRelabelConfigs.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.remoteWrite.writeRelabelConfigs.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.resources + +"Defines the resources requests and limits of the 'prometheus' container." + +### fn spec.resources.withClaims + +```ts +withClaims(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.resources.withClaimsMixin + +```ts +withClaimsMixin(claims) +``` + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.resources.claims + +"Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\n\nThis field is immutable. It can only be set for containers." + +### fn spec.resources.claims.withName + +```ts +withName(name) +``` + +"Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container." + +## obj spec.scrapeClasses + +"List of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.scrapeClasses.withDefault + +```ts +withDefault(default) +``` + +"Default indicates that the scrape applies to all scrape objects that\ndon't configure an explicit scrape class name.\n\n\nOnly one scrape class can be set as the default." + +### fn spec.scrapeClasses.withMetricRelabelings + +```ts +withMetricRelabelings(metricRelabelings) +``` + +"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\n\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs" + +### fn spec.scrapeClasses.withMetricRelabelingsMixin + +```ts +withMetricRelabelingsMixin(metricRelabelings) +``` + +"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\n\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs" + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeClasses.withName + +```ts +withName(name) +``` + +"Name of the scrape class." + +### fn spec.scrapeClasses.withRelabelings + +```ts +withRelabelings(relabelings) +``` + +"Relabelings configures the relabeling rules to apply to all scrape targets.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.scrapeClasses.withRelabelingsMixin + +```ts +withRelabelingsMixin(relabelings) +``` + +"Relabelings configures the relabeling rules to apply to all scrape targets.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +**Note:** This function appends passed data to existing values + +## obj spec.scrapeClasses.attachMetadata + +"AttachMetadata configures additional metadata to the discovered targets.\nWhen the scrape object defines its own configuration, it takes\nprecedence over the scrape class configuration." + +### fn spec.scrapeClasses.attachMetadata.withNode + +```ts +withNode(node) +``` + +"When set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects." + +## obj spec.scrapeClasses.metricRelabelings + +"MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\n\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs" + +### fn spec.scrapeClasses.metricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.scrapeClasses.metricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.scrapeClasses.metricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.scrapeClasses.metricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.scrapeClasses.metricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.scrapeClasses.metricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.scrapeClasses.metricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeClasses.metricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.scrapeClasses.relabelings + +"Relabelings configures the relabeling rules to apply to all scrape targets.\n\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.scrapeClasses.relabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.scrapeClasses.relabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.scrapeClasses.relabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.scrapeClasses.relabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.scrapeClasses.relabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.scrapeClasses.relabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.scrapeClasses.relabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeClasses.relabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.scrapeClasses.tlsConfig + +"TLSConfig defines the TLS settings to use for the scrape. When the\nscrape objects define their own CA, certificate and/or key, they take\nprecedence over the corresponding scrape class fields.\n\n\nFor now only the `caFile`, `certFile` and `keyFile` fields are supported." + +### fn spec.scrapeClasses.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.scrapeClasses.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.scrapeClasses.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.scrapeClasses.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.scrapeClasses.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.scrapeClasses.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.scrapeClasses.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.scrapeClasses.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.scrapeClasses.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.scrapeClasses.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scrapeClasses.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.scrapeClasses.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.scrapeClasses.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.scrapeClasses.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.scrapeClasses.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.scrapeClasses.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scrapeClasses.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.scrapeClasses.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.scrapeClasses.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scrapeClasses.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scrapeClasses.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.scrapeConfigNamespaceSelector + +"Namespaces to match for ScrapeConfig discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.\n\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level." + +### fn spec.scrapeConfigNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.scrapeConfigNamespaceSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeConfigNamespaceSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.scrapeConfigNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.scrapeConfigNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.scrapeConfigNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.scrapeConfigNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.scrapeConfigNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.scrapeConfigNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.scrapeConfigSelector + +"ScrapeConfigs to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.\n\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level." + +### fn spec.scrapeConfigSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.scrapeConfigSelector.withMatchExpressionsMixin + +```ts +withMatchExpressionsMixin(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +### fn spec.scrapeConfigSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.scrapeConfigSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.scrapeConfigSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.scrapeConfigSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.scrapeConfigSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.scrapeConfigSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.scrapeConfigSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.securityContext + +"SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext." + +### fn spec.securityContext.withFsGroup + +```ts +withFsGroup(fsGroup) +``` + +"A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withFsGroupChangePolicy + +```ts +withFsGroupChangePolicy(fsGroupChangePolicy) +``` + +"fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withRunAsGroup + +```ts +withRunAsGroup(runAsGroup) +``` + +"The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withRunAsNonRoot + +```ts +withRunAsNonRoot(runAsNonRoot) +``` + +"Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +### fn spec.securityContext.withRunAsUser + +```ts +withRunAsUser(runAsUser) +``` + +"The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSupplementalGroups + +```ts +withSupplementalGroups(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSupplementalGroupsMixin + +```ts +withSupplementalGroupsMixin(supplementalGroups) +``` + +"A list of groups applied to the first process run in each container, in addition\nto the container's primary GID, the fsGroup (if specified), and group memberships\ndefined in the container image for the uid of the container process. If unspecified,\nno additional groups are added to any container. Note that group memberships\ndefined in the container image for the uid of the container process are still effective,\neven if they are not included in this list.\nNote that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +### fn spec.securityContext.withSysctls + +```ts +withSysctls(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.withSysctlsMixin + +```ts +withSysctlsMixin(sysctls) +``` + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +**Note:** This function appends passed data to existing values + +## obj spec.securityContext.appArmorProfile + +"appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.appArmorProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\"." + +### fn spec.securityContext.appArmorProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement." + +## obj spec.securityContext.seLinuxOptions + +"The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.seLinuxOptions.withLevel + +```ts +withLevel(level) +``` + +"Level is SELinux level label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withRole + +```ts +withRole(role) +``` + +"Role is a SELinux role label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withType + +```ts +withType(type) +``` + +"Type is a SELinux type label that applies to the container." + +### fn spec.securityContext.seLinuxOptions.withUser + +```ts +withUser(user) +``` + +"User is a SELinux user label that applies to the container." + +## obj spec.securityContext.seccompProfile + +"The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.seccompProfile.withLocalhostProfile + +```ts +withLocalhostProfile(localhostProfile) +``` + +"localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type." + +### fn spec.securityContext.seccompProfile.withType + +```ts +withType(type) +``` + +"type indicates which kind of seccomp profile will be applied.\nValid options are:\n\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied." + +## obj spec.securityContext.sysctls + +"Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows." + +### fn spec.securityContext.sysctls.withName + +```ts +withName(name) +``` + +"Name of a property to set" + +### fn spec.securityContext.sysctls.withValue + +```ts +withValue(value) +``` + +"Value of a property to set" + +## obj spec.securityContext.windowsOptions + +"The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux." + +### fn spec.securityContext.windowsOptions.withGmsaCredentialSpec + +```ts +withGmsaCredentialSpec(gmsaCredentialSpec) +``` + +"GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field." + +### fn spec.securityContext.windowsOptions.withGmsaCredentialSpecName + +```ts +withGmsaCredentialSpecName(gmsaCredentialSpecName) +``` + +"GMSACredentialSpecName is the name of the GMSA credential spec to use." + +### fn spec.securityContext.windowsOptions.withHostProcess + +```ts +withHostProcess(hostProcess) +``` + +"HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true." + +### fn spec.securityContext.windowsOptions.withRunAsUserName + +```ts +withRunAsUserName(runAsUserName) +``` + +"The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence." + +## obj spec.serviceMonitorNamespaceSelector + +"Namespaces to match for ServicedMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only." + +### fn spec.serviceMonitorNamespaceSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.serviceMonitorNamespaceSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.serviceMonitorNamespaceSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.serviceMonitorNamespaceSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.serviceMonitorNamespaceSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.serviceMonitorNamespaceSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.serviceMonitorNamespaceSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.serviceMonitorNamespaceSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.serviceMonitorSelector + +"ServiceMonitors to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead." + +### fn spec.serviceMonitorSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.serviceMonitorSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.serviceMonitorSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.serviceMonitorSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.serviceMonitorSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.serviceMonitorSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.serviceMonitorSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.serviceMonitorSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.storage + +"Storage defines the storage used by Prometheus." + +### fn spec.storage.withDisableMountSubPath + +```ts +withDisableMountSubPath(disableMountSubPath) +``` + +"Deprecated: subPath usage will be removed in a future release." + +## obj spec.storage.emptyDir + +"EmptyDirVolumeSource to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir" + +### fn spec.storage.emptyDir.withMedium + +```ts +withMedium(medium) +``` + +"medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.storage.emptyDir.withSizeLimit + +```ts +withSizeLimit(sizeLimit) +``` + +"sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +## obj spec.storage.ephemeral + +"EphemeralVolumeSource to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes" + +## obj spec.storage.ephemeral.volumeClaimTemplate + +"Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\n\nRequired, must not be nil." + +### fn spec.storage.ephemeral.volumeClaimTemplate.withMetadata + +```ts +withMetadata(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +### fn spec.storage.ephemeral.volumeClaimTemplate.withMetadataMixin + +```ts +withMetadataMixin(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec + +"The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate + +"Defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes." + +### fn spec.storage.volumeClaimTemplate.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources" + +### fn spec.storage.volumeClaimTemplate.withKind + +```ts +withKind(kind) +``` + +"Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds" + +## obj spec.storage.volumeClaimTemplate.metadata + +"EmbeddedMetadata contains metadata relevant to an EmbeddedResource." + +### fn spec.storage.volumeClaimTemplate.metadata.withAnnotations + +```ts +withAnnotations(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +### fn spec.storage.volumeClaimTemplate.metadata.withAnnotationsMixin + +```ts +withAnnotationsMixin(annotations) +``` + +"Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.metadata.withLabels + +```ts +withLabels(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +### fn spec.storage.volumeClaimTemplate.metadata.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.metadata.withName + +```ts +withName(name) +``` + +"Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + +## obj spec.storage.volumeClaimTemplate.spec + +"Defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.storage.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.storage.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.storage.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.storage.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.storage.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.storage.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.storage.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.storage.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.storage.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.storage.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.storage.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.tolerations + +"Defines the Pods' tolerations if specified." + +### fn spec.tolerations.withEffect + +```ts +withEffect(effect) +``` + +"Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute." + +### fn spec.tolerations.withKey + +```ts +withKey(key) +``` + +"Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys." + +### fn spec.tolerations.withOperator + +```ts +withOperator(operator) +``` + +"Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category." + +### fn spec.tolerations.withTolerationSeconds + +```ts +withTolerationSeconds(tolerationSeconds) +``` + +"TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system." + +### fn spec.tolerations.withValue + +```ts +withValue(value) +``` + +"Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string." + +## obj spec.topologySpreadConstraints + +"Defines the pod's topology spread constraints if specified." + +### fn spec.topologySpreadConstraints.withAdditionalLabelSelectors + +```ts +withAdditionalLabelSelectors(additionalLabelSelectors) +``` + +"Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint." + +### fn spec.topologySpreadConstraints.withMatchLabelKeys + +```ts +withMatchLabelKeys(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default)." + +### fn spec.topologySpreadConstraints.withMatchLabelKeysMixin + +```ts +withMatchLabelKeysMixin(matchLabelKeys) +``` + +"MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default)." + +**Note:** This function appends passed data to existing values + +### fn spec.topologySpreadConstraints.withMaxSkew + +```ts +withMaxSkew(maxSkew) +``` + +"MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n| zone1 | zone2 | zone3 |\n| P P | P P | P |\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed." + +### fn spec.topologySpreadConstraints.withMinDomains + +```ts +withMinDomains(minDomains) +``` + +"MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n| zone1 | zone2 | zone3 |\n| P P | P P | P P |\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew." + +### fn spec.topologySpreadConstraints.withNodeAffinityPolicy + +```ts +withNodeAffinityPolicy(nodeAffinityPolicy) +``` + +"NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\nwhen calculating pod topology spread skew. Options are:\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\n\nIf this value is nil, the behavior is equivalent to the Honor policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag." + +### fn spec.topologySpreadConstraints.withNodeTaintsPolicy + +```ts +withNodeTaintsPolicy(nodeTaintsPolicy) +``` + +"NodeTaintsPolicy indicates how we will treat node taints when calculating\npod topology spread skew. Options are:\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\nhas a toleration, are included.\n- Ignore: node taints are ignored. All nodes are included.\n\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.\nThis is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag." + +### fn spec.topologySpreadConstraints.withTopologyKey + +```ts +withTopologyKey(topologyKey) +``` + +"TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field." + +### fn spec.topologySpreadConstraints.withWhenUnsatisfiable + +```ts +withWhenUnsatisfiable(whenUnsatisfiable) +``` + +"WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it.\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod\nif and only if every possible node assignment for that pod would violate\n\"MaxSkew\" on some topology.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n| zone1 | zone2 | zone3 |\n| P P P | P | P |\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field." + +## obj spec.topologySpreadConstraints.labelSelector + +"LabelSelector is used to find matching pods.\nPods that match this label selector are counted to determine the number of pods\nin their corresponding topology domain." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchExpressionsMixin + +```ts +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 + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.topologySpreadConstraints.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.topologySpreadConstraints.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.tracingConfig + +"TracingConfig configures tracing in Prometheus.\n\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way." + +### fn spec.tracingConfig.withClientType + +```ts +withClientType(clientType) +``` + +"Client used to export the traces. Supported values are `http` or `grpc`." + +### fn spec.tracingConfig.withCompression + +```ts +withCompression(compression) +``` + +"Compression key for supported compression types. The only supported value is `gzip`." + +### fn spec.tracingConfig.withEndpoint + +```ts +withEndpoint(endpoint) +``` + +"Endpoint to send the traces to. Should be provided in format :." + +### fn spec.tracingConfig.withHeaders + +```ts +withHeaders(headers) +``` + +"Key-value pairs to be used as headers associated with gRPC or HTTP requests." + +### fn spec.tracingConfig.withHeadersMixin + +```ts +withHeadersMixin(headers) +``` + +"Key-value pairs to be used as headers associated with gRPC or HTTP requests." + +**Note:** This function appends passed data to existing values + +### fn spec.tracingConfig.withInsecure + +```ts +withInsecure(insecure) +``` + +"If disabled, the client will use a secure connection." + +### fn spec.tracingConfig.withSamplingFraction + +```ts +withSamplingFraction(samplingFraction) +``` + +"Sets the probability a given trace will be sampled. Must be a float from 0 through 1." + +### fn spec.tracingConfig.withTimeout + +```ts +withTimeout(timeout) +``` + +"Maximum time the exporter will wait for each batch export." + +## obj spec.tracingConfig.tlsConfig + +"TLS Config to use when sending traces." + +### fn spec.tracingConfig.tlsConfig.withCaFile + +```ts +withCaFile(caFile) +``` + +"Path to the CA cert in the Prometheus container to use for the targets." + +### fn spec.tracingConfig.tlsConfig.withCertFile + +```ts +withCertFile(certFile) +``` + +"Path to the client cert file in the Prometheus container for the targets." + +### fn spec.tracingConfig.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.tracingConfig.tlsConfig.withKeyFile + +```ts +withKeyFile(keyFile) +``` + +"Path to the client key file in the Prometheus container for the targets." + +### fn spec.tracingConfig.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.tracingConfig.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.tracingConfig.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.tracingConfig.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.tracingConfig.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.tracingConfig.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.tracingConfig.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.tracingConfig.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.tracingConfig.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tracingConfig.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.tracingConfig.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.tracingConfig.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.tracingConfig.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.tracingConfig.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.tracingConfig.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.tracingConfig.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tracingConfig.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.tracingConfig.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.tracingConfig.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tracingConfig.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tracingConfig.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.volumeMounts + +"VolumeMounts allows the configuration of additional VolumeMounts.\n\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects." + +### fn spec.volumeMounts.withMountPath + +```ts +withMountPath(mountPath) +``` + +"Path within the container at which the volume should be mounted. Must\nnot contain ':'." + +### fn spec.volumeMounts.withMountPropagation + +```ts +withMountPropagation(mountPropagation) +``` + +"mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None)." + +### fn spec.volumeMounts.withName + +```ts +withName(name) +``` + +"This must match the Name of a Volume." + +### fn spec.volumeMounts.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false." + +### fn spec.volumeMounts.withRecursiveReadOnly + +```ts +withRecursiveReadOnly(recursiveReadOnly) +``` + +"RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\n\nIf this field is not specified, it is treated as an equivalent of Disabled." + +### fn spec.volumeMounts.withSubPath + +```ts +withSubPath(subPath) +``` + +"Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root)." + +### fn spec.volumeMounts.withSubPathExpr + +```ts +withSubPathExpr(subPathExpr) +``` + +"Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive." + +## obj spec.volumes + +"Volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects." + +### fn spec.volumes.withName + +```ts +withName(name) +``` + +"name of the volume.\nMust be a DNS_LABEL and unique within the pod.\nMore 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\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.volumes.awsElasticBlockStore.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.awsElasticBlockStore.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty)." + +### fn spec.volumes.awsElasticBlockStore.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly value true will force the readOnly setting in VolumeMounts.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore" + +### fn spec.volumes.awsElasticBlockStore.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore 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 + +```ts +withCachingMode(cachingMode) +``` + +"cachingMode is the Host Caching mode: None, Read Only, Read Write." + +### fn spec.volumes.azureDisk.withDiskName + +```ts +withDiskName(diskName) +``` + +"diskName is the Name of the data disk in the blob storage" + +### fn spec.volumes.azureDisk.withDiskURI + +```ts +withDiskURI(diskURI) +``` + +"diskURI is the URI of data disk in the blob storage" + +### fn spec.volumes.azureDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.azureDisk.withKind + +```ts +withKind(kind) +``` + +"kind expected values are 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 + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force\nthe 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 + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.azureFile.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of secret that contains Azure Storage Account Name and Key" + +### fn spec.volumes.azureFile.withShareName + +```ts +withShareName(shareName) +``` + +"shareName is the azure 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 + +```ts +withMonitors(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is Required: Monitors is a collection of Ceph monitors\nMore 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 + +```ts +withPath(path) +``` + +"path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /" + +### fn spec.volumes.cephfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withSecretFile + +```ts +withSecretFile(secretFile) +``` + +"secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.withUser + +```ts +withUser(user) +``` + +"user is optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +## obj spec.volumes.cephfs.secretRef + +"secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it" + +### fn spec.volumes.cephfs.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.cinder + +"cinder represents a cinder volume attached and mounted on kubelets host machine.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +### fn spec.volumes.cinder.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md" + +## obj spec.volumes.cinder.secretRef + +"secretRef is optional: points to a secret object containing parameters used to connect\nto OpenStack." + +### fn spec.volumes.cinder.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.configMap + +"configMap represents a configMap that should populate this volume" + +### fn spec.volumes.configMap.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.volumes.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.csi + +"csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature)." + +### fn spec.volumes.csi.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster." + +### fn spec.volumes.csi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply." + +### fn spec.volumes.csi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write)." + +### fn spec.volumes.csi.withVolumeAttributes + +```ts +withVolumeAttributes(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values." + +### fn spec.volumes.csi.withVolumeAttributesMixin + +```ts +withVolumeAttributesMixin(volumeAttributes) +``` + +"volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. 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\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed." + +### fn spec.volumes.csi.nodePublishSecretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.downwardAPI + +"downwardAPI represents downward API about the pod that should populate this volume" + +### fn spec.volumes.downwardAPI.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of downward API volume file" + +### fn spec.volumes.downwardAPI.withItemsMixin + +```ts +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 + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.downwardAPI.items.withPath + +```ts +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, namespace and uid are supported." + +### fn spec.volumes.downwardAPI.items.fieldRef.withApiVersion + +```ts +withApiVersion(apiVersion) +``` + +"Version of the schema the FieldPath is written in terms of, defaults to \"v1\"." + +### fn spec.volumes.downwardAPI.items.fieldRef.withFieldPath + +```ts +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\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.volumes.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.volumes.emptyDir + +"emptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.volumes.emptyDir.withMedium + +```ts +withMedium(medium) +``` + +"medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +### fn spec.volumes.emptyDir.withSizeLimit + +```ts +withSizeLimit(sizeLimit) +``` + +"sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir" + +## obj spec.volumes.ephemeral + +"ephemeral represents a volume that is handled by a cluster storage driver.\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\nand deleted when the pod is removed.\n\n\nUse this if:\na) the volume is only needed while the pod runs,\nb) features of normal volumes like restoring from snapshot or capacity\n tracking are needed,\nc) the storage driver is specified through a storage class, and\nd) the storage driver supports dynamic volume provisioning through\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\n information on the connection between this volume type\n and PersistentVolumeClaim).\n\n\nUse PersistentVolumeClaim or one of the vendor-specific\nAPIs for volumes that persist for longer than the lifecycle\nof an individual pod.\n\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\nbe used that way - see the documentation of the driver for\nmore information.\n\n\nA pod can use both types of ephemeral volumes and\npersistent volumes at the same time." + +## obj spec.volumes.ephemeral.volumeClaimTemplate + +"Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\n\nRequired, must not be nil." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.withMetadata + +```ts +withMetadata(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.withMetadataMixin + +```ts +withMetadataMixin(metadata) +``` + +"May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec + +"The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModes + +```ts +withAccessModes(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withAccessModesMixin + +```ts +withAccessModesMixin(accessModes) +``` + +"accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withStorageClassName + +```ts +withStorageClassName(storageClassName) +``` + +"storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeAttributesClassName + +```ts +withVolumeAttributesClassName(volumeAttributesClassName) +``` + +"volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeMode + +```ts +withVolumeMode(volumeMode) +``` + +"volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the binding reference to the PersistentVolume backing this claim." + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource + +"dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSource.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef + +"dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withApiGroup + +```ts +withApiGroup(apiGroup) +``` + +"APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withKind + +```ts +withKind(kind) +``` + +"Kind is the type of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withName + +```ts +withName(name) +``` + +"Name is the name of resource being referenced" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.dataSourceRef.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled." + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.resources + +"resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimits + +```ts +withLimits(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withLimitsMixin + +```ts +withLimitsMixin(limits) +``` + +"Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequests + +```ts +withRequests(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.resources.withRequestsMixin + +```ts +withRequestsMixin(requests) +``` + +"Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/" + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector + +"selector is a label query over volumes to consider for binding." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchExpressionsMixin + +```ts +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.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.volumes.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.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 + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.fc.withLun + +```ts +withLun(lun) +``` + +"lun is Optional: FC target lun number" + +### fn spec.volumes.fc.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.fc.withTargetWWNs + +```ts +withTargetWWNs(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +### fn spec.volumes.fc.withTargetWWNsMixin + +```ts +withTargetWWNsMixin(targetWWNs) +``` + +"targetWWNs is Optional: FC target worldwide names (WWNs)" + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.fc.withWwids + +```ts +withWwids(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously." + +### fn spec.volumes.fc.withWwidsMixin + +```ts +withWwidsMixin(wwids) +``` + +"wwids Optional: FC volume world wide identifiers (wwids)\nEither 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\nprovisioned/attached using an exec based plugin." + +### fn spec.volumes.flexVolume.withDriver + +```ts +withDriver(driver) +``` + +"driver is the name of the driver to use for this volume." + +### fn spec.volumes.flexVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script." + +### fn spec.volumes.flexVolume.withOptions + +```ts +withOptions(options) +``` + +"options is Optional: this field holds extra command options if any." + +### fn spec.volumes.flexVolume.withOptionsMixin + +```ts +withOptionsMixin(options) +``` + +"options is Optional: this field holds extra command options if any." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.flexVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +## obj spec.volumes.flexVolume.secretRef + +"secretRef is Optional: secretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts." + +### fn spec.volumes.flexVolume.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.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 + +```ts +withDatasetName(datasetName) +``` + +"datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker\nshould be considered as deprecated" + +### fn spec.volumes.flocker.withDatasetUUID + +```ts +withDatasetUUID(datasetUUID) +``` + +"datasetUUID is the 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\nkubelet's host machine and then exposed to the pod.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.gcePersistentDisk.withPartition + +```ts +withPartition(partition) +``` + +"partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withPdName + +```ts +withPdName(pdName) +``` + +"pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +### fn spec.volumes.gcePersistentDisk.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk" + +## obj spec.volumes.gitRepo + +"gitRepo represents a git repository at a particular revision.\nDEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container." + +### fn spec.volumes.gitRepo.withDirectory + +```ts +withDirectory(directory) +``` + +"directory is the target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name." + +### fn spec.volumes.gitRepo.withRepository + +```ts +withRepository(repository) +``` + +"repository is the URL" + +### fn spec.volumes.gitRepo.withRevision + +```ts +withRevision(revision) +``` + +"revision is the commit hash for the specified revision." + +## obj spec.volumes.glusterfs + +"glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md" + +### fn spec.volumes.glusterfs.withEndpoints + +```ts +withEndpoints(endpoints) +``` + +"endpoints is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.volumes.glusterfs.withPath + +```ts +withPath(path) +``` + +"path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod" + +### fn spec.volumes.glusterfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore 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\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath\n---\nTODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not\nmount host directories as read/write." + +### fn spec.volumes.hostPath.withPath + +```ts +withPath(path) +``` + +"path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +### fn spec.volumes.hostPath.withType + +```ts +withType(type) +``` + +"type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath" + +## obj spec.volumes.iscsi + +"iscsi represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://examples.k8s.io/volumes/iscsi/README.md" + +### fn spec.volumes.iscsi.withChapAuthDiscovery + +```ts +withChapAuthDiscovery(chapAuthDiscovery) +``` + +"chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication" + +### fn spec.volumes.iscsi.withChapAuthSession + +```ts +withChapAuthSession(chapAuthSession) +``` + +"chapAuthSession defines whether support iSCSI Session CHAP authentication" + +### fn spec.volumes.iscsi.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.iscsi.withInitiatorName + +```ts +withInitiatorName(initiatorName) +``` + +"initiatorName is the custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n: will be created for the connection." + +### fn spec.volumes.iscsi.withIqn + +```ts +withIqn(iqn) +``` + +"iqn is the target iSCSI Qualified Name." + +### fn spec.volumes.iscsi.withIscsiInterface + +```ts +withIscsiInterface(iscsiInterface) +``` + +"iscsiInterface is the interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp)." + +### fn spec.volumes.iscsi.withLun + +```ts +withLun(lun) +``` + +"lun represents iSCSI Target Lun number." + +### fn spec.volumes.iscsi.withPortals + +```ts +withPortals(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +### fn spec.volumes.iscsi.withPortalsMixin + +```ts +withPortalsMixin(portals) +``` + +"portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.iscsi.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false." + +### fn spec.volumes.iscsi.withTargetPortal + +```ts +withTargetPortal(targetPortal) +``` + +"targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260)." + +## obj spec.volumes.iscsi.secretRef + +"secretRef is the CHAP Secret for iSCSI target and initiator authentication" + +### fn spec.volumes.iscsi.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.nfs + +"nfs represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withPath + +```ts +withPath(path) +``` + +"path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +### fn spec.volumes.nfs.withServer + +```ts +withServer(server) +``` + +"server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs" + +## obj spec.volumes.persistentVolumeClaim + +"persistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.volumes.persistentVolumeClaim.withClaimName + +```ts +withClaimName(claimName) +``` + +"claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims" + +### fn spec.volumes.persistentVolumeClaim.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Will force the ReadOnly setting in VolumeMounts.\nDefault false." + +## obj spec.volumes.photonPersistentDisk + +"photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine" + +### fn spec.volumes.photonPersistentDisk.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.photonPersistentDisk.withPdID + +```ts +withPdID(pdID) +``` + +"pdID is the 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 + +```ts +withFsType(fsType) +``` + +"fSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.portworxVolume.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.portworxVolume.withVolumeID + +```ts +withVolumeID(volumeID) +``` + +"volumeID uniquely identifies a Portworx volume" + +## obj spec.volumes.projected + +"projected items for all in one resources secrets, configmaps, and downward API" + +### fn spec.volumes.projected.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode are the mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.withSources + +```ts +withSources(sources) +``` + +"sources is the list of volume projections" + +### fn spec.volumes.projected.withSourcesMixin + +```ts +withSourcesMixin(sources) +``` + +"sources is the list of volume projections" + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources + +"sources is the list of volume projections" + +## obj spec.volumes.projected.sources.clusterTrustBundle + +"ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\nof ClusterTrustBundle objects in an auto-updating file.\n\n\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\n\n\nClusterTrustBundle objects can either be selected by name, or by the\ncombination of signer name and a label selector.\n\n\nKubelet performs aggressive normalization of the PEM contents written\ninto the pod filesystem. Esoteric PEM features such as inter-block\ncomments and block headers are stripped. Certificates are deduplicated.\nThe ordering of certificates within the file is arbitrary, and Kubelet\nmay change the order over time." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withName + +```ts +withName(name) +``` + +"Select a single ClusterTrustBundle by object name. Mutually-exclusive\nwith signerName and labelSelector." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withOptional + +```ts +withOptional(optional) +``` + +"If true, don't block pod startup if the referenced ClusterTrustBundle(s)\naren't available. If using name, then the named ClusterTrustBundle is\nallowed not to exist. If using signerName, then the combination of\nsignerName and labelSelector is allowed to match zero\nClusterTrustBundles." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withPath + +```ts +withPath(path) +``` + +"Relative path from the volume root to write the bundle." + +### fn spec.volumes.projected.sources.clusterTrustBundle.withSignerName + +```ts +withSignerName(signerName) +``` + +"Select all ClusterTrustBundles that match this signer name.\nMutually-exclusive with name. The contents of all selected\nClusterTrustBundles will be unified and deduplicated." + +## obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector + +"Select all ClusterTrustBundles that match this label selector. Only has\neffect if signerName is set. Mutually-exclusive with name. If unset,\ninterpreted as \"match nothing\". If set but empty, interpreted as \"match\neverything\"." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchExpressions + +```ts +withMatchExpressions(matchExpressions) +``` + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchExpressionsMixin + +```ts +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.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchLabels + +```ts +withMatchLabels(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.withMatchLabelsMixin + +```ts +withMatchLabelsMixin(matchLabels) +``` + +"matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions + +"matchExpressions is a list of label selector requirements. The requirements are ANDed." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withKey + +```ts +withKey(key) +``` + +"key is the label key that the selector applies to." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withOperator + +```ts +withOperator(operator) +``` + +"operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withValues + +```ts +withValues(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +### fn spec.volumes.projected.sources.clusterTrustBundle.labelSelector.matchExpressions.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch." + +**Note:** This function appends passed data to existing values + +## obj spec.volumes.projected.sources.configMap + +"configMap information about the configMap data to project" + +### fn spec.volumes.projected.sources.configMap.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.configMap.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative 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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.projected.sources.configMap.withOptional + +```ts +withOptional(optional) +``` + +"optional specify whether the ConfigMap or its keys must be defined" + +## obj spec.volumes.projected.sources.configMap.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.configMap.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.projected.sources.configMap.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.configMap.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.projected.sources.downwardAPI + +"downwardAPI information about the downwardAPI data to project" + +### fn spec.volumes.projected.sources.downwardAPI.withItems + +```ts +withItems(items) +``` + +"Items is a list of DownwardAPIVolume file" + +### fn spec.volumes.projected.sources.downwardAPI.withItemsMixin + +```ts +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 + +```ts +withMode(mode) +``` + +"Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.downwardAPI.items.withPath + +```ts +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, namespace and uid are supported." + +### fn spec.volumes.projected.sources.downwardAPI.items.fieldRef.withApiVersion + +```ts +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 + +```ts +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\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported." + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withContainerName + +```ts +withContainerName(containerName) +``` + +"Container name: required for volumes, optional for env vars" + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withDivisor + +```ts +withDivisor(divisor) +``` + +"Specifies the output format of the exposed resources, defaults to \"1\ + +### fn spec.volumes.projected.sources.downwardAPI.items.resourceFieldRef.withResource + +```ts +withResource(resource) +``` + +"Required: resource to select" + +## obj spec.volumes.projected.sources.secret + +"secret information about the secret data to project" + +### fn spec.volumes.projected.sources.secret.withItems + +```ts +withItems(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative 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 + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.volumes.projected.sources.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its key must be defined" + +## obj spec.volumes.projected.sources.secret.items + +"items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.projected.sources.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.projected.sources.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.projected.sources.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'." + +## obj spec.volumes.projected.sources.serviceAccountToken + +"serviceAccountToken is information about the serviceAccountToken data to project" + +### fn spec.volumes.projected.sources.serviceAccountToken.withAudience + +```ts +withAudience(audience) +``` + +"audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver." + +### fn spec.volumes.projected.sources.serviceAccountToken.withExpirationSeconds + +```ts +withExpirationSeconds(expirationSeconds) +``` + +"expirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes." + +### fn spec.volumes.projected.sources.serviceAccountToken.withPath + +```ts +withPath(path) +``` + +"path is the path relative to the mount point of the file to project the\ntoken into." + +## obj spec.volumes.quobyte + +"quobyte represents a Quobyte mount on the host that shares a pod's lifetime" + +### fn spec.volumes.quobyte.withGroup + +```ts +withGroup(group) +``` + +"group to map volume access to\nDefault is no group" + +### fn spec.volumes.quobyte.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false." + +### fn spec.volumes.quobyte.withRegistry + +```ts +withRegistry(registry) +``` + +"registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes" + +### fn spec.volumes.quobyte.withTenant + +```ts +withTenant(tenant) +``` + +"tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin" + +### fn spec.volumes.quobyte.withUser + +```ts +withUser(user) +``` + +"user to map volume access to\nDefaults to serivceaccount user" + +### fn spec.volumes.quobyte.withVolume + +```ts +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.\nMore info: https://examples.k8s.io/volumes/rbd/README.md" + +### fn spec.volumes.rbd.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd\nTODO: how do we prevent errors in the filesystem from compromising the machine" + +### fn spec.volumes.rbd.withImage + +```ts +withImage(image) +``` + +"image is the rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withKeyring + +```ts +withKeyring(keyring) +``` + +"keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withMonitors + +```ts +withMonitors(monitors) +``` + +"monitors is a collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withMonitorsMixin + +```ts +withMonitorsMixin(monitors) +``` + +"monitors is a collection of Ceph monitors.\nMore 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 + +```ts +withPool(pool) +``` + +"pool is the rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.withUser + +```ts +withUser(user) +``` + +"user is the rados user name.\nDefault is admin.\nMore 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\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it" + +### fn spec.volumes.rbd.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.scaleIO + +"scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes." + +### fn spec.volumes.scaleIO.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\"." + +### fn spec.volumes.scaleIO.withGateway + +```ts +withGateway(gateway) +``` + +"gateway is the host address of the ScaleIO API Gateway." + +### fn spec.volumes.scaleIO.withProtectionDomain + +```ts +withProtectionDomain(protectionDomain) +``` + +"protectionDomain is the name of the ScaleIO Protection Domain for the configured storage." + +### fn spec.volumes.scaleIO.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.scaleIO.withSslEnabled + +```ts +withSslEnabled(sslEnabled) +``` + +"sslEnabled Flag enable/disable SSL communication with Gateway, default false" + +### fn spec.volumes.scaleIO.withStorageMode + +```ts +withStorageMode(storageMode) +``` + +"storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned." + +### fn spec.volumes.scaleIO.withStoragePool + +```ts +withStoragePool(storagePool) +``` + +"storagePool is the ScaleIO Storage Pool associated with the protection domain." + +### fn spec.volumes.scaleIO.withSystem + +```ts +withSystem(system) +``` + +"system is the name of the storage system as configured in ScaleIO." + +### fn spec.volumes.scaleIO.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the name of a volume already created in the ScaleIO system\nthat is associated with this volume source." + +## obj spec.volumes.scaleIO.secretRef + +"secretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail." + +### fn spec.volumes.scaleIO.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.secret + +"secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +### fn spec.volumes.secret.withDefaultMode + +```ts +withDefaultMode(defaultMode) +``` + +"defaultMode is Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.secret.withItems + +```ts +withItems(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.secret.withItemsMixin + +```ts +withItemsMixin(items) +``` + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +**Note:** This function appends passed data to existing values + +### fn spec.volumes.secret.withOptional + +```ts +withOptional(optional) +``` + +"optional field specify whether the Secret or its keys must be defined" + +### fn spec.volumes.secret.withSecretName + +```ts +withSecretName(secretName) +``` + +"secretName is the name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret" + +## obj spec.volumes.secret.items + +"items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'." + +### fn spec.volumes.secret.items.withKey + +```ts +withKey(key) +``` + +"key is the key to project." + +### fn spec.volumes.secret.items.withMode + +```ts +withMode(mode) +``` + +"mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set." + +### fn spec.volumes.secret.items.withPath + +```ts +withPath(path) +``` + +"path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay 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 + +```ts +withFsType(fsType) +``` + +"fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.storageos.withReadOnly + +```ts +withReadOnly(readOnly) +``` + +"readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts." + +### fn spec.volumes.storageos.withVolumeName + +```ts +withVolumeName(volumeName) +``` + +"volumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace." + +### fn spec.volumes.storageos.withVolumeNamespace + +```ts +withVolumeNamespace(volumeNamespace) +``` + +"volumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces 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\ncredentials. If not specified, default values will be attempted." + +### fn spec.volumes.storageos.secretRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +## obj spec.volumes.vsphereVolume + +"vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine" + +### fn spec.volumes.vsphereVolume.withFsType + +```ts +withFsType(fsType) +``` + +"fsType is filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified." + +### fn spec.volumes.vsphereVolume.withStoragePolicyID + +```ts +withStoragePolicyID(storagePolicyID) +``` + +"storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName." + +### fn spec.volumes.vsphereVolume.withStoragePolicyName + +```ts +withStoragePolicyName(storagePolicyName) +``` + +"storagePolicyName is the storage Policy Based Management (SPBM) profile name." + +### fn spec.volumes.vsphereVolume.withVolumePath + +```ts +withVolumePath(volumePath) +``` + +"volumePath is the path that identifies vSphere volume vmdk" + +## obj spec.web + +"Defines the configuration of the Prometheus web server." + +### fn spec.web.withMaxConnections + +```ts +withMaxConnections(maxConnections) +``` + +"Defines the maximum number of simultaneous connections\nA zero value means that Prometheus doesn't accept any incoming connection." + +### fn spec.web.withPageTitle + +```ts +withPageTitle(pageTitle) +``` + +"The prometheus web page title." + +## obj spec.web.httpConfig + +"Defines HTTP parameters for web server." + +### fn spec.web.httpConfig.withHttp2 + +```ts +withHttp2(http2) +``` + +"Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered." + +## obj spec.web.httpConfig.headers + +"List of headers that can be added to HTTP responses." + +### fn spec.web.httpConfig.headers.withContentSecurityPolicy + +```ts +withContentSecurityPolicy(contentSecurityPolicy) +``` + +"Set the Content-Security-Policy header to HTTP responses.\nUnset if blank." + +### fn spec.web.httpConfig.headers.withStrictTransportSecurity + +```ts +withStrictTransportSecurity(strictTransportSecurity) +``` + +"Set the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security" + +### fn spec.web.httpConfig.headers.withXContentTypeOptions + +```ts +withXContentTypeOptions(xContentTypeOptions) +``` + +"Set the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options" + +### fn spec.web.httpConfig.headers.withXFrameOptions + +```ts +withXFrameOptions(xFrameOptions) +``` + +"Set the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options" + +### fn spec.web.httpConfig.headers.withXXSSProtection + +```ts +withXXSSProtection(xXSSProtection) +``` + +"Set the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection" + +## obj spec.web.tlsConfig + +"Defines the TLS parameters for HTTPS." + +### fn spec.web.tlsConfig.withCipherSuites + +```ts +withCipherSuites(cipherSuites) +``` + +"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\nGo default cipher suites are used. Available cipher suites are documented\nin the go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants" + +### fn spec.web.tlsConfig.withCipherSuitesMixin + +```ts +withCipherSuitesMixin(cipherSuites) +``` + +"List of supported cipher suites for TLS versions up to TLS 1.2. If empty,\nGo default cipher suites are used. Available cipher suites are documented\nin 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 + +```ts +withClientAuthType(clientAuthType) +``` + +"Server policy for client authentication. Maps to ClientAuth Policies.\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType" + +### fn spec.web.tlsConfig.withCurvePreferences + +```ts +withCurvePreferences(curvePreferences) +``` + +"Elliptic curves that will be used in an ECDHE handshake, in preference\norder. Available curves are documented in the go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID" + +### fn spec.web.tlsConfig.withCurvePreferencesMixin + +```ts +withCurvePreferencesMixin(curvePreferences) +``` + +"Elliptic curves that will be used in an ECDHE handshake, in preference\norder. Available curves are documented in the go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID" + +**Note:** This function appends passed data to existing values + +### fn spec.web.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum TLS version that is acceptable. Defaults to TLS13." + +### fn spec.web.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum TLS version that is acceptable. Defaults to TLS12." + +### fn spec.web.tlsConfig.withPreferServerCipherSuites + +```ts +withPreferServerCipherSuites(preferServerCipherSuites) +``` + +"Controls whether the server selects the\nclient's most preferred cipher suite, or the server's most preferred\ncipher suite. If true then the server's preference, as expressed in\nthe 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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.web.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.cert.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.cert.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.web.tlsConfig.client_ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.client_ca.configMap.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.client_ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.client_ca.secret.withOptional + +```ts +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 + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.web.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.web.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" \ No newline at end of file diff --git a/docs/0.14/monitoring/v1alpha1/relabelConfig.md b/docs/0.14/monitoring/v1alpha1/relabelConfig.md new file mode 100644 index 0000000..b68c19c --- /dev/null +++ b/docs/0.14/monitoring/v1alpha1/relabelConfig.md @@ -0,0 +1,75 @@ +--- +permalink: /0.14/monitoring/v1alpha1/relabelConfig/ +--- + +# monitoring.v1alpha1.relabelConfig + +RelabelConfig is a help to build RelabelConfig objects for ServiceMonitors and PodMonitors + +## Index + +* [`fn withAction(separator)`](#fn-withaction) +* [`fn withModulus(modulus)`](#fn-withmodulus) +* [`fn withRegex(separator)`](#fn-withregex) +* [`fn withReplacement(separator)`](#fn-withreplacement) +* [`fn withSeparator(separator)`](#fn-withseparator) +* [`fn withSourceLabels(labels)`](#fn-withsourcelabels) +* [`fn withTargetLabel(separator)`](#fn-withtargetlabel) + +## Fields + +### fn withAction + +```ts +withAction(separator) +``` + +Action to perform based on regex matching. Default is ‘replace’ + +### fn withModulus + +```ts +withModulus(modulus) +``` + +Modulus to take of the hash of the source label values. + +### fn withRegex + +```ts +withRegex(separator) +``` + +Regular expression against which the extracted value is matched. Default is ‘(.*)’ + +### fn withReplacement + +```ts +withReplacement(separator) +``` + +Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Default is ‘$1’ + +### fn withSeparator + +```ts +withSeparator(separator) +``` + +Separator placed between concatenated source label values. default is ‘;’. + +### fn withSourceLabels + +```ts +withSourceLabels(labels) +``` + +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 withTargetLabel + +```ts +withTargetLabel(separator) +``` + +Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. \ No newline at end of file diff --git a/docs/0.14/monitoring/v1alpha1/scrapeConfig.md b/docs/0.14/monitoring/v1alpha1/scrapeConfig.md new file mode 100644 index 0000000..d834b35 --- /dev/null +++ b/docs/0.14/monitoring/v1alpha1/scrapeConfig.md @@ -0,0 +1,13972 @@ +--- +permalink: /0.14/monitoring/v1alpha1/scrapeConfig/ +--- + +# monitoring.v1alpha1.scrapeConfig + +"ScrapeConfig defines a namespaced Prometheus scrape_config to be aggregated across\nmultiple namespaces into the Prometheus configuration." + +## Index + +* [`fn new(name)`](#fn-new) +* [`obj metadata`](#obj-metadata) + * [`fn withAnnotations(annotations)`](#fn-metadatawithannotations) + * [`fn withAnnotationsMixin(annotations)`](#fn-metadatawithannotationsmixin) + * [`fn withClusterName(clusterName)`](#fn-metadatawithclustername) + * [`fn withCreationTimestamp(creationTimestamp)`](#fn-metadatawithcreationtimestamp) + * [`fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)`](#fn-metadatawithdeletiongraceperiodseconds) + * [`fn withDeletionTimestamp(deletionTimestamp)`](#fn-metadatawithdeletiontimestamp) + * [`fn withFinalizers(finalizers)`](#fn-metadatawithfinalizers) + * [`fn withFinalizersMixin(finalizers)`](#fn-metadatawithfinalizersmixin) + * [`fn withGenerateName(generateName)`](#fn-metadatawithgeneratename) + * [`fn withGeneration(generation)`](#fn-metadatawithgeneration) + * [`fn withLabels(labels)`](#fn-metadatawithlabels) + * [`fn withLabelsMixin(labels)`](#fn-metadatawithlabelsmixin) + * [`fn withName(name)`](#fn-metadatawithname) + * [`fn withNamespace(namespace)`](#fn-metadatawithnamespace) + * [`fn withOwnerReferences(ownerReferences)`](#fn-metadatawithownerreferences) + * [`fn withOwnerReferencesMixin(ownerReferences)`](#fn-metadatawithownerreferencesmixin) + * [`fn withResourceVersion(resourceVersion)`](#fn-metadatawithresourceversion) + * [`fn withSelfLink(selfLink)`](#fn-metadatawithselflink) + * [`fn withUid(uid)`](#fn-metadatawithuid) +* [`obj spec`](#obj-spec) + * [`fn withAzureSDConfigs(azureSDConfigs)`](#fn-specwithazuresdconfigs) + * [`fn withAzureSDConfigsMixin(azureSDConfigs)`](#fn-specwithazuresdconfigsmixin) + * [`fn withConsulSDConfigs(consulSDConfigs)`](#fn-specwithconsulsdconfigs) + * [`fn withConsulSDConfigsMixin(consulSDConfigs)`](#fn-specwithconsulsdconfigsmixin) + * [`fn withDigitalOceanSDConfigs(digitalOceanSDConfigs)`](#fn-specwithdigitaloceansdconfigs) + * [`fn withDigitalOceanSDConfigsMixin(digitalOceanSDConfigs)`](#fn-specwithdigitaloceansdconfigsmixin) + * [`fn withDnsSDConfigs(dnsSDConfigs)`](#fn-specwithdnssdconfigs) + * [`fn withDnsSDConfigsMixin(dnsSDConfigs)`](#fn-specwithdnssdconfigsmixin) + * [`fn withDockerSDConfigs(dockerSDConfigs)`](#fn-specwithdockersdconfigs) + * [`fn withDockerSDConfigsMixin(dockerSDConfigs)`](#fn-specwithdockersdconfigsmixin) + * [`fn withDockerSwarmSDConfigs(dockerSwarmSDConfigs)`](#fn-specwithdockerswarmsdconfigs) + * [`fn withDockerSwarmSDConfigsMixin(dockerSwarmSDConfigs)`](#fn-specwithdockerswarmsdconfigsmixin) + * [`fn withEc2SDConfigs(ec2SDConfigs)`](#fn-specwithec2sdconfigs) + * [`fn withEc2SDConfigsMixin(ec2SDConfigs)`](#fn-specwithec2sdconfigsmixin) + * [`fn withEnableCompression(enableCompression)`](#fn-specwithenablecompression) + * [`fn withEurekaSDConfigs(eurekaSDConfigs)`](#fn-specwitheurekasdconfigs) + * [`fn withEurekaSDConfigsMixin(eurekaSDConfigs)`](#fn-specwitheurekasdconfigsmixin) + * [`fn withFileSDConfigs(fileSDConfigs)`](#fn-specwithfilesdconfigs) + * [`fn withFileSDConfigsMixin(fileSDConfigs)`](#fn-specwithfilesdconfigsmixin) + * [`fn withGceSDConfigs(gceSDConfigs)`](#fn-specwithgcesdconfigs) + * [`fn withGceSDConfigsMixin(gceSDConfigs)`](#fn-specwithgcesdconfigsmixin) + * [`fn withHetznerSDConfigs(hetznerSDConfigs)`](#fn-specwithhetznersdconfigs) + * [`fn withHetznerSDConfigsMixin(hetznerSDConfigs)`](#fn-specwithhetznersdconfigsmixin) + * [`fn withHonorLabels(honorLabels)`](#fn-specwithhonorlabels) + * [`fn withHonorTimestamps(honorTimestamps)`](#fn-specwithhonortimestamps) + * [`fn withHttpSDConfigs(httpSDConfigs)`](#fn-specwithhttpsdconfigs) + * [`fn withHttpSDConfigsMixin(httpSDConfigs)`](#fn-specwithhttpsdconfigsmixin) + * [`fn withJobName(jobName)`](#fn-specwithjobname) + * [`fn withKeepDroppedTargets(keepDroppedTargets)`](#fn-specwithkeepdroppedtargets) + * [`fn withKubernetesSDConfigs(kubernetesSDConfigs)`](#fn-specwithkubernetessdconfigs) + * [`fn withKubernetesSDConfigsMixin(kubernetesSDConfigs)`](#fn-specwithkubernetessdconfigsmixin) + * [`fn withKumaSDConfigs(kumaSDConfigs)`](#fn-specwithkumasdconfigs) + * [`fn withKumaSDConfigsMixin(kumaSDConfigs)`](#fn-specwithkumasdconfigsmixin) + * [`fn withLabelLimit(labelLimit)`](#fn-specwithlabellimit) + * [`fn withLabelNameLengthLimit(labelNameLengthLimit)`](#fn-specwithlabelnamelengthlimit) + * [`fn withLabelValueLengthLimit(labelValueLengthLimit)`](#fn-specwithlabelvaluelengthlimit) + * [`fn withLightSailSDConfigs(lightSailSDConfigs)`](#fn-specwithlightsailsdconfigs) + * [`fn withLightSailSDConfigsMixin(lightSailSDConfigs)`](#fn-specwithlightsailsdconfigsmixin) + * [`fn withLinodeSDConfigs(linodeSDConfigs)`](#fn-specwithlinodesdconfigs) + * [`fn withLinodeSDConfigsMixin(linodeSDConfigs)`](#fn-specwithlinodesdconfigsmixin) + * [`fn withMetricRelabelings(metricRelabelings)`](#fn-specwithmetricrelabelings) + * [`fn withMetricRelabelingsMixin(metricRelabelings)`](#fn-specwithmetricrelabelingsmixin) + * [`fn withMetricsPath(metricsPath)`](#fn-specwithmetricspath) + * [`fn withNoProxy(noProxy)`](#fn-specwithnoproxy) + * [`fn withNomadSDConfigs(nomadSDConfigs)`](#fn-specwithnomadsdconfigs) + * [`fn withNomadSDConfigsMixin(nomadSDConfigs)`](#fn-specwithnomadsdconfigsmixin) + * [`fn withOpenstackSDConfigs(openstackSDConfigs)`](#fn-specwithopenstacksdconfigs) + * [`fn withOpenstackSDConfigsMixin(openstackSDConfigs)`](#fn-specwithopenstacksdconfigsmixin) + * [`fn withOvhcloudSDConfigs(ovhcloudSDConfigs)`](#fn-specwithovhcloudsdconfigs) + * [`fn withOvhcloudSDConfigsMixin(ovhcloudSDConfigs)`](#fn-specwithovhcloudsdconfigsmixin) + * [`fn withParams(params)`](#fn-specwithparams) + * [`fn withParamsMixin(params)`](#fn-specwithparamsmixin) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specwithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specwithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specwithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specwithproxyurl) + * [`fn withPuppetDBSDConfigs(puppetDBSDConfigs)`](#fn-specwithpuppetdbsdconfigs) + * [`fn withPuppetDBSDConfigsMixin(puppetDBSDConfigs)`](#fn-specwithpuppetdbsdconfigsmixin) + * [`fn withRelabelings(relabelings)`](#fn-specwithrelabelings) + * [`fn withRelabelingsMixin(relabelings)`](#fn-specwithrelabelingsmixin) + * [`fn withSampleLimit(sampleLimit)`](#fn-specwithsamplelimit) + * [`fn withScalewaySDConfigs(scalewaySDConfigs)`](#fn-specwithscalewaysdconfigs) + * [`fn withScalewaySDConfigsMixin(scalewaySDConfigs)`](#fn-specwithscalewaysdconfigsmixin) + * [`fn withScheme(scheme)`](#fn-specwithscheme) + * [`fn withScrapeClass(scrapeClass)`](#fn-specwithscrapeclass) + * [`fn withScrapeInterval(scrapeInterval)`](#fn-specwithscrapeinterval) + * [`fn withScrapeProtocols(scrapeProtocols)`](#fn-specwithscrapeprotocols) + * [`fn withScrapeProtocolsMixin(scrapeProtocols)`](#fn-specwithscrapeprotocolsmixin) + * [`fn withScrapeTimeout(scrapeTimeout)`](#fn-specwithscrapetimeout) + * [`fn withStaticConfigs(staticConfigs)`](#fn-specwithstaticconfigs) + * [`fn withStaticConfigsMixin(staticConfigs)`](#fn-specwithstaticconfigsmixin) + * [`fn withTargetLimit(targetLimit)`](#fn-specwithtargetlimit) + * [`fn withTrackTimestampsStaleness(trackTimestampsStaleness)`](#fn-specwithtracktimestampsstaleness) + * [`obj spec.authorization`](#obj-specauthorization) + * [`fn withType(type)`](#fn-specauthorizationwithtype) + * [`obj spec.authorization.credentials`](#obj-specauthorizationcredentials) + * [`fn withKey(key)`](#fn-specauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specauthorizationcredentialswithoptional) + * [`obj spec.azureSDConfigs`](#obj-specazuresdconfigs) + * [`fn withAuthenticationMethod(authenticationMethod)`](#fn-specazuresdconfigswithauthenticationmethod) + * [`fn withClientID(clientID)`](#fn-specazuresdconfigswithclientid) + * [`fn withEnvironment(environment)`](#fn-specazuresdconfigswithenvironment) + * [`fn withPort(port)`](#fn-specazuresdconfigswithport) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specazuresdconfigswithrefreshinterval) + * [`fn withResourceGroup(resourceGroup)`](#fn-specazuresdconfigswithresourcegroup) + * [`fn withSubscriptionID(subscriptionID)`](#fn-specazuresdconfigswithsubscriptionid) + * [`fn withTenantID(tenantID)`](#fn-specazuresdconfigswithtenantid) + * [`obj spec.azureSDConfigs.clientSecret`](#obj-specazuresdconfigsclientsecret) + * [`fn withKey(key)`](#fn-specazuresdconfigsclientsecretwithkey) + * [`fn withName(name)`](#fn-specazuresdconfigsclientsecretwithname) + * [`fn withOptional(optional)`](#fn-specazuresdconfigsclientsecretwithoptional) + * [`obj spec.basicAuth`](#obj-specbasicauth) + * [`obj spec.basicAuth.password`](#obj-specbasicauthpassword) + * [`fn withKey(key)`](#fn-specbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specbasicauthpasswordwithoptional) + * [`obj spec.basicAuth.username`](#obj-specbasicauthusername) + * [`fn withKey(key)`](#fn-specbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specbasicauthusernamewithoptional) + * [`obj spec.consulSDConfigs`](#obj-specconsulsdconfigs) + * [`fn withAllowStale(allowStale)`](#fn-specconsulsdconfigswithallowstale) + * [`fn withDatacenter(datacenter)`](#fn-specconsulsdconfigswithdatacenter) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-specconsulsdconfigswithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-specconsulsdconfigswithfollowredirects) + * [`fn withNamespace(namespace)`](#fn-specconsulsdconfigswithnamespace) + * [`fn withNoProxy(noProxy)`](#fn-specconsulsdconfigswithnoproxy) + * [`fn withNodeMeta(nodeMeta)`](#fn-specconsulsdconfigswithnodemeta) + * [`fn withNodeMetaMixin(nodeMeta)`](#fn-specconsulsdconfigswithnodemetamixin) + * [`fn withPartition(partition)`](#fn-specconsulsdconfigswithpartition) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specconsulsdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specconsulsdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specconsulsdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specconsulsdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specconsulsdconfigswithrefreshinterval) + * [`fn withScheme(scheme)`](#fn-specconsulsdconfigswithscheme) + * [`fn withServer(server)`](#fn-specconsulsdconfigswithserver) + * [`fn withServices(services)`](#fn-specconsulsdconfigswithservices) + * [`fn withServicesMixin(services)`](#fn-specconsulsdconfigswithservicesmixin) + * [`fn withTagSeparator(tagSeparator)`](#fn-specconsulsdconfigswithtagseparator) + * [`fn withTags(tags)`](#fn-specconsulsdconfigswithtags) + * [`fn withTagsMixin(tags)`](#fn-specconsulsdconfigswithtagsmixin) + * [`obj spec.consulSDConfigs.authorization`](#obj-specconsulsdconfigsauthorization) + * [`fn withType(type)`](#fn-specconsulsdconfigsauthorizationwithtype) + * [`obj spec.consulSDConfigs.authorization.credentials`](#obj-specconsulsdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-specconsulsdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsauthorizationcredentialswithoptional) + * [`obj spec.consulSDConfigs.basicAuth`](#obj-specconsulsdconfigsbasicauth) + * [`obj spec.consulSDConfigs.basicAuth.password`](#obj-specconsulsdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-specconsulsdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsbasicauthpasswordwithoptional) + * [`obj spec.consulSDConfigs.basicAuth.username`](#obj-specconsulsdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-specconsulsdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsbasicauthusernamewithoptional) + * [`obj spec.consulSDConfigs.oauth2`](#obj-specconsulsdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specconsulsdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specconsulsdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specconsulsdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specconsulsdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specconsulsdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specconsulsdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specconsulsdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specconsulsdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specconsulsdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specconsulsdconfigsoauth2withtokenurl) + * [`obj spec.consulSDConfigs.oauth2.clientId`](#obj-specconsulsdconfigsoauth2clientid) + * [`obj spec.consulSDConfigs.oauth2.clientId.configMap`](#obj-specconsulsdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specconsulsdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.consulSDConfigs.oauth2.clientId.secret`](#obj-specconsulsdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specconsulsdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.consulSDConfigs.oauth2.clientSecret`](#obj-specconsulsdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-specconsulsdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsoauth2clientsecretwithoptional) + * [`obj spec.consulSDConfigs.oauth2.tlsConfig`](#obj-specconsulsdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specconsulsdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specconsulsdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specconsulsdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specconsulsdconfigsoauth2tlsconfigwithservername) + * [`obj spec.consulSDConfigs.oauth2.tlsConfig.ca`](#obj-specconsulsdconfigsoauth2tlsconfigca) + * [`obj spec.consulSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-specconsulsdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specconsulsdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.consulSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-specconsulsdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specconsulsdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.consulSDConfigs.oauth2.tlsConfig.cert`](#obj-specconsulsdconfigsoauth2tlsconfigcert) + * [`obj spec.consulSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-specconsulsdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specconsulsdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.consulSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-specconsulsdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specconsulsdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.consulSDConfigs.oauth2.tlsConfig.keySecret`](#obj-specconsulsdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specconsulsdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.consulSDConfigs.tlsConfig`](#obj-specconsulsdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specconsulsdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specconsulsdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specconsulsdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specconsulsdconfigstlsconfigwithservername) + * [`obj spec.consulSDConfigs.tlsConfig.ca`](#obj-specconsulsdconfigstlsconfigca) + * [`obj spec.consulSDConfigs.tlsConfig.ca.configMap`](#obj-specconsulsdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specconsulsdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.consulSDConfigs.tlsConfig.ca.secret`](#obj-specconsulsdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specconsulsdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigstlsconfigcasecretwithoptional) + * [`obj spec.consulSDConfigs.tlsConfig.cert`](#obj-specconsulsdconfigstlsconfigcert) + * [`obj spec.consulSDConfigs.tlsConfig.cert.configMap`](#obj-specconsulsdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specconsulsdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.consulSDConfigs.tlsConfig.cert.secret`](#obj-specconsulsdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specconsulsdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.consulSDConfigs.tlsConfig.keySecret`](#obj-specconsulsdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specconsulsdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.consulSDConfigs.tokenRef`](#obj-specconsulsdconfigstokenref) + * [`fn withKey(key)`](#fn-specconsulsdconfigstokenrefwithkey) + * [`fn withName(name)`](#fn-specconsulsdconfigstokenrefwithname) + * [`fn withOptional(optional)`](#fn-specconsulsdconfigstokenrefwithoptional) + * [`obj spec.digitalOceanSDConfigs`](#obj-specdigitaloceansdconfigs) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-specdigitaloceansdconfigswithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-specdigitaloceansdconfigswithfollowredirects) + * [`fn withNoProxy(noProxy)`](#fn-specdigitaloceansdconfigswithnoproxy) + * [`fn withPort(port)`](#fn-specdigitaloceansdconfigswithport) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specdigitaloceansdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specdigitaloceansdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specdigitaloceansdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specdigitaloceansdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specdigitaloceansdconfigswithrefreshinterval) + * [`obj spec.digitalOceanSDConfigs.authorization`](#obj-specdigitaloceansdconfigsauthorization) + * [`fn withType(type)`](#fn-specdigitaloceansdconfigsauthorizationwithtype) + * [`obj spec.digitalOceanSDConfigs.authorization.credentials`](#obj-specdigitaloceansdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigsauthorizationcredentialswithoptional) + * [`obj spec.digitalOceanSDConfigs.oauth2`](#obj-specdigitaloceansdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specdigitaloceansdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specdigitaloceansdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specdigitaloceansdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specdigitaloceansdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specdigitaloceansdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specdigitaloceansdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specdigitaloceansdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specdigitaloceansdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specdigitaloceansdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specdigitaloceansdconfigsoauth2withtokenurl) + * [`obj spec.digitalOceanSDConfigs.oauth2.clientId`](#obj-specdigitaloceansdconfigsoauth2clientid) + * [`obj spec.digitalOceanSDConfigs.oauth2.clientId.configMap`](#obj-specdigitaloceansdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.digitalOceanSDConfigs.oauth2.clientId.secret`](#obj-specdigitaloceansdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.digitalOceanSDConfigs.oauth2.clientSecret`](#obj-specdigitaloceansdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigsoauth2clientsecretwithoptional) + * [`obj spec.digitalOceanSDConfigs.oauth2.tlsConfig`](#obj-specdigitaloceansdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigwithservername) + * [`obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca`](#obj-specdigitaloceansdconfigsoauth2tlsconfigca) + * [`obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-specdigitaloceansdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-specdigitaloceansdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert`](#obj-specdigitaloceansdconfigsoauth2tlsconfigcert) + * [`obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-specdigitaloceansdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-specdigitaloceansdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.keySecret`](#obj-specdigitaloceansdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.digitalOceanSDConfigs.tlsConfig`](#obj-specdigitaloceansdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specdigitaloceansdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specdigitaloceansdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specdigitaloceansdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specdigitaloceansdconfigstlsconfigwithservername) + * [`obj spec.digitalOceanSDConfigs.tlsConfig.ca`](#obj-specdigitaloceansdconfigstlsconfigca) + * [`obj spec.digitalOceanSDConfigs.tlsConfig.ca.configMap`](#obj-specdigitaloceansdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.digitalOceanSDConfigs.tlsConfig.ca.secret`](#obj-specdigitaloceansdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigstlsconfigcasecretwithoptional) + * [`obj spec.digitalOceanSDConfigs.tlsConfig.cert`](#obj-specdigitaloceansdconfigstlsconfigcert) + * [`obj spec.digitalOceanSDConfigs.tlsConfig.cert.configMap`](#obj-specdigitaloceansdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.digitalOceanSDConfigs.tlsConfig.cert.secret`](#obj-specdigitaloceansdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.digitalOceanSDConfigs.tlsConfig.keySecret`](#obj-specdigitaloceansdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specdigitaloceansdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specdigitaloceansdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specdigitaloceansdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.dnsSDConfigs`](#obj-specdnssdconfigs) + * [`fn withNames(names)`](#fn-specdnssdconfigswithnames) + * [`fn withNamesMixin(names)`](#fn-specdnssdconfigswithnamesmixin) + * [`fn withPort(port)`](#fn-specdnssdconfigswithport) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specdnssdconfigswithrefreshinterval) + * [`fn withType(type)`](#fn-specdnssdconfigswithtype) + * [`obj spec.dockerSDConfigs`](#obj-specdockersdconfigs) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-specdockersdconfigswithenablehttp2) + * [`fn withFilters(filters)`](#fn-specdockersdconfigswithfilters) + * [`fn withFiltersMixin(filters)`](#fn-specdockersdconfigswithfiltersmixin) + * [`fn withFollowRedirects(followRedirects)`](#fn-specdockersdconfigswithfollowredirects) + * [`fn withHost(host)`](#fn-specdockersdconfigswithhost) + * [`fn withHostNetworkingHost(hostNetworkingHost)`](#fn-specdockersdconfigswithhostnetworkinghost) + * [`fn withNoProxy(noProxy)`](#fn-specdockersdconfigswithnoproxy) + * [`fn withPort(port)`](#fn-specdockersdconfigswithport) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specdockersdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specdockersdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specdockersdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specdockersdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specdockersdconfigswithrefreshinterval) + * [`obj spec.dockerSDConfigs.authorization`](#obj-specdockersdconfigsauthorization) + * [`fn withType(type)`](#fn-specdockersdconfigsauthorizationwithtype) + * [`obj spec.dockerSDConfigs.authorization.credentials`](#obj-specdockersdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-specdockersdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsauthorizationcredentialswithoptional) + * [`obj spec.dockerSDConfigs.basicAuth`](#obj-specdockersdconfigsbasicauth) + * [`obj spec.dockerSDConfigs.basicAuth.password`](#obj-specdockersdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-specdockersdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsbasicauthpasswordwithoptional) + * [`obj spec.dockerSDConfigs.basicAuth.username`](#obj-specdockersdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-specdockersdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsbasicauthusernamewithoptional) + * [`obj spec.dockerSDConfigs.filters`](#obj-specdockersdconfigsfilters) + * [`fn withName(name)`](#fn-specdockersdconfigsfilterswithname) + * [`fn withValues(values)`](#fn-specdockersdconfigsfilterswithvalues) + * [`fn withValuesMixin(values)`](#fn-specdockersdconfigsfilterswithvaluesmixin) + * [`obj spec.dockerSDConfigs.oauth2`](#obj-specdockersdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specdockersdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specdockersdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specdockersdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specdockersdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specdockersdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specdockersdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specdockersdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specdockersdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specdockersdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specdockersdconfigsoauth2withtokenurl) + * [`obj spec.dockerSDConfigs.oauth2.clientId`](#obj-specdockersdconfigsoauth2clientid) + * [`obj spec.dockerSDConfigs.oauth2.clientId.configMap`](#obj-specdockersdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specdockersdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.dockerSDConfigs.oauth2.clientId.secret`](#obj-specdockersdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specdockersdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.dockerSDConfigs.oauth2.clientSecret`](#obj-specdockersdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-specdockersdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsoauth2clientsecretwithoptional) + * [`obj spec.dockerSDConfigs.oauth2.tlsConfig`](#obj-specdockersdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specdockersdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specdockersdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specdockersdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specdockersdconfigsoauth2tlsconfigwithservername) + * [`obj spec.dockerSDConfigs.oauth2.tlsConfig.ca`](#obj-specdockersdconfigsoauth2tlsconfigca) + * [`obj spec.dockerSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-specdockersdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specdockersdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.dockerSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-specdockersdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specdockersdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.dockerSDConfigs.oauth2.tlsConfig.cert`](#obj-specdockersdconfigsoauth2tlsconfigcert) + * [`obj spec.dockerSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-specdockersdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specdockersdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.dockerSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-specdockersdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specdockersdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.dockerSDConfigs.oauth2.tlsConfig.keySecret`](#obj-specdockersdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specdockersdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.dockerSDConfigs.tlsConfig`](#obj-specdockersdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specdockersdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specdockersdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specdockersdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specdockersdconfigstlsconfigwithservername) + * [`obj spec.dockerSDConfigs.tlsConfig.ca`](#obj-specdockersdconfigstlsconfigca) + * [`obj spec.dockerSDConfigs.tlsConfig.ca.configMap`](#obj-specdockersdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specdockersdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.dockerSDConfigs.tlsConfig.ca.secret`](#obj-specdockersdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specdockersdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigstlsconfigcasecretwithoptional) + * [`obj spec.dockerSDConfigs.tlsConfig.cert`](#obj-specdockersdconfigstlsconfigcert) + * [`obj spec.dockerSDConfigs.tlsConfig.cert.configMap`](#obj-specdockersdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specdockersdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.dockerSDConfigs.tlsConfig.cert.secret`](#obj-specdockersdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specdockersdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.dockerSDConfigs.tlsConfig.keySecret`](#obj-specdockersdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specdockersdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specdockersdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specdockersdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.dockerSwarmSDConfigs`](#obj-specdockerswarmsdconfigs) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-specdockerswarmsdconfigswithenablehttp2) + * [`fn withFilters(filters)`](#fn-specdockerswarmsdconfigswithfilters) + * [`fn withFiltersMixin(filters)`](#fn-specdockerswarmsdconfigswithfiltersmixin) + * [`fn withFollowRedirects(followRedirects)`](#fn-specdockerswarmsdconfigswithfollowredirects) + * [`fn withHost(host)`](#fn-specdockerswarmsdconfigswithhost) + * [`fn withNoProxy(noProxy)`](#fn-specdockerswarmsdconfigswithnoproxy) + * [`fn withPort(port)`](#fn-specdockerswarmsdconfigswithport) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specdockerswarmsdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specdockerswarmsdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specdockerswarmsdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specdockerswarmsdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specdockerswarmsdconfigswithrefreshinterval) + * [`fn withRole(role)`](#fn-specdockerswarmsdconfigswithrole) + * [`obj spec.dockerSwarmSDConfigs.authorization`](#obj-specdockerswarmsdconfigsauthorization) + * [`fn withType(type)`](#fn-specdockerswarmsdconfigsauthorizationwithtype) + * [`obj spec.dockerSwarmSDConfigs.authorization.credentials`](#obj-specdockerswarmsdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsauthorizationcredentialswithoptional) + * [`obj spec.dockerSwarmSDConfigs.basicAuth`](#obj-specdockerswarmsdconfigsbasicauth) + * [`obj spec.dockerSwarmSDConfigs.basicAuth.password`](#obj-specdockerswarmsdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsbasicauthpasswordwithoptional) + * [`obj spec.dockerSwarmSDConfigs.basicAuth.username`](#obj-specdockerswarmsdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsbasicauthusernamewithoptional) + * [`obj spec.dockerSwarmSDConfigs.filters`](#obj-specdockerswarmsdconfigsfilters) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsfilterswithname) + * [`fn withValues(values)`](#fn-specdockerswarmsdconfigsfilterswithvalues) + * [`fn withValuesMixin(values)`](#fn-specdockerswarmsdconfigsfilterswithvaluesmixin) + * [`obj spec.dockerSwarmSDConfigs.oauth2`](#obj-specdockerswarmsdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specdockerswarmsdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specdockerswarmsdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specdockerswarmsdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specdockerswarmsdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specdockerswarmsdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specdockerswarmsdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specdockerswarmsdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specdockerswarmsdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specdockerswarmsdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specdockerswarmsdconfigsoauth2withtokenurl) + * [`obj spec.dockerSwarmSDConfigs.oauth2.clientId`](#obj-specdockerswarmsdconfigsoauth2clientid) + * [`obj spec.dockerSwarmSDConfigs.oauth2.clientId.configMap`](#obj-specdockerswarmsdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.dockerSwarmSDConfigs.oauth2.clientId.secret`](#obj-specdockerswarmsdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.dockerSwarmSDConfigs.oauth2.clientSecret`](#obj-specdockerswarmsdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsoauth2clientsecretwithoptional) + * [`obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig`](#obj-specdockerswarmsdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigwithservername) + * [`obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca`](#obj-specdockerswarmsdconfigsoauth2tlsconfigca) + * [`obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-specdockerswarmsdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-specdockerswarmsdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert`](#obj-specdockerswarmsdconfigsoauth2tlsconfigcert) + * [`obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-specdockerswarmsdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-specdockerswarmsdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.keySecret`](#obj-specdockerswarmsdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.dockerSwarmSDConfigs.tlsConfig`](#obj-specdockerswarmsdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specdockerswarmsdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specdockerswarmsdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specdockerswarmsdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specdockerswarmsdconfigstlsconfigwithservername) + * [`obj spec.dockerSwarmSDConfigs.tlsConfig.ca`](#obj-specdockerswarmsdconfigstlsconfigca) + * [`obj spec.dockerSwarmSDConfigs.tlsConfig.ca.configMap`](#obj-specdockerswarmsdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.dockerSwarmSDConfigs.tlsConfig.ca.secret`](#obj-specdockerswarmsdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigstlsconfigcasecretwithoptional) + * [`obj spec.dockerSwarmSDConfigs.tlsConfig.cert`](#obj-specdockerswarmsdconfigstlsconfigcert) + * [`obj spec.dockerSwarmSDConfigs.tlsConfig.cert.configMap`](#obj-specdockerswarmsdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.dockerSwarmSDConfigs.tlsConfig.cert.secret`](#obj-specdockerswarmsdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.dockerSwarmSDConfigs.tlsConfig.keySecret`](#obj-specdockerswarmsdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specdockerswarmsdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specdockerswarmsdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specdockerswarmsdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.ec2SDConfigs`](#obj-specec2sdconfigs) + * [`fn withFilters(filters)`](#fn-specec2sdconfigswithfilters) + * [`fn withFiltersMixin(filters)`](#fn-specec2sdconfigswithfiltersmixin) + * [`fn withPort(port)`](#fn-specec2sdconfigswithport) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specec2sdconfigswithrefreshinterval) + * [`fn withRegion(region)`](#fn-specec2sdconfigswithregion) + * [`fn withRoleARN(roleARN)`](#fn-specec2sdconfigswithrolearn) + * [`obj spec.ec2SDConfigs.accessKey`](#obj-specec2sdconfigsaccesskey) + * [`fn withKey(key)`](#fn-specec2sdconfigsaccesskeywithkey) + * [`fn withName(name)`](#fn-specec2sdconfigsaccesskeywithname) + * [`fn withOptional(optional)`](#fn-specec2sdconfigsaccesskeywithoptional) + * [`obj spec.ec2SDConfigs.filters`](#obj-specec2sdconfigsfilters) + * [`fn withName(name)`](#fn-specec2sdconfigsfilterswithname) + * [`fn withValues(values)`](#fn-specec2sdconfigsfilterswithvalues) + * [`fn withValuesMixin(values)`](#fn-specec2sdconfigsfilterswithvaluesmixin) + * [`obj spec.ec2SDConfigs.secretKey`](#obj-specec2sdconfigssecretkey) + * [`fn withKey(key)`](#fn-specec2sdconfigssecretkeywithkey) + * [`fn withName(name)`](#fn-specec2sdconfigssecretkeywithname) + * [`fn withOptional(optional)`](#fn-specec2sdconfigssecretkeywithoptional) + * [`obj spec.eurekaSDConfigs`](#obj-speceurekasdconfigs) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-speceurekasdconfigswithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-speceurekasdconfigswithfollowredirects) + * [`fn withNoProxy(noProxy)`](#fn-speceurekasdconfigswithnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speceurekasdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speceurekasdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speceurekasdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speceurekasdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-speceurekasdconfigswithrefreshinterval) + * [`fn withServer(server)`](#fn-speceurekasdconfigswithserver) + * [`obj spec.eurekaSDConfigs.authorization`](#obj-speceurekasdconfigsauthorization) + * [`fn withType(type)`](#fn-speceurekasdconfigsauthorizationwithtype) + * [`obj spec.eurekaSDConfigs.authorization.credentials`](#obj-speceurekasdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-speceurekasdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsauthorizationcredentialswithoptional) + * [`obj spec.eurekaSDConfigs.basicAuth`](#obj-speceurekasdconfigsbasicauth) + * [`obj spec.eurekaSDConfigs.basicAuth.password`](#obj-speceurekasdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-speceurekasdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsbasicauthpasswordwithoptional) + * [`obj spec.eurekaSDConfigs.basicAuth.username`](#obj-speceurekasdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-speceurekasdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsbasicauthusernamewithoptional) + * [`obj spec.eurekaSDConfigs.oauth2`](#obj-speceurekasdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-speceurekasdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-speceurekasdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-speceurekasdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speceurekasdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speceurekasdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speceurekasdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speceurekasdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-speceurekasdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-speceurekasdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-speceurekasdconfigsoauth2withtokenurl) + * [`obj spec.eurekaSDConfigs.oauth2.clientId`](#obj-speceurekasdconfigsoauth2clientid) + * [`obj spec.eurekaSDConfigs.oauth2.clientId.configMap`](#obj-speceurekasdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-speceurekasdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.eurekaSDConfigs.oauth2.clientId.secret`](#obj-speceurekasdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-speceurekasdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.eurekaSDConfigs.oauth2.clientSecret`](#obj-speceurekasdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-speceurekasdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsoauth2clientsecretwithoptional) + * [`obj spec.eurekaSDConfigs.oauth2.tlsConfig`](#obj-speceurekasdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speceurekasdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speceurekasdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speceurekasdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speceurekasdconfigsoauth2tlsconfigwithservername) + * [`obj spec.eurekaSDConfigs.oauth2.tlsConfig.ca`](#obj-speceurekasdconfigsoauth2tlsconfigca) + * [`obj spec.eurekaSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-speceurekasdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speceurekasdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.eurekaSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-speceurekasdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-speceurekasdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.eurekaSDConfigs.oauth2.tlsConfig.cert`](#obj-speceurekasdconfigsoauth2tlsconfigcert) + * [`obj spec.eurekaSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-speceurekasdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speceurekasdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.eurekaSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-speceurekasdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speceurekasdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.eurekaSDConfigs.oauth2.tlsConfig.keySecret`](#obj-speceurekasdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speceurekasdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.eurekaSDConfigs.tlsConfig`](#obj-speceurekasdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speceurekasdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speceurekasdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speceurekasdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speceurekasdconfigstlsconfigwithservername) + * [`obj spec.eurekaSDConfigs.tlsConfig.ca`](#obj-speceurekasdconfigstlsconfigca) + * [`obj spec.eurekaSDConfigs.tlsConfig.ca.configMap`](#obj-speceurekasdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speceurekasdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.eurekaSDConfigs.tlsConfig.ca.secret`](#obj-speceurekasdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-speceurekasdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigstlsconfigcasecretwithoptional) + * [`obj spec.eurekaSDConfigs.tlsConfig.cert`](#obj-speceurekasdconfigstlsconfigcert) + * [`obj spec.eurekaSDConfigs.tlsConfig.cert.configMap`](#obj-speceurekasdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speceurekasdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.eurekaSDConfigs.tlsConfig.cert.secret`](#obj-speceurekasdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speceurekasdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.eurekaSDConfigs.tlsConfig.keySecret`](#obj-speceurekasdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speceurekasdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speceurekasdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speceurekasdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.fileSDConfigs`](#obj-specfilesdconfigs) + * [`fn withFiles(files)`](#fn-specfilesdconfigswithfiles) + * [`fn withFilesMixin(files)`](#fn-specfilesdconfigswithfilesmixin) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specfilesdconfigswithrefreshinterval) + * [`obj spec.gceSDConfigs`](#obj-specgcesdconfigs) + * [`fn withFilter(filter)`](#fn-specgcesdconfigswithfilter) + * [`fn withPort(port)`](#fn-specgcesdconfigswithport) + * [`fn withProject(project)`](#fn-specgcesdconfigswithproject) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specgcesdconfigswithrefreshinterval) + * [`fn withTagSeparator(tagSeparator)`](#fn-specgcesdconfigswithtagseparator) + * [`fn withZone(zone)`](#fn-specgcesdconfigswithzone) + * [`obj spec.hetznerSDConfigs`](#obj-spechetznersdconfigs) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-spechetznersdconfigswithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-spechetznersdconfigswithfollowredirects) + * [`fn withNoProxy(noProxy)`](#fn-spechetznersdconfigswithnoproxy) + * [`fn withPort(port)`](#fn-spechetznersdconfigswithport) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-spechetznersdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-spechetznersdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-spechetznersdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-spechetznersdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-spechetznersdconfigswithrefreshinterval) + * [`fn withRole(role)`](#fn-spechetznersdconfigswithrole) + * [`obj spec.hetznerSDConfigs.authorization`](#obj-spechetznersdconfigsauthorization) + * [`fn withType(type)`](#fn-spechetznersdconfigsauthorizationwithtype) + * [`obj spec.hetznerSDConfigs.authorization.credentials`](#obj-spechetznersdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-spechetznersdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsauthorizationcredentialswithoptional) + * [`obj spec.hetznerSDConfigs.basicAuth`](#obj-spechetznersdconfigsbasicauth) + * [`obj spec.hetznerSDConfigs.basicAuth.password`](#obj-spechetznersdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-spechetznersdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsbasicauthpasswordwithoptional) + * [`obj spec.hetznerSDConfigs.basicAuth.username`](#obj-spechetznersdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-spechetznersdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsbasicauthusernamewithoptional) + * [`obj spec.hetznerSDConfigs.oauth2`](#obj-spechetznersdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-spechetznersdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-spechetznersdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-spechetznersdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-spechetznersdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-spechetznersdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-spechetznersdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-spechetznersdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-spechetznersdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-spechetznersdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-spechetznersdconfigsoauth2withtokenurl) + * [`obj spec.hetznerSDConfigs.oauth2.clientId`](#obj-spechetznersdconfigsoauth2clientid) + * [`obj spec.hetznerSDConfigs.oauth2.clientId.configMap`](#obj-spechetznersdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-spechetznersdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.hetznerSDConfigs.oauth2.clientId.secret`](#obj-spechetznersdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-spechetznersdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.hetznerSDConfigs.oauth2.clientSecret`](#obj-spechetznersdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-spechetznersdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsoauth2clientsecretwithoptional) + * [`obj spec.hetznerSDConfigs.oauth2.tlsConfig`](#obj-spechetznersdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-spechetznersdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-spechetznersdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-spechetznersdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-spechetznersdconfigsoauth2tlsconfigwithservername) + * [`obj spec.hetznerSDConfigs.oauth2.tlsConfig.ca`](#obj-spechetznersdconfigsoauth2tlsconfigca) + * [`obj spec.hetznerSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-spechetznersdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-spechetznersdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.hetznerSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-spechetznersdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-spechetznersdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.hetznerSDConfigs.oauth2.tlsConfig.cert`](#obj-spechetznersdconfigsoauth2tlsconfigcert) + * [`obj spec.hetznerSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-spechetznersdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-spechetznersdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.hetznerSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-spechetznersdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-spechetznersdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.hetznerSDConfigs.oauth2.tlsConfig.keySecret`](#obj-spechetznersdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-spechetznersdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.hetznerSDConfigs.tlsConfig`](#obj-spechetznersdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-spechetznersdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-spechetznersdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-spechetznersdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-spechetznersdconfigstlsconfigwithservername) + * [`obj spec.hetznerSDConfigs.tlsConfig.ca`](#obj-spechetznersdconfigstlsconfigca) + * [`obj spec.hetznerSDConfigs.tlsConfig.ca.configMap`](#obj-spechetznersdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-spechetznersdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.hetznerSDConfigs.tlsConfig.ca.secret`](#obj-spechetznersdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-spechetznersdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigstlsconfigcasecretwithoptional) + * [`obj spec.hetznerSDConfigs.tlsConfig.cert`](#obj-spechetznersdconfigstlsconfigcert) + * [`obj spec.hetznerSDConfigs.tlsConfig.cert.configMap`](#obj-spechetznersdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-spechetznersdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.hetznerSDConfigs.tlsConfig.cert.secret`](#obj-spechetznersdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-spechetznersdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.hetznerSDConfigs.tlsConfig.keySecret`](#obj-spechetznersdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-spechetznersdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-spechetznersdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-spechetznersdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.httpSDConfigs`](#obj-spechttpsdconfigs) + * [`fn withNoProxy(noProxy)`](#fn-spechttpsdconfigswithnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-spechttpsdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-spechttpsdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-spechttpsdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-spechttpsdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-spechttpsdconfigswithrefreshinterval) + * [`fn withUrl(url)`](#fn-spechttpsdconfigswithurl) + * [`obj spec.httpSDConfigs.authorization`](#obj-spechttpsdconfigsauthorization) + * [`fn withType(type)`](#fn-spechttpsdconfigsauthorizationwithtype) + * [`obj spec.httpSDConfigs.authorization.credentials`](#obj-spechttpsdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-spechttpsdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-spechttpsdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-spechttpsdconfigsauthorizationcredentialswithoptional) + * [`obj spec.httpSDConfigs.basicAuth`](#obj-spechttpsdconfigsbasicauth) + * [`obj spec.httpSDConfigs.basicAuth.password`](#obj-spechttpsdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-spechttpsdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-spechttpsdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-spechttpsdconfigsbasicauthpasswordwithoptional) + * [`obj spec.httpSDConfigs.basicAuth.username`](#obj-spechttpsdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-spechttpsdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-spechttpsdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-spechttpsdconfigsbasicauthusernamewithoptional) + * [`obj spec.httpSDConfigs.tlsConfig`](#obj-spechttpsdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-spechttpsdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-spechttpsdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-spechttpsdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-spechttpsdconfigstlsconfigwithservername) + * [`obj spec.httpSDConfigs.tlsConfig.ca`](#obj-spechttpsdconfigstlsconfigca) + * [`obj spec.httpSDConfigs.tlsConfig.ca.configMap`](#obj-spechttpsdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-spechttpsdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-spechttpsdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spechttpsdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.httpSDConfigs.tlsConfig.ca.secret`](#obj-spechttpsdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-spechttpsdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-spechttpsdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-spechttpsdconfigstlsconfigcasecretwithoptional) + * [`obj spec.httpSDConfigs.tlsConfig.cert`](#obj-spechttpsdconfigstlsconfigcert) + * [`obj spec.httpSDConfigs.tlsConfig.cert.configMap`](#obj-spechttpsdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-spechttpsdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-spechttpsdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spechttpsdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.httpSDConfigs.tlsConfig.cert.secret`](#obj-spechttpsdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-spechttpsdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-spechttpsdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-spechttpsdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.httpSDConfigs.tlsConfig.keySecret`](#obj-spechttpsdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-spechttpsdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-spechttpsdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-spechttpsdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.kubernetesSDConfigs`](#obj-speckubernetessdconfigs) + * [`fn withApiServer(apiServer)`](#fn-speckubernetessdconfigswithapiserver) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-speckubernetessdconfigswithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-speckubernetessdconfigswithfollowredirects) + * [`fn withNoProxy(noProxy)`](#fn-speckubernetessdconfigswithnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speckubernetessdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speckubernetessdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speckubernetessdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speckubernetessdconfigswithproxyurl) + * [`fn withRole(role)`](#fn-speckubernetessdconfigswithrole) + * [`fn withSelectors(selectors)`](#fn-speckubernetessdconfigswithselectors) + * [`fn withSelectorsMixin(selectors)`](#fn-speckubernetessdconfigswithselectorsmixin) + * [`obj spec.kubernetesSDConfigs.attachMetadata`](#obj-speckubernetessdconfigsattachmetadata) + * [`fn withNode(node)`](#fn-speckubernetessdconfigsattachmetadatawithnode) + * [`obj spec.kubernetesSDConfigs.authorization`](#obj-speckubernetessdconfigsauthorization) + * [`fn withType(type)`](#fn-speckubernetessdconfigsauthorizationwithtype) + * [`obj spec.kubernetesSDConfigs.authorization.credentials`](#obj-speckubernetessdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsauthorizationcredentialswithoptional) + * [`obj spec.kubernetesSDConfigs.basicAuth`](#obj-speckubernetessdconfigsbasicauth) + * [`obj spec.kubernetesSDConfigs.basicAuth.password`](#obj-speckubernetessdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsbasicauthpasswordwithoptional) + * [`obj spec.kubernetesSDConfigs.basicAuth.username`](#obj-speckubernetessdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsbasicauthusernamewithoptional) + * [`obj spec.kubernetesSDConfigs.namespaces`](#obj-speckubernetessdconfigsnamespaces) + * [`fn withNames(names)`](#fn-speckubernetessdconfigsnamespaceswithnames) + * [`fn withNamesMixin(names)`](#fn-speckubernetessdconfigsnamespaceswithnamesmixin) + * [`fn withOwnNamespace(ownNamespace)`](#fn-speckubernetessdconfigsnamespaceswithownnamespace) + * [`obj spec.kubernetesSDConfigs.oauth2`](#obj-speckubernetessdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-speckubernetessdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-speckubernetessdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-speckubernetessdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speckubernetessdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speckubernetessdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speckubernetessdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speckubernetessdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-speckubernetessdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-speckubernetessdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-speckubernetessdconfigsoauth2withtokenurl) + * [`obj spec.kubernetesSDConfigs.oauth2.clientId`](#obj-speckubernetessdconfigsoauth2clientid) + * [`obj spec.kubernetesSDConfigs.oauth2.clientId.configMap`](#obj-speckubernetessdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.kubernetesSDConfigs.oauth2.clientId.secret`](#obj-speckubernetessdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.kubernetesSDConfigs.oauth2.clientSecret`](#obj-speckubernetessdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsoauth2clientsecretwithoptional) + * [`obj spec.kubernetesSDConfigs.oauth2.tlsConfig`](#obj-speckubernetessdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speckubernetessdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speckubernetessdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speckubernetessdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speckubernetessdconfigsoauth2tlsconfigwithservername) + * [`obj spec.kubernetesSDConfigs.oauth2.tlsConfig.ca`](#obj-speckubernetessdconfigsoauth2tlsconfigca) + * [`obj spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-speckubernetessdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-speckubernetessdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.kubernetesSDConfigs.oauth2.tlsConfig.cert`](#obj-speckubernetessdconfigsoauth2tlsconfigcert) + * [`obj spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-speckubernetessdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-speckubernetessdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.kubernetesSDConfigs.oauth2.tlsConfig.keySecret`](#obj-speckubernetessdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speckubernetessdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.kubernetesSDConfigs.selectors`](#obj-speckubernetessdconfigsselectors) + * [`fn withField(field)`](#fn-speckubernetessdconfigsselectorswithfield) + * [`fn withLabel(label)`](#fn-speckubernetessdconfigsselectorswithlabel) + * [`fn withRole(role)`](#fn-speckubernetessdconfigsselectorswithrole) + * [`obj spec.kubernetesSDConfigs.tlsConfig`](#obj-speckubernetessdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speckubernetessdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speckubernetessdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speckubernetessdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speckubernetessdconfigstlsconfigwithservername) + * [`obj spec.kubernetesSDConfigs.tlsConfig.ca`](#obj-speckubernetessdconfigstlsconfigca) + * [`obj spec.kubernetesSDConfigs.tlsConfig.ca.configMap`](#obj-speckubernetessdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speckubernetessdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.kubernetesSDConfigs.tlsConfig.ca.secret`](#obj-speckubernetessdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-speckubernetessdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigstlsconfigcasecretwithoptional) + * [`obj spec.kubernetesSDConfigs.tlsConfig.cert`](#obj-speckubernetessdconfigstlsconfigcert) + * [`obj spec.kubernetesSDConfigs.tlsConfig.cert.configMap`](#obj-speckubernetessdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speckubernetessdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.kubernetesSDConfigs.tlsConfig.cert.secret`](#obj-speckubernetessdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speckubernetessdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.kubernetesSDConfigs.tlsConfig.keySecret`](#obj-speckubernetessdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speckubernetessdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speckubernetessdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speckubernetessdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.kumaSDConfigs`](#obj-speckumasdconfigs) + * [`fn withClientID(clientID)`](#fn-speckumasdconfigswithclientid) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-speckumasdconfigswithenablehttp2) + * [`fn withFetchTimeout(fetchTimeout)`](#fn-speckumasdconfigswithfetchtimeout) + * [`fn withFollowRedirects(followRedirects)`](#fn-speckumasdconfigswithfollowredirects) + * [`fn withNoProxy(noProxy)`](#fn-speckumasdconfigswithnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speckumasdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speckumasdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speckumasdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speckumasdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-speckumasdconfigswithrefreshinterval) + * [`fn withServer(server)`](#fn-speckumasdconfigswithserver) + * [`obj spec.kumaSDConfigs.authorization`](#obj-speckumasdconfigsauthorization) + * [`fn withType(type)`](#fn-speckumasdconfigsauthorizationwithtype) + * [`obj spec.kumaSDConfigs.authorization.credentials`](#obj-speckumasdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-speckumasdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsauthorizationcredentialswithoptional) + * [`obj spec.kumaSDConfigs.basicAuth`](#obj-speckumasdconfigsbasicauth) + * [`obj spec.kumaSDConfigs.basicAuth.password`](#obj-speckumasdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-speckumasdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsbasicauthpasswordwithoptional) + * [`obj spec.kumaSDConfigs.basicAuth.username`](#obj-speckumasdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-speckumasdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsbasicauthusernamewithoptional) + * [`obj spec.kumaSDConfigs.oauth2`](#obj-speckumasdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-speckumasdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-speckumasdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-speckumasdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speckumasdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speckumasdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speckumasdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speckumasdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-speckumasdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-speckumasdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-speckumasdconfigsoauth2withtokenurl) + * [`obj spec.kumaSDConfigs.oauth2.clientId`](#obj-speckumasdconfigsoauth2clientid) + * [`obj spec.kumaSDConfigs.oauth2.clientId.configMap`](#obj-speckumasdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-speckumasdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.kumaSDConfigs.oauth2.clientId.secret`](#obj-speckumasdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-speckumasdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.kumaSDConfigs.oauth2.clientSecret`](#obj-speckumasdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-speckumasdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsoauth2clientsecretwithoptional) + * [`obj spec.kumaSDConfigs.oauth2.tlsConfig`](#obj-speckumasdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speckumasdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speckumasdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speckumasdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speckumasdconfigsoauth2tlsconfigwithservername) + * [`obj spec.kumaSDConfigs.oauth2.tlsConfig.ca`](#obj-speckumasdconfigsoauth2tlsconfigca) + * [`obj spec.kumaSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-speckumasdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speckumasdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.kumaSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-speckumasdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-speckumasdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.kumaSDConfigs.oauth2.tlsConfig.cert`](#obj-speckumasdconfigsoauth2tlsconfigcert) + * [`obj spec.kumaSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-speckumasdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speckumasdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.kumaSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-speckumasdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speckumasdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.kumaSDConfigs.oauth2.tlsConfig.keySecret`](#obj-speckumasdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speckumasdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.kumaSDConfigs.tlsConfig`](#obj-speckumasdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speckumasdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speckumasdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speckumasdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speckumasdconfigstlsconfigwithservername) + * [`obj spec.kumaSDConfigs.tlsConfig.ca`](#obj-speckumasdconfigstlsconfigca) + * [`obj spec.kumaSDConfigs.tlsConfig.ca.configMap`](#obj-speckumasdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speckumasdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.kumaSDConfigs.tlsConfig.ca.secret`](#obj-speckumasdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-speckumasdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigstlsconfigcasecretwithoptional) + * [`obj spec.kumaSDConfigs.tlsConfig.cert`](#obj-speckumasdconfigstlsconfigcert) + * [`obj spec.kumaSDConfigs.tlsConfig.cert.configMap`](#obj-speckumasdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speckumasdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.kumaSDConfigs.tlsConfig.cert.secret`](#obj-speckumasdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speckumasdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.kumaSDConfigs.tlsConfig.keySecret`](#obj-speckumasdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speckumasdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speckumasdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speckumasdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.lightSailSDConfigs`](#obj-speclightsailsdconfigs) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-speclightsailsdconfigswithenablehttp2) + * [`fn withEndpoint(endpoint)`](#fn-speclightsailsdconfigswithendpoint) + * [`fn withFollowRedirects(followRedirects)`](#fn-speclightsailsdconfigswithfollowredirects) + * [`fn withNoProxy(noProxy)`](#fn-speclightsailsdconfigswithnoproxy) + * [`fn withPort(port)`](#fn-speclightsailsdconfigswithport) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speclightsailsdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speclightsailsdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speclightsailsdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speclightsailsdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-speclightsailsdconfigswithrefreshinterval) + * [`fn withRegion(region)`](#fn-speclightsailsdconfigswithregion) + * [`fn withRoleARN(roleARN)`](#fn-speclightsailsdconfigswithrolearn) + * [`obj spec.lightSailSDConfigs.accessKey`](#obj-speclightsailsdconfigsaccesskey) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsaccesskeywithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsaccesskeywithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsaccesskeywithoptional) + * [`obj spec.lightSailSDConfigs.authorization`](#obj-speclightsailsdconfigsauthorization) + * [`fn withType(type)`](#fn-speclightsailsdconfigsauthorizationwithtype) + * [`obj spec.lightSailSDConfigs.authorization.credentials`](#obj-speclightsailsdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsauthorizationcredentialswithoptional) + * [`obj spec.lightSailSDConfigs.basicAuth`](#obj-speclightsailsdconfigsbasicauth) + * [`obj spec.lightSailSDConfigs.basicAuth.password`](#obj-speclightsailsdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsbasicauthpasswordwithoptional) + * [`obj spec.lightSailSDConfigs.basicAuth.username`](#obj-speclightsailsdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsbasicauthusernamewithoptional) + * [`obj spec.lightSailSDConfigs.oauth2`](#obj-speclightsailsdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-speclightsailsdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-speclightsailsdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-speclightsailsdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speclightsailsdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speclightsailsdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speclightsailsdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speclightsailsdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-speclightsailsdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-speclightsailsdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-speclightsailsdconfigsoauth2withtokenurl) + * [`obj spec.lightSailSDConfigs.oauth2.clientId`](#obj-speclightsailsdconfigsoauth2clientid) + * [`obj spec.lightSailSDConfigs.oauth2.clientId.configMap`](#obj-speclightsailsdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.lightSailSDConfigs.oauth2.clientId.secret`](#obj-speclightsailsdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.lightSailSDConfigs.oauth2.clientSecret`](#obj-speclightsailsdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsoauth2clientsecretwithoptional) + * [`obj spec.lightSailSDConfigs.oauth2.tlsConfig`](#obj-speclightsailsdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speclightsailsdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speclightsailsdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speclightsailsdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speclightsailsdconfigsoauth2tlsconfigwithservername) + * [`obj spec.lightSailSDConfigs.oauth2.tlsConfig.ca`](#obj-speclightsailsdconfigsoauth2tlsconfigca) + * [`obj spec.lightSailSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-speclightsailsdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.lightSailSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-speclightsailsdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.lightSailSDConfigs.oauth2.tlsConfig.cert`](#obj-speclightsailsdconfigsoauth2tlsconfigcert) + * [`obj spec.lightSailSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-speclightsailsdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.lightSailSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-speclightsailsdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.lightSailSDConfigs.oauth2.tlsConfig.keySecret`](#obj-speclightsailsdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speclightsailsdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.lightSailSDConfigs.secretKey`](#obj-speclightsailsdconfigssecretkey) + * [`fn withKey(key)`](#fn-speclightsailsdconfigssecretkeywithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigssecretkeywithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigssecretkeywithoptional) + * [`obj spec.lightSailSDConfigs.tlsConfig`](#obj-speclightsailsdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speclightsailsdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speclightsailsdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speclightsailsdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speclightsailsdconfigstlsconfigwithservername) + * [`obj spec.lightSailSDConfigs.tlsConfig.ca`](#obj-speclightsailsdconfigstlsconfigca) + * [`obj spec.lightSailSDConfigs.tlsConfig.ca.configMap`](#obj-speclightsailsdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speclightsailsdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.lightSailSDConfigs.tlsConfig.ca.secret`](#obj-speclightsailsdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-speclightsailsdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigstlsconfigcasecretwithoptional) + * [`obj spec.lightSailSDConfigs.tlsConfig.cert`](#obj-speclightsailsdconfigstlsconfigcert) + * [`obj spec.lightSailSDConfigs.tlsConfig.cert.configMap`](#obj-speclightsailsdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speclightsailsdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.lightSailSDConfigs.tlsConfig.cert.secret`](#obj-speclightsailsdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speclightsailsdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.lightSailSDConfigs.tlsConfig.keySecret`](#obj-speclightsailsdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speclightsailsdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speclightsailsdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speclightsailsdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.linodeSDConfigs`](#obj-speclinodesdconfigs) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-speclinodesdconfigswithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-speclinodesdconfigswithfollowredirects) + * [`fn withNoProxy(noProxy)`](#fn-speclinodesdconfigswithnoproxy) + * [`fn withPort(port)`](#fn-speclinodesdconfigswithport) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speclinodesdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speclinodesdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speclinodesdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speclinodesdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-speclinodesdconfigswithrefreshinterval) + * [`fn withRegion(region)`](#fn-speclinodesdconfigswithregion) + * [`fn withTagSeparator(tagSeparator)`](#fn-speclinodesdconfigswithtagseparator) + * [`obj spec.linodeSDConfigs.authorization`](#obj-speclinodesdconfigsauthorization) + * [`fn withType(type)`](#fn-speclinodesdconfigsauthorizationwithtype) + * [`obj spec.linodeSDConfigs.authorization.credentials`](#obj-speclinodesdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-speclinodesdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigsauthorizationcredentialswithoptional) + * [`obj spec.linodeSDConfigs.oauth2`](#obj-speclinodesdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-speclinodesdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-speclinodesdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-speclinodesdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-speclinodesdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-speclinodesdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-speclinodesdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-speclinodesdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-speclinodesdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-speclinodesdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-speclinodesdconfigsoauth2withtokenurl) + * [`obj spec.linodeSDConfigs.oauth2.clientId`](#obj-speclinodesdconfigsoauth2clientid) + * [`obj spec.linodeSDConfigs.oauth2.clientId.configMap`](#obj-speclinodesdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-speclinodesdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.linodeSDConfigs.oauth2.clientId.secret`](#obj-speclinodesdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-speclinodesdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.linodeSDConfigs.oauth2.clientSecret`](#obj-speclinodesdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-speclinodesdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigsoauth2clientsecretwithoptional) + * [`obj spec.linodeSDConfigs.oauth2.tlsConfig`](#obj-speclinodesdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speclinodesdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speclinodesdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speclinodesdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speclinodesdconfigsoauth2tlsconfigwithservername) + * [`obj spec.linodeSDConfigs.oauth2.tlsConfig.ca`](#obj-speclinodesdconfigsoauth2tlsconfigca) + * [`obj spec.linodeSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-speclinodesdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speclinodesdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.linodeSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-speclinodesdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-speclinodesdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.linodeSDConfigs.oauth2.tlsConfig.cert`](#obj-speclinodesdconfigsoauth2tlsconfigcert) + * [`obj spec.linodeSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-speclinodesdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speclinodesdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.linodeSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-speclinodesdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speclinodesdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.linodeSDConfigs.oauth2.tlsConfig.keySecret`](#obj-speclinodesdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speclinodesdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.linodeSDConfigs.tlsConfig`](#obj-speclinodesdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-speclinodesdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-speclinodesdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-speclinodesdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-speclinodesdconfigstlsconfigwithservername) + * [`obj spec.linodeSDConfigs.tlsConfig.ca`](#obj-speclinodesdconfigstlsconfigca) + * [`obj spec.linodeSDConfigs.tlsConfig.ca.configMap`](#obj-speclinodesdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-speclinodesdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.linodeSDConfigs.tlsConfig.ca.secret`](#obj-speclinodesdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-speclinodesdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigstlsconfigcasecretwithoptional) + * [`obj spec.linodeSDConfigs.tlsConfig.cert`](#obj-speclinodesdconfigstlsconfigcert) + * [`obj spec.linodeSDConfigs.tlsConfig.cert.configMap`](#obj-speclinodesdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-speclinodesdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.linodeSDConfigs.tlsConfig.cert.secret`](#obj-speclinodesdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-speclinodesdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.linodeSDConfigs.tlsConfig.keySecret`](#obj-speclinodesdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-speclinodesdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-speclinodesdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-speclinodesdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.metricRelabelings`](#obj-specmetricrelabelings) + * [`fn withAction(action)`](#fn-specmetricrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specmetricrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specmetricrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specmetricrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specmetricrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specmetricrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specmetricrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specmetricrelabelingswithtargetlabel) + * [`obj spec.nomadSDConfigs`](#obj-specnomadsdconfigs) + * [`fn withAllowStale(allowStale)`](#fn-specnomadsdconfigswithallowstale) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-specnomadsdconfigswithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-specnomadsdconfigswithfollowredirects) + * [`fn withNamespace(namespace)`](#fn-specnomadsdconfigswithnamespace) + * [`fn withNoProxy(noProxy)`](#fn-specnomadsdconfigswithnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specnomadsdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specnomadsdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specnomadsdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specnomadsdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specnomadsdconfigswithrefreshinterval) + * [`fn withRegion(region)`](#fn-specnomadsdconfigswithregion) + * [`fn withServer(server)`](#fn-specnomadsdconfigswithserver) + * [`fn withTagSeparator(tagSeparator)`](#fn-specnomadsdconfigswithtagseparator) + * [`obj spec.nomadSDConfigs.authorization`](#obj-specnomadsdconfigsauthorization) + * [`fn withType(type)`](#fn-specnomadsdconfigsauthorizationwithtype) + * [`obj spec.nomadSDConfigs.authorization.credentials`](#obj-specnomadsdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-specnomadsdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsauthorizationcredentialswithoptional) + * [`obj spec.nomadSDConfigs.basicAuth`](#obj-specnomadsdconfigsbasicauth) + * [`obj spec.nomadSDConfigs.basicAuth.password`](#obj-specnomadsdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-specnomadsdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsbasicauthpasswordwithoptional) + * [`obj spec.nomadSDConfigs.basicAuth.username`](#obj-specnomadsdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-specnomadsdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsbasicauthusernamewithoptional) + * [`obj spec.nomadSDConfigs.oauth2`](#obj-specnomadsdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specnomadsdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specnomadsdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specnomadsdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specnomadsdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specnomadsdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specnomadsdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specnomadsdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specnomadsdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specnomadsdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specnomadsdconfigsoauth2withtokenurl) + * [`obj spec.nomadSDConfigs.oauth2.clientId`](#obj-specnomadsdconfigsoauth2clientid) + * [`obj spec.nomadSDConfigs.oauth2.clientId.configMap`](#obj-specnomadsdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specnomadsdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.nomadSDConfigs.oauth2.clientId.secret`](#obj-specnomadsdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specnomadsdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.nomadSDConfigs.oauth2.clientSecret`](#obj-specnomadsdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-specnomadsdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsoauth2clientsecretwithoptional) + * [`obj spec.nomadSDConfigs.oauth2.tlsConfig`](#obj-specnomadsdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specnomadsdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specnomadsdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specnomadsdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specnomadsdconfigsoauth2tlsconfigwithservername) + * [`obj spec.nomadSDConfigs.oauth2.tlsConfig.ca`](#obj-specnomadsdconfigsoauth2tlsconfigca) + * [`obj spec.nomadSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-specnomadsdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specnomadsdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.nomadSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-specnomadsdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specnomadsdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.nomadSDConfigs.oauth2.tlsConfig.cert`](#obj-specnomadsdconfigsoauth2tlsconfigcert) + * [`obj spec.nomadSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-specnomadsdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specnomadsdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.nomadSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-specnomadsdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specnomadsdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.nomadSDConfigs.oauth2.tlsConfig.keySecret`](#obj-specnomadsdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specnomadsdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.nomadSDConfigs.tlsConfig`](#obj-specnomadsdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specnomadsdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specnomadsdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specnomadsdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specnomadsdconfigstlsconfigwithservername) + * [`obj spec.nomadSDConfigs.tlsConfig.ca`](#obj-specnomadsdconfigstlsconfigca) + * [`obj spec.nomadSDConfigs.tlsConfig.ca.configMap`](#obj-specnomadsdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specnomadsdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.nomadSDConfigs.tlsConfig.ca.secret`](#obj-specnomadsdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specnomadsdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigstlsconfigcasecretwithoptional) + * [`obj spec.nomadSDConfigs.tlsConfig.cert`](#obj-specnomadsdconfigstlsconfigcert) + * [`obj spec.nomadSDConfigs.tlsConfig.cert.configMap`](#obj-specnomadsdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specnomadsdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.nomadSDConfigs.tlsConfig.cert.secret`](#obj-specnomadsdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specnomadsdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.nomadSDConfigs.tlsConfig.keySecret`](#obj-specnomadsdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specnomadsdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specnomadsdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specnomadsdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.oauth2`](#obj-specoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specoauth2withtokenurl) + * [`obj spec.oauth2.clientId`](#obj-specoauth2clientid) + * [`obj spec.oauth2.clientId.configMap`](#obj-specoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specoauth2clientidconfigmapwithoptional) + * [`obj spec.oauth2.clientId.secret`](#obj-specoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2clientidsecretwithoptional) + * [`obj spec.oauth2.clientSecret`](#obj-specoauth2clientsecret) + * [`fn withKey(key)`](#fn-specoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2clientsecretwithoptional) + * [`obj spec.oauth2.tlsConfig`](#obj-specoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specoauth2tlsconfigwithservername) + * [`obj spec.oauth2.tlsConfig.ca`](#obj-specoauth2tlsconfigca) + * [`obj spec.oauth2.tlsConfig.ca.configMap`](#obj-specoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.oauth2.tlsConfig.ca.secret`](#obj-specoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigcasecretwithoptional) + * [`obj spec.oauth2.tlsConfig.cert`](#obj-specoauth2tlsconfigcert) + * [`obj spec.oauth2.tlsConfig.cert.configMap`](#obj-specoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.oauth2.tlsConfig.cert.secret`](#obj-specoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.oauth2.tlsConfig.keySecret`](#obj-specoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.openstackSDConfigs`](#obj-specopenstacksdconfigs) + * [`fn withAllTenants(allTenants)`](#fn-specopenstacksdconfigswithalltenants) + * [`fn withApplicationCredentialId(applicationCredentialId)`](#fn-specopenstacksdconfigswithapplicationcredentialid) + * [`fn withApplicationCredentialName(applicationCredentialName)`](#fn-specopenstacksdconfigswithapplicationcredentialname) + * [`fn withAvailability(availability)`](#fn-specopenstacksdconfigswithavailability) + * [`fn withDomainID(domainID)`](#fn-specopenstacksdconfigswithdomainid) + * [`fn withDomainName(domainName)`](#fn-specopenstacksdconfigswithdomainname) + * [`fn withIdentityEndpoint(identityEndpoint)`](#fn-specopenstacksdconfigswithidentityendpoint) + * [`fn withPort(port)`](#fn-specopenstacksdconfigswithport) + * [`fn withProjectID(projectID)`](#fn-specopenstacksdconfigswithprojectid) + * [`fn withProjectName(projectName)`](#fn-specopenstacksdconfigswithprojectname) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specopenstacksdconfigswithrefreshinterval) + * [`fn withRegion(region)`](#fn-specopenstacksdconfigswithregion) + * [`fn withRole(role)`](#fn-specopenstacksdconfigswithrole) + * [`fn withUserid(userid)`](#fn-specopenstacksdconfigswithuserid) + * [`fn withUsername(username)`](#fn-specopenstacksdconfigswithusername) + * [`obj spec.openstackSDConfigs.applicationCredentialSecret`](#obj-specopenstacksdconfigsapplicationcredentialsecret) + * [`fn withKey(key)`](#fn-specopenstacksdconfigsapplicationcredentialsecretwithkey) + * [`fn withName(name)`](#fn-specopenstacksdconfigsapplicationcredentialsecretwithname) + * [`fn withOptional(optional)`](#fn-specopenstacksdconfigsapplicationcredentialsecretwithoptional) + * [`obj spec.openstackSDConfigs.password`](#obj-specopenstacksdconfigspassword) + * [`fn withKey(key)`](#fn-specopenstacksdconfigspasswordwithkey) + * [`fn withName(name)`](#fn-specopenstacksdconfigspasswordwithname) + * [`fn withOptional(optional)`](#fn-specopenstacksdconfigspasswordwithoptional) + * [`obj spec.openstackSDConfigs.tlsConfig`](#obj-specopenstacksdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specopenstacksdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specopenstacksdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specopenstacksdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specopenstacksdconfigstlsconfigwithservername) + * [`obj spec.openstackSDConfigs.tlsConfig.ca`](#obj-specopenstacksdconfigstlsconfigca) + * [`obj spec.openstackSDConfigs.tlsConfig.ca.configMap`](#obj-specopenstacksdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specopenstacksdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specopenstacksdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specopenstacksdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.openstackSDConfigs.tlsConfig.ca.secret`](#obj-specopenstacksdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specopenstacksdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specopenstacksdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specopenstacksdconfigstlsconfigcasecretwithoptional) + * [`obj spec.openstackSDConfigs.tlsConfig.cert`](#obj-specopenstacksdconfigstlsconfigcert) + * [`obj spec.openstackSDConfigs.tlsConfig.cert.configMap`](#obj-specopenstacksdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specopenstacksdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specopenstacksdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specopenstacksdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.openstackSDConfigs.tlsConfig.cert.secret`](#obj-specopenstacksdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specopenstacksdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specopenstacksdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specopenstacksdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.openstackSDConfigs.tlsConfig.keySecret`](#obj-specopenstacksdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specopenstacksdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specopenstacksdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specopenstacksdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.ovhcloudSDConfigs`](#obj-specovhcloudsdconfigs) + * [`fn withApplicationKey(applicationKey)`](#fn-specovhcloudsdconfigswithapplicationkey) + * [`fn withEndpoint(endpoint)`](#fn-specovhcloudsdconfigswithendpoint) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specovhcloudsdconfigswithrefreshinterval) + * [`fn withService(service)`](#fn-specovhcloudsdconfigswithservice) + * [`obj spec.ovhcloudSDConfigs.applicationSecret`](#obj-specovhcloudsdconfigsapplicationsecret) + * [`fn withKey(key)`](#fn-specovhcloudsdconfigsapplicationsecretwithkey) + * [`fn withName(name)`](#fn-specovhcloudsdconfigsapplicationsecretwithname) + * [`fn withOptional(optional)`](#fn-specovhcloudsdconfigsapplicationsecretwithoptional) + * [`obj spec.ovhcloudSDConfigs.consumerKey`](#obj-specovhcloudsdconfigsconsumerkey) + * [`fn withKey(key)`](#fn-specovhcloudsdconfigsconsumerkeywithkey) + * [`fn withName(name)`](#fn-specovhcloudsdconfigsconsumerkeywithname) + * [`fn withOptional(optional)`](#fn-specovhcloudsdconfigsconsumerkeywithoptional) + * [`obj spec.puppetDBSDConfigs`](#obj-specpuppetdbsdconfigs) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-specpuppetdbsdconfigswithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-specpuppetdbsdconfigswithfollowredirects) + * [`fn withIncludeParameters(includeParameters)`](#fn-specpuppetdbsdconfigswithincludeparameters) + * [`fn withNoProxy(noProxy)`](#fn-specpuppetdbsdconfigswithnoproxy) + * [`fn withPort(port)`](#fn-specpuppetdbsdconfigswithport) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specpuppetdbsdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specpuppetdbsdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specpuppetdbsdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specpuppetdbsdconfigswithproxyurl) + * [`fn withQuery(query)`](#fn-specpuppetdbsdconfigswithquery) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specpuppetdbsdconfigswithrefreshinterval) + * [`fn withUrl(url)`](#fn-specpuppetdbsdconfigswithurl) + * [`obj spec.puppetDBSDConfigs.authorization`](#obj-specpuppetdbsdconfigsauthorization) + * [`fn withType(type)`](#fn-specpuppetdbsdconfigsauthorizationwithtype) + * [`obj spec.puppetDBSDConfigs.authorization.credentials`](#obj-specpuppetdbsdconfigsauthorizationcredentials) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsauthorizationcredentialswithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsauthorizationcredentialswithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsauthorizationcredentialswithoptional) + * [`obj spec.puppetDBSDConfigs.basicAuth`](#obj-specpuppetdbsdconfigsbasicauth) + * [`obj spec.puppetDBSDConfigs.basicAuth.password`](#obj-specpuppetdbsdconfigsbasicauthpassword) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsbasicauthpasswordwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsbasicauthpasswordwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsbasicauthpasswordwithoptional) + * [`obj spec.puppetDBSDConfigs.basicAuth.username`](#obj-specpuppetdbsdconfigsbasicauthusername) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsbasicauthusernamewithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsbasicauthusernamewithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsbasicauthusernamewithoptional) + * [`obj spec.puppetDBSDConfigs.oauth2`](#obj-specpuppetdbsdconfigsoauth2) + * [`fn withEndpointParams(endpointParams)`](#fn-specpuppetdbsdconfigsoauth2withendpointparams) + * [`fn withEndpointParamsMixin(endpointParams)`](#fn-specpuppetdbsdconfigsoauth2withendpointparamsmixin) + * [`fn withNoProxy(noProxy)`](#fn-specpuppetdbsdconfigsoauth2withnoproxy) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specpuppetdbsdconfigsoauth2withproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specpuppetdbsdconfigsoauth2withproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specpuppetdbsdconfigsoauth2withproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specpuppetdbsdconfigsoauth2withproxyurl) + * [`fn withScopes(scopes)`](#fn-specpuppetdbsdconfigsoauth2withscopes) + * [`fn withScopesMixin(scopes)`](#fn-specpuppetdbsdconfigsoauth2withscopesmixin) + * [`fn withTokenUrl(tokenUrl)`](#fn-specpuppetdbsdconfigsoauth2withtokenurl) + * [`obj spec.puppetDBSDConfigs.oauth2.clientId`](#obj-specpuppetdbsdconfigsoauth2clientid) + * [`obj spec.puppetDBSDConfigs.oauth2.clientId.configMap`](#obj-specpuppetdbsdconfigsoauth2clientidconfigmap) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsoauth2clientidconfigmapwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsoauth2clientidconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsoauth2clientidconfigmapwithoptional) + * [`obj spec.puppetDBSDConfigs.oauth2.clientId.secret`](#obj-specpuppetdbsdconfigsoauth2clientidsecret) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsoauth2clientidsecretwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsoauth2clientidsecretwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsoauth2clientidsecretwithoptional) + * [`obj spec.puppetDBSDConfigs.oauth2.clientSecret`](#obj-specpuppetdbsdconfigsoauth2clientsecret) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsoauth2clientsecretwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsoauth2clientsecretwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsoauth2clientsecretwithoptional) + * [`obj spec.puppetDBSDConfigs.oauth2.tlsConfig`](#obj-specpuppetdbsdconfigsoauth2tlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigwithservername) + * [`obj spec.puppetDBSDConfigs.oauth2.tlsConfig.ca`](#obj-specpuppetdbsdconfigsoauth2tlsconfigca) + * [`obj spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.configMap`](#obj-specpuppetdbsdconfigsoauth2tlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcaconfigmapwithoptional) + * [`obj spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.secret`](#obj-specpuppetdbsdconfigsoauth2tlsconfigcasecret) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcasecretwithoptional) + * [`obj spec.puppetDBSDConfigs.oauth2.tlsConfig.cert`](#obj-specpuppetdbsdconfigsoauth2tlsconfigcert) + * [`obj spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.configMap`](#obj-specpuppetdbsdconfigsoauth2tlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcertconfigmapwithoptional) + * [`obj spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.secret`](#obj-specpuppetdbsdconfigsoauth2tlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigcertsecretwithoptional) + * [`obj spec.puppetDBSDConfigs.oauth2.tlsConfig.keySecret`](#obj-specpuppetdbsdconfigsoauth2tlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigsoauth2tlsconfigkeysecretwithoptional) + * [`obj spec.puppetDBSDConfigs.tlsConfig`](#obj-specpuppetdbsdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specpuppetdbsdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specpuppetdbsdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specpuppetdbsdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specpuppetdbsdconfigstlsconfigwithservername) + * [`obj spec.puppetDBSDConfigs.tlsConfig.ca`](#obj-specpuppetdbsdconfigstlsconfigca) + * [`obj spec.puppetDBSDConfigs.tlsConfig.ca.configMap`](#obj-specpuppetdbsdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.puppetDBSDConfigs.tlsConfig.ca.secret`](#obj-specpuppetdbsdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigstlsconfigcasecretwithoptional) + * [`obj spec.puppetDBSDConfigs.tlsConfig.cert`](#obj-specpuppetdbsdconfigstlsconfigcert) + * [`obj spec.puppetDBSDConfigs.tlsConfig.cert.configMap`](#obj-specpuppetdbsdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.puppetDBSDConfigs.tlsConfig.cert.secret`](#obj-specpuppetdbsdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.puppetDBSDConfigs.tlsConfig.keySecret`](#obj-specpuppetdbsdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specpuppetdbsdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specpuppetdbsdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specpuppetdbsdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.relabelings`](#obj-specrelabelings) + * [`fn withAction(action)`](#fn-specrelabelingswithaction) + * [`fn withModulus(modulus)`](#fn-specrelabelingswithmodulus) + * [`fn withRegex(regex)`](#fn-specrelabelingswithregex) + * [`fn withReplacement(replacement)`](#fn-specrelabelingswithreplacement) + * [`fn withSeparator(separator)`](#fn-specrelabelingswithseparator) + * [`fn withSourceLabels(sourceLabels)`](#fn-specrelabelingswithsourcelabels) + * [`fn withSourceLabelsMixin(sourceLabels)`](#fn-specrelabelingswithsourcelabelsmixin) + * [`fn withTargetLabel(targetLabel)`](#fn-specrelabelingswithtargetlabel) + * [`obj spec.scalewaySDConfigs`](#obj-specscalewaysdconfigs) + * [`fn withAccessKey(accessKey)`](#fn-specscalewaysdconfigswithaccesskey) + * [`fn withApiURL(apiURL)`](#fn-specscalewaysdconfigswithapiurl) + * [`fn withEnableHTTP2(enableHTTP2)`](#fn-specscalewaysdconfigswithenablehttp2) + * [`fn withFollowRedirects(followRedirects)`](#fn-specscalewaysdconfigswithfollowredirects) + * [`fn withNameFilter(nameFilter)`](#fn-specscalewaysdconfigswithnamefilter) + * [`fn withNoProxy(noProxy)`](#fn-specscalewaysdconfigswithnoproxy) + * [`fn withPort(port)`](#fn-specscalewaysdconfigswithport) + * [`fn withProjectID(projectID)`](#fn-specscalewaysdconfigswithprojectid) + * [`fn withProxyConnectHeader(proxyConnectHeader)`](#fn-specscalewaysdconfigswithproxyconnectheader) + * [`fn withProxyConnectHeaderMixin(proxyConnectHeader)`](#fn-specscalewaysdconfigswithproxyconnectheadermixin) + * [`fn withProxyFromEnvironment(proxyFromEnvironment)`](#fn-specscalewaysdconfigswithproxyfromenvironment) + * [`fn withProxyUrl(proxyUrl)`](#fn-specscalewaysdconfigswithproxyurl) + * [`fn withRefreshInterval(refreshInterval)`](#fn-specscalewaysdconfigswithrefreshinterval) + * [`fn withRole(role)`](#fn-specscalewaysdconfigswithrole) + * [`fn withTagsFilter(tagsFilter)`](#fn-specscalewaysdconfigswithtagsfilter) + * [`fn withTagsFilterMixin(tagsFilter)`](#fn-specscalewaysdconfigswithtagsfiltermixin) + * [`fn withZone(zone)`](#fn-specscalewaysdconfigswithzone) + * [`obj spec.scalewaySDConfigs.secretKey`](#obj-specscalewaysdconfigssecretkey) + * [`fn withKey(key)`](#fn-specscalewaysdconfigssecretkeywithkey) + * [`fn withName(name)`](#fn-specscalewaysdconfigssecretkeywithname) + * [`fn withOptional(optional)`](#fn-specscalewaysdconfigssecretkeywithoptional) + * [`obj spec.scalewaySDConfigs.tlsConfig`](#obj-specscalewaysdconfigstlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-specscalewaysdconfigstlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-specscalewaysdconfigstlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-specscalewaysdconfigstlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-specscalewaysdconfigstlsconfigwithservername) + * [`obj spec.scalewaySDConfigs.tlsConfig.ca`](#obj-specscalewaysdconfigstlsconfigca) + * [`obj spec.scalewaySDConfigs.tlsConfig.ca.configMap`](#obj-specscalewaysdconfigstlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-specscalewaysdconfigstlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-specscalewaysdconfigstlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specscalewaysdconfigstlsconfigcaconfigmapwithoptional) + * [`obj spec.scalewaySDConfigs.tlsConfig.ca.secret`](#obj-specscalewaysdconfigstlsconfigcasecret) + * [`fn withKey(key)`](#fn-specscalewaysdconfigstlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-specscalewaysdconfigstlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-specscalewaysdconfigstlsconfigcasecretwithoptional) + * [`obj spec.scalewaySDConfigs.tlsConfig.cert`](#obj-specscalewaysdconfigstlsconfigcert) + * [`obj spec.scalewaySDConfigs.tlsConfig.cert.configMap`](#obj-specscalewaysdconfigstlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-specscalewaysdconfigstlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-specscalewaysdconfigstlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-specscalewaysdconfigstlsconfigcertconfigmapwithoptional) + * [`obj spec.scalewaySDConfigs.tlsConfig.cert.secret`](#obj-specscalewaysdconfigstlsconfigcertsecret) + * [`fn withKey(key)`](#fn-specscalewaysdconfigstlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-specscalewaysdconfigstlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-specscalewaysdconfigstlsconfigcertsecretwithoptional) + * [`obj spec.scalewaySDConfigs.tlsConfig.keySecret`](#obj-specscalewaysdconfigstlsconfigkeysecret) + * [`fn withKey(key)`](#fn-specscalewaysdconfigstlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-specscalewaysdconfigstlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-specscalewaysdconfigstlsconfigkeysecretwithoptional) + * [`obj spec.staticConfigs`](#obj-specstaticconfigs) + * [`fn withLabels(labels)`](#fn-specstaticconfigswithlabels) + * [`fn withLabelsMixin(labels)`](#fn-specstaticconfigswithlabelsmixin) + * [`fn withTargets(targets)`](#fn-specstaticconfigswithtargets) + * [`fn withTargetsMixin(targets)`](#fn-specstaticconfigswithtargetsmixin) + * [`obj spec.tlsConfig`](#obj-spectlsconfig) + * [`fn withInsecureSkipVerify(insecureSkipVerify)`](#fn-spectlsconfigwithinsecureskipverify) + * [`fn withMaxVersion(maxVersion)`](#fn-spectlsconfigwithmaxversion) + * [`fn withMinVersion(minVersion)`](#fn-spectlsconfigwithminversion) + * [`fn withServerName(serverName)`](#fn-spectlsconfigwithservername) + * [`obj spec.tlsConfig.ca`](#obj-spectlsconfigca) + * [`obj spec.tlsConfig.ca.configMap`](#obj-spectlsconfigcaconfigmap) + * [`fn withKey(key)`](#fn-spectlsconfigcaconfigmapwithkey) + * [`fn withName(name)`](#fn-spectlsconfigcaconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigcaconfigmapwithoptional) + * [`obj spec.tlsConfig.ca.secret`](#obj-spectlsconfigcasecret) + * [`fn withKey(key)`](#fn-spectlsconfigcasecretwithkey) + * [`fn withName(name)`](#fn-spectlsconfigcasecretwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigcasecretwithoptional) + * [`obj spec.tlsConfig.cert`](#obj-spectlsconfigcert) + * [`obj spec.tlsConfig.cert.configMap`](#obj-spectlsconfigcertconfigmap) + * [`fn withKey(key)`](#fn-spectlsconfigcertconfigmapwithkey) + * [`fn withName(name)`](#fn-spectlsconfigcertconfigmapwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigcertconfigmapwithoptional) + * [`obj spec.tlsConfig.cert.secret`](#obj-spectlsconfigcertsecret) + * [`fn withKey(key)`](#fn-spectlsconfigcertsecretwithkey) + * [`fn withName(name)`](#fn-spectlsconfigcertsecretwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigcertsecretwithoptional) + * [`obj spec.tlsConfig.keySecret`](#obj-spectlsconfigkeysecret) + * [`fn withKey(key)`](#fn-spectlsconfigkeysecretwithkey) + * [`fn withName(name)`](#fn-spectlsconfigkeysecretwithname) + * [`fn withOptional(optional)`](#fn-spectlsconfigkeysecretwithoptional) + +## Fields + +### fn new + +```ts +new(name) +``` + +new returns an instance of ScrapeConfig + +## obj metadata + +"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create." + +### fn metadata.withAnnotations + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withGeneration(generation) +``` + +"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only." + +### fn metadata.withLabels + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +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 + +```ts +withResourceVersion(resourceVersion) +``` + +"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency" + +### fn metadata.withSelfLink + +```ts +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 + +```ts +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 + +"ScrapeConfigSpec is a specification of the desired configuration for a scrape configuration." + +### fn spec.withAzureSDConfigs + +```ts +withAzureSDConfigs(azureSDConfigs) +``` + +"AzureSDConfigs defines a list of Azure service discovery configurations." + +### fn spec.withAzureSDConfigsMixin + +```ts +withAzureSDConfigsMixin(azureSDConfigs) +``` + +"AzureSDConfigs defines a list of Azure service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withConsulSDConfigs + +```ts +withConsulSDConfigs(consulSDConfigs) +``` + +"ConsulSDConfigs defines a list of Consul service discovery configurations." + +### fn spec.withConsulSDConfigsMixin + +```ts +withConsulSDConfigsMixin(consulSDConfigs) +``` + +"ConsulSDConfigs defines a list of Consul service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withDigitalOceanSDConfigs + +```ts +withDigitalOceanSDConfigs(digitalOceanSDConfigs) +``` + +"DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations." + +### fn spec.withDigitalOceanSDConfigsMixin + +```ts +withDigitalOceanSDConfigsMixin(digitalOceanSDConfigs) +``` + +"DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withDnsSDConfigs + +```ts +withDnsSDConfigs(dnsSDConfigs) +``` + +"DNSSDConfigs defines a list of DNS service discovery configurations." + +### fn spec.withDnsSDConfigsMixin + +```ts +withDnsSDConfigsMixin(dnsSDConfigs) +``` + +"DNSSDConfigs defines a list of DNS service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withDockerSDConfigs + +```ts +withDockerSDConfigs(dockerSDConfigs) +``` + +"DockerSDConfigs defines a list of Docker service discovery configurations." + +### fn spec.withDockerSDConfigsMixin + +```ts +withDockerSDConfigsMixin(dockerSDConfigs) +``` + +"DockerSDConfigs defines a list of Docker service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withDockerSwarmSDConfigs + +```ts +withDockerSwarmSDConfigs(dockerSwarmSDConfigs) +``` + +"DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations." + +### fn spec.withDockerSwarmSDConfigsMixin + +```ts +withDockerSwarmSDConfigsMixin(dockerSwarmSDConfigs) +``` + +"DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withEc2SDConfigs + +```ts +withEc2SDConfigs(ec2SDConfigs) +``` + +"EC2SDConfigs defines a list of EC2 service discovery configurations." + +### fn spec.withEc2SDConfigsMixin + +```ts +withEc2SDConfigsMixin(ec2SDConfigs) +``` + +"EC2SDConfigs defines a list of EC2 service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withEnableCompression + +```ts +withEnableCompression(enableCompression) +``` + +"When false, Prometheus will request uncompressed response from the scraped target.\n\n\nIt requires Prometheus >= v2.49.0.\n\n\nIf unset, Prometheus uses true by default." + +### fn spec.withEurekaSDConfigs + +```ts +withEurekaSDConfigs(eurekaSDConfigs) +``` + +"EurekaSDConfigs defines a list of Eureka service discovery configurations." + +### fn spec.withEurekaSDConfigsMixin + +```ts +withEurekaSDConfigsMixin(eurekaSDConfigs) +``` + +"EurekaSDConfigs defines a list of Eureka service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withFileSDConfigs + +```ts +withFileSDConfigs(fileSDConfigs) +``` + +"FileSDConfigs defines a list of file service discovery configurations." + +### fn spec.withFileSDConfigsMixin + +```ts +withFileSDConfigsMixin(fileSDConfigs) +``` + +"FileSDConfigs defines a list of file service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withGceSDConfigs + +```ts +withGceSDConfigs(gceSDConfigs) +``` + +"GCESDConfigs defines a list of GCE service discovery configurations." + +### fn spec.withGceSDConfigsMixin + +```ts +withGceSDConfigsMixin(gceSDConfigs) +``` + +"GCESDConfigs defines a list of GCE service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withHetznerSDConfigs + +```ts +withHetznerSDConfigs(hetznerSDConfigs) +``` + +"HetznerSDConfigs defines a list of Hetzner service discovery configurations." + +### fn spec.withHetznerSDConfigsMixin + +```ts +withHetznerSDConfigsMixin(hetznerSDConfigs) +``` + +"HetznerSDConfigs defines a list of Hetzner service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withHonorLabels + +```ts +withHonorLabels(honorLabels) +``` + +"HonorLabels chooses the metric's labels on collisions with target labels." + +### fn spec.withHonorTimestamps + +```ts +withHonorTimestamps(honorTimestamps) +``` + +"HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data." + +### fn spec.withHttpSDConfigs + +```ts +withHttpSDConfigs(httpSDConfigs) +``` + +"HTTPSDConfigs defines a list of HTTP service discovery configurations." + +### fn spec.withHttpSDConfigsMixin + +```ts +withHttpSDConfigsMixin(httpSDConfigs) +``` + +"HTTPSDConfigs defines a list of HTTP service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withJobName + +```ts +withJobName(jobName) +``` + +"The value of the `job` label assigned to the scraped metrics by default.\n\n\nThe `job_name` field in the rendered scrape configuration is always controlled by the\noperator to prevent duplicate job names, which Prometheus does not allow. Instead the\n`job` label is set by means of relabeling configs." + +### fn spec.withKeepDroppedTargets + +```ts +withKeepDroppedTargets(keepDroppedTargets) +``` + +"Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\n\nIt requires Prometheus >= v2.47.0." + +### fn spec.withKubernetesSDConfigs + +```ts +withKubernetesSDConfigs(kubernetesSDConfigs) +``` + +"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations." + +### fn spec.withKubernetesSDConfigsMixin + +```ts +withKubernetesSDConfigsMixin(kubernetesSDConfigs) +``` + +"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withKumaSDConfigs + +```ts +withKumaSDConfigs(kumaSDConfigs) +``` + +"KumaSDConfigs defines a list of Kuma service discovery configurations." + +### fn spec.withKumaSDConfigsMixin + +```ts +withKumaSDConfigsMixin(kumaSDConfigs) +``` + +"KumaSDConfigs defines a list of Kuma service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withLabelLimit + +```ts +withLabelLimit(labelLimit) +``` + +"Per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer." + +### fn spec.withLabelNameLengthLimit + +```ts +withLabelNameLengthLimit(labelNameLengthLimit) +``` + +"Per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer." + +### fn spec.withLabelValueLengthLimit + +```ts +withLabelValueLengthLimit(labelValueLengthLimit) +``` + +"Per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer." + +### fn spec.withLightSailSDConfigs + +```ts +withLightSailSDConfigs(lightSailSDConfigs) +``` + +"LightsailSDConfigs defines a list of Lightsail service discovery configurations." + +### fn spec.withLightSailSDConfigsMixin + +```ts +withLightSailSDConfigsMixin(lightSailSDConfigs) +``` + +"LightsailSDConfigs defines a list of Lightsail service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withLinodeSDConfigs + +```ts +withLinodeSDConfigs(linodeSDConfigs) +``` + +"LinodeSDConfigs defines a list of Linode service discovery configurations." + +### fn spec.withLinodeSDConfigsMixin + +```ts +withLinodeSDConfigsMixin(linodeSDConfigs) +``` + +"LinodeSDConfigs defines a list of Linode service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withMetricRelabelings + +```ts +withMetricRelabelings(metricRelabelings) +``` + +"MetricRelabelConfigs to apply to samples before ingestion." + +### fn spec.withMetricRelabelingsMixin + +```ts +withMetricRelabelingsMixin(metricRelabelings) +``` + +"MetricRelabelConfigs to apply to samples before ingestion." + +**Note:** This function appends passed data to existing values + +### fn spec.withMetricsPath + +```ts +withMetricsPath(metricsPath) +``` + +"MetricsPath HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics)." + +### fn spec.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.withNomadSDConfigs + +```ts +withNomadSDConfigs(nomadSDConfigs) +``` + +"NomadSDConfigs defines a list of Nomad service discovery configurations." + +### fn spec.withNomadSDConfigsMixin + +```ts +withNomadSDConfigsMixin(nomadSDConfigs) +``` + +"NomadSDConfigs defines a list of Nomad service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withOpenstackSDConfigs + +```ts +withOpenstackSDConfigs(openstackSDConfigs) +``` + +"OpenStackSDConfigs defines a list of OpenStack service discovery configurations." + +### fn spec.withOpenstackSDConfigsMixin + +```ts +withOpenstackSDConfigsMixin(openstackSDConfigs) +``` + +"OpenStackSDConfigs defines a list of OpenStack service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withOvhcloudSDConfigs + +```ts +withOvhcloudSDConfigs(ovhcloudSDConfigs) +``` + +"OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations." + +### fn spec.withOvhcloudSDConfigsMixin + +```ts +withOvhcloudSDConfigsMixin(ovhcloudSDConfigs) +``` + +"OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withParams + +```ts +withParams(params) +``` + +"Optional HTTP URL parameters" + +### fn spec.withParamsMixin + +```ts +withParamsMixin(params) +``` + +"Optional HTTP URL parameters" + +**Note:** This function appends passed data to existing values + +### fn spec.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.withPuppetDBSDConfigs + +```ts +withPuppetDBSDConfigs(puppetDBSDConfigs) +``` + +"PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations." + +### fn spec.withPuppetDBSDConfigsMixin + +```ts +withPuppetDBSDConfigsMixin(puppetDBSDConfigs) +``` + +"PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withRelabelings + +```ts +withRelabelings(relabelings) +``` + +"RelabelConfigs defines how to rewrite the target's labels before scraping.\nPrometheus Operator automatically adds relabelings for a few standard Kubernetes fields.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.withRelabelingsMixin + +```ts +withRelabelingsMixin(relabelings) +``` + +"RelabelConfigs defines how to rewrite the target's labels before scraping.\nPrometheus Operator automatically adds relabelings for a few standard Kubernetes fields.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +**Note:** This function appends passed data to existing values + +### fn spec.withSampleLimit + +```ts +withSampleLimit(sampleLimit) +``` + +"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted." + +### fn spec.withScalewaySDConfigs + +```ts +withScalewaySDConfigs(scalewaySDConfigs) +``` + +"ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations." + +### fn spec.withScalewaySDConfigsMixin + +```ts +withScalewaySDConfigsMixin(scalewaySDConfigs) +``` + +"ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations." + +**Note:** This function appends passed data to existing values + +### fn spec.withScheme + +```ts +withScheme(scheme) +``` + +"Configures the protocol scheme used for requests.\nIf empty, Prometheus uses HTTP by default." + +### fn spec.withScrapeClass + +```ts +withScrapeClass(scrapeClass) +``` + +"The scrape class to apply." + +### fn spec.withScrapeInterval + +```ts +withScrapeInterval(scrapeInterval) +``` + +"ScrapeInterval is the interval between consecutive scrapes." + +### fn spec.withScrapeProtocols + +```ts +withScrapeProtocols(scrapeProtocols) +``` + +"The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +### fn spec.withScrapeProtocolsMixin + +```ts +withScrapeProtocolsMixin(scrapeProtocols) +``` + +"The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\n\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.49.0." + +**Note:** This function appends passed data to existing values + +### fn spec.withScrapeTimeout + +```ts +withScrapeTimeout(scrapeTimeout) +``` + +"ScrapeTimeout is the number of seconds to wait until a scrape request times out." + +### fn spec.withStaticConfigs + +```ts +withStaticConfigs(staticConfigs) +``` + +"StaticConfigs defines a list of static targets with a common label set." + +### fn spec.withStaticConfigsMixin + +```ts +withStaticConfigsMixin(staticConfigs) +``` + +"StaticConfigs defines a list of static targets with a common label set." + +**Note:** This function appends passed data to existing values + +### fn spec.withTargetLimit + +```ts +withTargetLimit(targetLimit) +``` + +"TargetLimit defines a limit on the number of scraped targets that will be accepted." + +### fn spec.withTrackTimestampsStaleness + +```ts +withTrackTimestampsStaleness(trackTimestampsStaleness) +``` + +"TrackTimestampsStaleness whether Prometheus tracks staleness of\nthe metrics that have an explicit timestamp present in scraped data.\nHas no effect if `honorTimestamps` is false.\nIt requires Prometheus >= v2.48.0." + +## obj spec.authorization + +"Authorization header to use on every scrape request." + +### fn spec.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.azureSDConfigs + +"AzureSDConfigs defines a list of Azure service discovery configurations." + +### fn spec.azureSDConfigs.withAuthenticationMethod + +```ts +withAuthenticationMethod(authenticationMethod) +``` + +"# The authentication method, either `OAuth` or `ManagedIdentity` or `SDK`.\nSee https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview\nSDK authentication method uses environment variables by default.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication" + +### fn spec.azureSDConfigs.withClientID + +```ts +withClientID(clientID) +``` + +"Optional client ID. Only required with the OAuth authentication method." + +### fn spec.azureSDConfigs.withEnvironment + +```ts +withEnvironment(environment) +``` + +"The Azure environment." + +### fn spec.azureSDConfigs.withPort + +```ts +withPort(port) +``` + +"The port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule." + +### fn spec.azureSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list." + +### fn spec.azureSDConfigs.withResourceGroup + +```ts +withResourceGroup(resourceGroup) +``` + +"Optional resource group name. Limits discovery to this resource group." + +### fn spec.azureSDConfigs.withSubscriptionID + +```ts +withSubscriptionID(subscriptionID) +``` + +"The subscription ID. Always required." + +### fn spec.azureSDConfigs.withTenantID + +```ts +withTenantID(tenantID) +``` + +"Optional tenant ID. Only required with the OAuth authentication method." + +## obj spec.azureSDConfigs.clientSecret + +"Optional client secret. Only required with the OAuth authentication method." + +### fn spec.azureSDConfigs.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.azureSDConfigs.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.azureSDConfigs.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.basicAuth + +"BasicAuth information to use on every scrape request." + +## obj spec.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs + +"ConsulSDConfigs defines a list of Consul service discovery configurations." + +### fn spec.consulSDConfigs.withAllowStale + +```ts +withAllowStale(allowStale) +``` + +"Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.\nIf unset, Prometheus uses its default value." + +### fn spec.consulSDConfigs.withDatacenter + +```ts +withDatacenter(datacenter) +``` + +"Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter." + +### fn spec.consulSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2.\nIf unset, Prometheus uses its default value." + +### fn spec.consulSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects.\nIf unset, Prometheus uses its default value." + +### fn spec.consulSDConfigs.withNamespace + +```ts +withNamespace(namespace) +``` + +"Namespaces are only supported in Consul Enterprise." + +### fn spec.consulSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.consulSDConfigs.withNodeMeta + +```ts +withNodeMeta(nodeMeta) +``` + +"Node metadata key/value pairs to filter nodes for a given service." + +### fn spec.consulSDConfigs.withNodeMetaMixin + +```ts +withNodeMetaMixin(nodeMeta) +``` + +"Node metadata key/value pairs to filter nodes for a given service." + +**Note:** This function appends passed data to existing values + +### fn spec.consulSDConfigs.withPartition + +```ts +withPartition(partition) +``` + +"Admin Partitions are only supported in Consul Enterprise." + +### fn spec.consulSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.consulSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.consulSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.consulSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.consulSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"The time after which the provided names are refreshed.\nOn large setup it might be a good idea to increase this value because the catalog will change all the time.\nIf unset, Prometheus uses its default value." + +### fn spec.consulSDConfigs.withScheme + +```ts +withScheme(scheme) +``` + +"HTTP Scheme default \"http\ + +### fn spec.consulSDConfigs.withServer + +```ts +withServer(server) +``` + +"A valid string consisting of a hostname or IP followed by an optional port number." + +### fn spec.consulSDConfigs.withServices + +```ts +withServices(services) +``` + +"A list of services for which targets are retrieved. If omitted, all services are scraped." + +### fn spec.consulSDConfigs.withServicesMixin + +```ts +withServicesMixin(services) +``` + +"A list of services for which targets are retrieved. If omitted, all services are scraped." + +**Note:** This function appends passed data to existing values + +### fn spec.consulSDConfigs.withTagSeparator + +```ts +withTagSeparator(tagSeparator) +``` + +"The string by which Consul tags are joined into the tag label.\nIf unset, Prometheus uses its default value." + +### fn spec.consulSDConfigs.withTags + +```ts +withTags(tags) +``` + +"An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list." + +### fn spec.consulSDConfigs.withTagsMixin + +```ts +withTagsMixin(tags) +``` + +"An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list." + +**Note:** This function appends passed data to existing values + +## obj spec.consulSDConfigs.authorization + +"Authorization header configuration to authenticate against the Consul Server." + +### fn spec.consulSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.consulSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.consulSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.basicAuth + +"BasicAuth information to authenticate against the Consul Server.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints" + +## obj spec.consulSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.consulSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.consulSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration." + +### fn spec.consulSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.consulSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.consulSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.consulSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.consulSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.consulSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.consulSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.consulSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.consulSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.consulSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.consulSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.consulSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.consulSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.consulSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.consulSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.consulSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.consulSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.consulSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.consulSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.consulSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.consulSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.consulSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.tlsConfig + +"TLS Config" + +### fn spec.consulSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.consulSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.consulSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.consulSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.consulSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.consulSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.consulSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.consulSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.consulSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.consulSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.consulSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.consulSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.consulSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.consulSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.consulSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.consulSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.consulSDConfigs.tokenRef + +"Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent." + +### fn spec.consulSDConfigs.tokenRef.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.consulSDConfigs.tokenRef.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.consulSDConfigs.tokenRef.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.digitalOceanSDConfigs + +"DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations." + +### fn spec.digitalOceanSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.digitalOceanSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.digitalOceanSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.digitalOceanSDConfigs.withPort + +```ts +withPort(port) +``` + +"The port to scrape metrics from." + +### fn spec.digitalOceanSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.digitalOceanSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.digitalOceanSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.digitalOceanSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.digitalOceanSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Refresh interval to re-read the instance list." + +## obj spec.digitalOceanSDConfigs.authorization + +"Authorization header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`." + +### fn spec.digitalOceanSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.digitalOceanSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.digitalOceanSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.digitalOceanSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.digitalOceanSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`." + +### fn spec.digitalOceanSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.digitalOceanSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.digitalOceanSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.digitalOceanSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.digitalOceanSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.digitalOceanSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.digitalOceanSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.digitalOceanSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.digitalOceanSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.digitalOceanSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.digitalOceanSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.digitalOceanSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.digitalOceanSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.digitalOceanSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.digitalOceanSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.digitalOceanSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.digitalOceanSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.digitalOceanSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.digitalOceanSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.digitalOceanSDConfigs.tlsConfig + +"TLS configuration applying to the target HTTP endpoint." + +### fn spec.digitalOceanSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.digitalOceanSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.digitalOceanSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.digitalOceanSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.digitalOceanSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.digitalOceanSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.digitalOceanSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.digitalOceanSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.digitalOceanSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.digitalOceanSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.digitalOceanSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.digitalOceanSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.digitalOceanSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.digitalOceanSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.digitalOceanSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.digitalOceanSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.digitalOceanSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.digitalOceanSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.digitalOceanSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dnsSDConfigs + +"DNSSDConfigs defines a list of DNS service discovery configurations." + +### fn spec.dnsSDConfigs.withNames + +```ts +withNames(names) +``` + +"A list of DNS domain names to be queried." + +### fn spec.dnsSDConfigs.withNamesMixin + +```ts +withNamesMixin(names) +``` + +"A list of DNS domain names to be queried." + +**Note:** This function appends passed data to existing values + +### fn spec.dnsSDConfigs.withPort + +```ts +withPort(port) +``` + +"The port number used if the query type is not SRV\nIgnored for SRV records" + +### fn spec.dnsSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"RefreshInterval configures the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value." + +### fn spec.dnsSDConfigs.withType + +```ts +withType(type) +``` + +"The type of DNS query to perform. One of SRV, A, AAAA, MX or NS.\nIf not set, Prometheus uses its default value.\n\n\nWhen set to NS, it requires Prometheus >= v2.49.0.\nWhen set to MX, it requires Prometheus >= v2.38.0" + +## obj spec.dockerSDConfigs + +"DockerSDConfigs defines a list of Docker service discovery configurations." + +### fn spec.dockerSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.dockerSDConfigs.withFilters + +```ts +withFilters(filters) +``` + +"Optional filters to limit the discovery process to a subset of the available resources." + +### fn spec.dockerSDConfigs.withFiltersMixin + +```ts +withFiltersMixin(filters) +``` + +"Optional filters to limit the discovery process to a subset of the available resources." + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.dockerSDConfigs.withHost + +```ts +withHost(host) +``` + +"Address of the docker daemon" + +### fn spec.dockerSDConfigs.withHostNetworkingHost + +```ts +withHostNetworkingHost(hostNetworkingHost) +``` + +"The host to use if the container is in host networking mode." + +### fn spec.dockerSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSDConfigs.withPort + +```ts +withPort(port) +``` + +"The port to scrape metrics from." + +### fn spec.dockerSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Time after which the container is refreshed." + +## obj spec.dockerSDConfigs.authorization + +"Authorization header configuration to authenticate against the Docker API.\nCannot be set at the same time as `oauth2`." + +### fn spec.dockerSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.dockerSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.dockerSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.basicAuth + +"BasicAuth information to use on every scrape request." + +## obj spec.dockerSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.dockerSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.dockerSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.filters + +"Optional filters to limit the discovery process to a subset of the available resources." + +### fn spec.dockerSDConfigs.filters.withName + +```ts +withName(name) +``` + +"Name of the Filter." + +### fn spec.dockerSDConfigs.filters.withValues + +```ts +withValues(values) +``` + +"Value to filter on." + +### fn spec.dockerSDConfigs.filters.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"Value to filter on." + +**Note:** This function appends passed data to existing values + +## obj spec.dockerSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`." + +### fn spec.dockerSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.dockerSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.dockerSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.dockerSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.dockerSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.dockerSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.dockerSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.dockerSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.dockerSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.tlsConfig + +"TLS configuration applying to the target HTTP endpoint." + +### fn spec.dockerSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.dockerSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.dockerSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.dockerSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.dockerSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.dockerSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.dockerSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.dockerSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs + +"DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations." + +### fn spec.dockerSwarmSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.dockerSwarmSDConfigs.withFilters + +```ts +withFilters(filters) +``` + +"Optional filters to limit the discovery process to a subset of available\nresources.\nThe available filters are listed in the upstream documentation:\nServices: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList\nTasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList\nNodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList" + +### fn spec.dockerSwarmSDConfigs.withFiltersMixin + +```ts +withFiltersMixin(filters) +``` + +"Optional filters to limit the discovery process to a subset of available\nresources.\nThe available filters are listed in the upstream documentation:\nServices: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList\nTasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList\nNodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList" + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSwarmSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.dockerSwarmSDConfigs.withHost + +```ts +withHost(host) +``` + +"Address of the Docker daemon" + +### fn spec.dockerSwarmSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSwarmSDConfigs.withPort + +```ts +withPort(port) +``` + +"The port to scrape metrics from, when `role` is nodes, and for discovered\ntasks and services that don't have published ports." + +### fn spec.dockerSwarmSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSwarmSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSwarmSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSwarmSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSwarmSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"The time after which the service discovery data is refreshed." + +### fn spec.dockerSwarmSDConfigs.withRole + +```ts +withRole(role) +``` + +"Role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`." + +## obj spec.dockerSwarmSDConfigs.authorization + +"Authorization header configuration to authenticate against the target HTTP endpoint." + +### fn spec.dockerSwarmSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.dockerSwarmSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.dockerSwarmSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.basicAuth + +"Optional HTTP basic authentication information." + +## obj spec.dockerSwarmSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.dockerSwarmSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.dockerSwarmSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.filters + +"Optional filters to limit the discovery process to a subset of available\nresources.\nThe available filters are listed in the upstream documentation:\nServices: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList\nTasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList\nNodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList" + +### fn spec.dockerSwarmSDConfigs.filters.withName + +```ts +withName(name) +``` + +"Name of the Filter." + +### fn spec.dockerSwarmSDConfigs.filters.withValues + +```ts +withValues(values) +``` + +"Value to filter on." + +### fn spec.dockerSwarmSDConfigs.filters.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"Value to filter on." + +**Note:** This function appends passed data to existing values + +## obj spec.dockerSwarmSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`, or `basicAuth`." + +### fn spec.dockerSwarmSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.dockerSwarmSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSwarmSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSwarmSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSwarmSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSwarmSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSwarmSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSwarmSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.dockerSwarmSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.dockerSwarmSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.dockerSwarmSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.dockerSwarmSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSwarmSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.dockerSwarmSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.tlsConfig + +"TLS configuration to use on every scrape request" + +### fn spec.dockerSwarmSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.dockerSwarmSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.dockerSwarmSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.dockerSwarmSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.dockerSwarmSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.dockerSwarmSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.ec2SDConfigs + +"EC2SDConfigs defines a list of EC2 service discovery configurations." + +### fn spec.ec2SDConfigs.withFilters + +```ts +withFilters(filters) +``` + +"Filters can be used optionally to filter the instance list by other criteria.\nAvailable filter criteria can be found here:\nhttps://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\nFilter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html" + +### fn spec.ec2SDConfigs.withFiltersMixin + +```ts +withFiltersMixin(filters) +``` + +"Filters can be used optionally to filter the instance list by other criteria.\nAvailable filter criteria can be found here:\nhttps://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\nFilter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html" + +**Note:** This function appends passed data to existing values + +### fn spec.ec2SDConfigs.withPort + +```ts +withPort(port) +``` + +"The port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule." + +### fn spec.ec2SDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list." + +### fn spec.ec2SDConfigs.withRegion + +```ts +withRegion(region) +``` + +"The AWS region" + +### fn spec.ec2SDConfigs.withRoleARN + +```ts +withRoleARN(roleARN) +``` + +"AWS Role ARN, an alternative to using AWS API keys." + +## obj spec.ec2SDConfigs.accessKey + +"AccessKey is the AWS API key." + +### fn spec.ec2SDConfigs.accessKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.ec2SDConfigs.accessKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.ec2SDConfigs.accessKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.ec2SDConfigs.filters + +"Filters can be used optionally to filter the instance list by other criteria.\nAvailable filter criteria can be found here:\nhttps://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\nFilter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html" + +### fn spec.ec2SDConfigs.filters.withName + +```ts +withName(name) +``` + +"Name of the Filter." + +### fn spec.ec2SDConfigs.filters.withValues + +```ts +withValues(values) +``` + +"Value to filter on." + +### fn spec.ec2SDConfigs.filters.withValuesMixin + +```ts +withValuesMixin(values) +``` + +"Value to filter on." + +**Note:** This function appends passed data to existing values + +## obj spec.ec2SDConfigs.secretKey + +"SecretKey is the AWS API secret." + +### fn spec.ec2SDConfigs.secretKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.ec2SDConfigs.secretKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.ec2SDConfigs.secretKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs + +"EurekaSDConfigs defines a list of Eureka service discovery configurations." + +### fn spec.eurekaSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.eurekaSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.eurekaSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.eurekaSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.eurekaSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.eurekaSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.eurekaSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.eurekaSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Refresh interval to re-read the instance list." + +### fn spec.eurekaSDConfigs.withServer + +```ts +withServer(server) +``` + +"The URL to connect to the Eureka server." + +## obj spec.eurekaSDConfigs.authorization + +"Authorization header to use on every scrape request." + +### fn spec.eurekaSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.eurekaSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.eurekaSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.basicAuth + +"BasicAuth information to use on every scrape request." + +## obj spec.eurekaSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.eurekaSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.eurekaSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization` or `basic_auth`." + +### fn spec.eurekaSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.eurekaSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.eurekaSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.eurekaSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.eurekaSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.eurekaSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.eurekaSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.eurekaSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.eurekaSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.eurekaSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.eurekaSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.eurekaSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.eurekaSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.eurekaSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.eurekaSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.eurekaSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.eurekaSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.eurekaSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.eurekaSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.eurekaSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.eurekaSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.eurekaSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.tlsConfig + +"TLS configuration applying to the target HTTP endpoint." + +### fn spec.eurekaSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.eurekaSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.eurekaSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.eurekaSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.eurekaSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.eurekaSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.eurekaSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.eurekaSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.eurekaSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.eurekaSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.eurekaSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.eurekaSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.eurekaSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.eurekaSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.eurekaSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.eurekaSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.eurekaSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.eurekaSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.eurekaSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.fileSDConfigs + +"FileSDConfigs defines a list of file service discovery configurations." + +### fn spec.fileSDConfigs.withFiles + +```ts +withFiles(files) +``` + +"List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the\nprometheus-operator project makes no guarantees about the working directory where the configuration file is\nstored.\nFiles must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets." + +### fn spec.fileSDConfigs.withFilesMixin + +```ts +withFilesMixin(files) +``` + +"List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the\nprometheus-operator project makes no guarantees about the working directory where the configuration file is\nstored.\nFiles must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets." + +**Note:** This function appends passed data to existing values + +### fn spec.fileSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"RefreshInterval configures the refresh interval at which Prometheus will reload the content of the files." + +## obj spec.gceSDConfigs + +"GCESDConfigs defines a list of GCE service discovery configurations." + +### fn spec.gceSDConfigs.withFilter + +```ts +withFilter(filter) +``` + +"Filter can be used optionally to filter the instance list by other criteria\nSyntax of this filter is described in the filter query parameter section:\nhttps://cloud.google.com/compute/docs/reference/latest/instances/list" + +### fn spec.gceSDConfigs.withPort + +```ts +withPort(port) +``` + +"The port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule." + +### fn spec.gceSDConfigs.withProject + +```ts +withProject(project) +``` + +"The Google Cloud Project ID" + +### fn spec.gceSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list." + +### fn spec.gceSDConfigs.withTagSeparator + +```ts +withTagSeparator(tagSeparator) +``` + +"The tag separator is used to separate the tags on concatenation" + +### fn spec.gceSDConfigs.withZone + +```ts +withZone(zone) +``` + +"The zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs." + +## obj spec.hetznerSDConfigs + +"HetznerSDConfigs defines a list of Hetzner service discovery configurations." + +### fn spec.hetznerSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.hetznerSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.hetznerSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.hetznerSDConfigs.withPort + +```ts +withPort(port) +``` + +"The port to scrape metrics from." + +### fn spec.hetznerSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.hetznerSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.hetznerSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.hetznerSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.hetznerSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"The time after which the servers are refreshed." + +### fn spec.hetznerSDConfigs.withRole + +```ts +withRole(role) +``` + +"The Hetzner role of entities that should be discovered." + +## obj spec.hetznerSDConfigs.authorization + +"Authorization header configuration, required when role is hcloud.\nRole robot does not support bearer token authentication." + +### fn spec.hetznerSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.hetznerSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.hetznerSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.basicAuth + +"BasicAuth information to use on every scrape request, required when role is robot.\nRole hcloud does not support basic auth." + +## obj spec.hetznerSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.hetznerSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.hetznerSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration.\nCannot be used at the same time as `basic_auth` or `authorization`." + +### fn spec.hetznerSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.hetznerSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.hetznerSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.hetznerSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.hetznerSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.hetznerSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.hetznerSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.hetznerSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.hetznerSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.hetznerSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.hetznerSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.hetznerSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.hetznerSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.hetznerSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.hetznerSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.hetznerSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.hetznerSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.hetznerSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.hetznerSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.hetznerSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.hetznerSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.hetznerSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.tlsConfig + +"TLS configuration to use on every scrape request." + +### fn spec.hetznerSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.hetznerSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.hetznerSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.hetznerSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.hetznerSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.hetznerSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.hetznerSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.hetznerSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.hetznerSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.hetznerSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.hetznerSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.hetznerSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.hetznerSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.hetznerSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.hetznerSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.hetznerSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.hetznerSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.hetznerSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.hetznerSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.httpSDConfigs + +"HTTPSDConfigs defines a list of HTTP service discovery configurations." + +### fn spec.httpSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.httpSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.httpSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.httpSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.httpSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.httpSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"RefreshInterval configures the refresh interval at which Prometheus will re-query the\nendpoint to update the target list." + +### fn spec.httpSDConfigs.withUrl + +```ts +withUrl(url) +``` + +"URL from which the targets are fetched." + +## obj spec.httpSDConfigs.authorization + +"Authorization header configuration to authenticate against the target HTTP endpoint." + +### fn spec.httpSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.httpSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.httpSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.httpSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.httpSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.httpSDConfigs.basicAuth + +"BasicAuth information to authenticate against the target HTTP endpoint.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints" + +## obj spec.httpSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.httpSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.httpSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.httpSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.httpSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.httpSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.httpSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.httpSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.httpSDConfigs.tlsConfig + +"TLS configuration applying to the target HTTP endpoint." + +### fn spec.httpSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.httpSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.httpSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.httpSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.httpSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.httpSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.httpSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.httpSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.httpSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.httpSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.httpSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.httpSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.httpSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.httpSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.httpSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.httpSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.httpSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.httpSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.httpSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.httpSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.httpSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.httpSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.httpSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.httpSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.httpSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.httpSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs + +"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations." + +### fn spec.kubernetesSDConfigs.withApiServer + +```ts +withApiServer(apiServer) +``` + +"The API server address consisting of a hostname or IP address followed\nby an optional port number.\nIf left empty, Prometheus is assumed to run inside\nof the cluster. It will discover API servers automatically and use the pod's\nCA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/." + +### fn spec.kubernetesSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.kubernetesSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.kubernetesSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kubernetesSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kubernetesSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.kubernetesSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kubernetesSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kubernetesSDConfigs.withRole + +```ts +withRole(role) +``` + +"Role of the Kubernetes entities that should be discovered.\nRole `Endpointslice` requires Prometheus >= v2.21.0" + +### fn spec.kubernetesSDConfigs.withSelectors + +```ts +withSelectors(selectors) +``` + +"Selector to select objects.\nIt requires Prometheus >= v2.17.0" + +### fn spec.kubernetesSDConfigs.withSelectorsMixin + +```ts +withSelectorsMixin(selectors) +``` + +"Selector to select objects.\nIt requires Prometheus >= v2.17.0" + +**Note:** This function appends passed data to existing values + +## obj spec.kubernetesSDConfigs.attachMetadata + +"Optional metadata to attach to discovered targets.\nIt requires Prometheus >= v2.35.0 when using the `Pod` role and\nPrometheus >= v2.37.0 for `Endpoints` and `Endpointslice` roles." + +### fn spec.kubernetesSDConfigs.attachMetadata.withNode + +```ts +withNode(node) +``` + +"Attaches node metadata to discovered targets.\nWhen set to true, Prometheus must have the `get` permission on the\n`Nodes` objects.\nOnly valid for Pod, Endpoint and Endpointslice roles." + +## obj spec.kubernetesSDConfigs.authorization + +"Authorization header to use on every scrape request.\nCannot be set at the same time as `basicAuth`, or `oauth2`." + +### fn spec.kubernetesSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.kubernetesSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.kubernetesSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.basicAuth + +"BasicAuth information to use on every scrape request.\nCannot be set at the same time as `authorization`, or `oauth2`." + +## obj spec.kubernetesSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.kubernetesSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.kubernetesSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.namespaces + +"Optional namespace discovery. If omitted, Prometheus discovers targets across all namespaces." + +### fn spec.kubernetesSDConfigs.namespaces.withNames + +```ts +withNames(names) +``` + +"List of namespaces where to watch for resources.\nIf empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces." + +### fn spec.kubernetesSDConfigs.namespaces.withNamesMixin + +```ts +withNamesMixin(names) +``` + +"List of namespaces where to watch for resources.\nIf empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces." + +**Note:** This function appends passed data to existing values + +### fn spec.kubernetesSDConfigs.namespaces.withOwnNamespace + +```ts +withOwnNamespace(ownNamespace) +``` + +"Includes the namespace in which the Prometheus pod runs to the list of watched namespaces." + +## obj spec.kubernetesSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`, or `basicAuth`." + +### fn spec.kubernetesSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.kubernetesSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.kubernetesSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kubernetesSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kubernetesSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.kubernetesSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kubernetesSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kubernetesSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.kubernetesSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.kubernetesSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.kubernetesSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.kubernetesSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kubernetesSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kubernetesSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.kubernetesSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.kubernetesSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.selectors + +"Selector to select objects.\nIt requires Prometheus >= v2.17.0" + +### fn spec.kubernetesSDConfigs.selectors.withField + +```ts +withField(field) +``` + +"An optional field selector to limit the service discovery to resources which have fields with specific values.\ne.g: `metadata.name=foobar`" + +### fn spec.kubernetesSDConfigs.selectors.withLabel + +```ts +withLabel(label) +``` + +"An optional label selector to limit the service discovery to resources with specific labels and label values.\ne.g: `node.kubernetes.io/instance-type=master`" + +### fn spec.kubernetesSDConfigs.selectors.withRole + +```ts +withRole(role) +``` + +"Role specifies the type of Kubernetes resource to limit the service discovery to.\nAccepted values are: Node, Pod, Endpoints, EndpointSlice, Service, Ingress." + +## obj spec.kubernetesSDConfigs.tlsConfig + +"TLS configuration to connect to the Kubernetes API." + +### fn spec.kubernetesSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.kubernetesSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.kubernetesSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.kubernetesSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.kubernetesSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.kubernetesSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kubernetesSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kubernetesSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.kubernetesSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kubernetesSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kubernetesSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.kubernetesSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kubernetesSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.kubernetesSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kubernetesSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kubernetesSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs + +"KumaSDConfigs defines a list of Kuma service discovery configurations." + +### fn spec.kumaSDConfigs.withClientID + +```ts +withClientID(clientID) +``` + +"Client id is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend." + +### fn spec.kumaSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.kumaSDConfigs.withFetchTimeout + +```ts +withFetchTimeout(fetchTimeout) +``` + +"The time after which the monitoring assignments are refreshed." + +### fn spec.kumaSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.kumaSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kumaSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kumaSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.kumaSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kumaSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kumaSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"The time to wait between polling update requests." + +### fn spec.kumaSDConfigs.withServer + +```ts +withServer(server) +``` + +"Address of the Kuma Control Plane's MADS xDS server." + +## obj spec.kumaSDConfigs.authorization + +"Authorization header to use on every scrape request." + +### fn spec.kumaSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.kumaSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.kumaSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.basicAuth + +"BasicAuth information to use on every scrape request." + +## obj spec.kumaSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.kumaSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.kumaSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`, or `basicAuth`." + +### fn spec.kumaSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.kumaSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.kumaSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kumaSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kumaSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.kumaSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kumaSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.kumaSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.kumaSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.kumaSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.kumaSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.kumaSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kumaSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kumaSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kumaSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.kumaSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.kumaSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.kumaSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.kumaSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kumaSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.kumaSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kumaSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.tlsConfig + +"TLS configuration to use on every scrape request" + +### fn spec.kumaSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.kumaSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.kumaSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.kumaSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.kumaSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.kumaSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kumaSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kumaSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kumaSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.kumaSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.kumaSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.kumaSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.kumaSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.kumaSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.kumaSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.kumaSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.kumaSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.kumaSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.kumaSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs + +"LightsailSDConfigs defines a list of Lightsail service discovery configurations." + +### fn spec.lightSailSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Configure whether to enable HTTP2." + +### fn spec.lightSailSDConfigs.withEndpoint + +```ts +withEndpoint(endpoint) +``` + +"Custom endpoint to be used." + +### fn spec.lightSailSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether the HTTP requests should follow HTTP 3xx redirects." + +### fn spec.lightSailSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.lightSailSDConfigs.withPort + +```ts +withPort(port) +``` + +"Port to scrape the metrics from.\nIf using the public IP address, this must instead be specified in the relabeling rule." + +### fn spec.lightSailSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.lightSailSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.lightSailSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.lightSailSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.lightSailSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Refresh interval to re-read the list of instances." + +### fn spec.lightSailSDConfigs.withRegion + +```ts +withRegion(region) +``` + +"The AWS region." + +### fn spec.lightSailSDConfigs.withRoleARN + +```ts +withRoleARN(roleARN) +``` + +"AWS Role ARN, an alternative to using AWS API keys." + +## obj spec.lightSailSDConfigs.accessKey + +"AccessKey is the AWS API key." + +### fn spec.lightSailSDConfigs.accessKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.accessKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.accessKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.authorization + +"Optional `authorization` HTTP header configuration.\nCannot be set at the same time as `basicAuth`, or `oauth2`." + +### fn spec.lightSailSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.lightSailSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.lightSailSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.basicAuth + +"Optional HTTP basic authentication information.\nCannot be set at the same time as `authorization`, or `oauth2`." + +## obj spec.lightSailSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.lightSailSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.lightSailSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.oauth2 + +"Optional OAuth2.0 configuration.\nCannot be set at the same time as `basicAuth`, or `authorization`." + +### fn spec.lightSailSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.lightSailSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.lightSailSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.lightSailSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.lightSailSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.lightSailSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.lightSailSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.lightSailSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.lightSailSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.lightSailSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.lightSailSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.lightSailSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.lightSailSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.lightSailSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.lightSailSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.lightSailSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.lightSailSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.lightSailSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.lightSailSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.lightSailSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.lightSailSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.lightSailSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.secretKey + +"SecretKey is the AWS API secret." + +### fn spec.lightSailSDConfigs.secretKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.secretKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.secretKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.tlsConfig + +"TLS configuration to connect to the Puppet DB." + +### fn spec.lightSailSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.lightSailSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.lightSailSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.lightSailSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.lightSailSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.lightSailSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.lightSailSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.lightSailSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.lightSailSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.lightSailSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.lightSailSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.lightSailSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.lightSailSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.lightSailSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.lightSailSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.lightSailSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.lightSailSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.lightSailSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.lightSailSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.linodeSDConfigs + +"LinodeSDConfigs defines a list of Linode service discovery configurations." + +### fn spec.linodeSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.linodeSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.linodeSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.linodeSDConfigs.withPort + +```ts +withPort(port) +``` + +"Default port to scrape metrics from." + +### fn spec.linodeSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.linodeSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.linodeSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.linodeSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.linodeSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Time after which the linode instances are refreshed." + +### fn spec.linodeSDConfigs.withRegion + +```ts +withRegion(region) +``` + +"Optional region to filter on." + +### fn spec.linodeSDConfigs.withTagSeparator + +```ts +withTagSeparator(tagSeparator) +``` + +"The string by which Linode Instance tags are joined into the tag label." + +## obj spec.linodeSDConfigs.authorization + +"Authorization header configuration." + +### fn spec.linodeSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.linodeSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.linodeSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.linodeSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.linodeSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration.\nCannot be used at the same time as `authorization`." + +### fn spec.linodeSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.linodeSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.linodeSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.linodeSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.linodeSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.linodeSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.linodeSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.linodeSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.linodeSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.linodeSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.linodeSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.linodeSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.linodeSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.linodeSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.linodeSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.linodeSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.linodeSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.linodeSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.linodeSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.linodeSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.linodeSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.linodeSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.linodeSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.linodeSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.linodeSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.linodeSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.linodeSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.linodeSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.linodeSDConfigs.tlsConfig + +"TLS configuration applying to the target HTTP endpoint." + +### fn spec.linodeSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.linodeSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.linodeSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.linodeSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.linodeSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.linodeSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.linodeSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.linodeSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.linodeSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.linodeSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.linodeSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.linodeSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.linodeSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.linodeSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.linodeSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.linodeSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.linodeSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.linodeSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.linodeSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.linodeSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.linodeSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.linodeSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.metricRelabelings + +"MetricRelabelConfigs to apply to samples before ingestion." + +### fn spec.metricRelabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.metricRelabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.metricRelabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.metricRelabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.metricRelabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.metricRelabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.metricRelabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.metricRelabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.nomadSDConfigs + +"NomadSDConfigs defines a list of Nomad service discovery configurations." + +### fn spec.nomadSDConfigs.withAllowStale + +```ts +withAllowStale(allowStale) +``` + +"The information to access the Nomad API. It is to be defined\nas the Nomad documentation requires." + +### fn spec.nomadSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.nomadSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.nomadSDConfigs.withNamespace + +```ts +withNamespace(namespace) +``` + + + +### fn spec.nomadSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.nomadSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.nomadSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.nomadSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.nomadSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.nomadSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Duration is a valid time duration that can be parsed by Prometheus model.ParseDuration() function.\nSupported units: y, w, d, h, m, s, ms\nExamples: `30s`, `1m`, `1h20m15s`, `15d`" + +### fn spec.nomadSDConfigs.withRegion + +```ts +withRegion(region) +``` + + + +### fn spec.nomadSDConfigs.withServer + +```ts +withServer(server) +``` + + + +### fn spec.nomadSDConfigs.withTagSeparator + +```ts +withTagSeparator(tagSeparator) +``` + + + +## obj spec.nomadSDConfigs.authorization + +"Authorization header to use on every scrape request." + +### fn spec.nomadSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.nomadSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.nomadSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.basicAuth + +"BasicAuth information to use on every scrape request." + +## obj spec.nomadSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.nomadSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.nomadSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.oauth2 + +"Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization` or `basic_auth`." + +### fn spec.nomadSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.nomadSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.nomadSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.nomadSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.nomadSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.nomadSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.nomadSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.nomadSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.nomadSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.nomadSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.nomadSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.nomadSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.nomadSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.nomadSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.nomadSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.nomadSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.nomadSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.nomadSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.nomadSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.nomadSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.nomadSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.nomadSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.tlsConfig + +"TLS configuration applying to the target HTTP endpoint." + +### fn spec.nomadSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.nomadSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.nomadSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.nomadSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.nomadSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.nomadSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.nomadSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.nomadSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.nomadSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.nomadSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.nomadSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.nomadSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.nomadSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.nomadSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.nomadSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.nomadSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.nomadSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.nomadSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.nomadSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.oauth2 + +"OAuth2 client credentials used to fetch a token for the targets." + +### fn spec.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.openstackSDConfigs + +"OpenStackSDConfigs defines a list of OpenStack service discovery configurations." + +### fn spec.openstackSDConfigs.withAllTenants + +```ts +withAllTenants(allTenants) +``` + +"Whether the service discovery should list all instances for all projects.\nIt is only relevant for the 'instance' role and usually requires admin permissions." + +### fn spec.openstackSDConfigs.withApplicationCredentialId + +```ts +withApplicationCredentialId(applicationCredentialId) +``` + +"ApplicationCredentialID" + +### fn spec.openstackSDConfigs.withApplicationCredentialName + +```ts +withApplicationCredentialName(applicationCredentialName) +``` + +"The ApplicationCredentialID or ApplicationCredentialName fields are\nrequired if using an application credential to authenticate. Some providers\nallow you to create an application credential to authenticate rather than a\npassword." + +### fn spec.openstackSDConfigs.withAvailability + +```ts +withAvailability(availability) +``` + +"Availability of the endpoint to connect to." + +### fn spec.openstackSDConfigs.withDomainID + +```ts +withDomainID(domainID) +``` + +"DomainID" + +### fn spec.openstackSDConfigs.withDomainName + +```ts +withDomainName(domainName) +``` + +"At most one of domainId and domainName must be provided if using username\nwith Identity V3. Otherwise, either are optional." + +### fn spec.openstackSDConfigs.withIdentityEndpoint + +```ts +withIdentityEndpoint(identityEndpoint) +``` + +"IdentityEndpoint specifies the HTTP endpoint that is required to work with\nthe Identity API of the appropriate version." + +### fn spec.openstackSDConfigs.withPort + +```ts +withPort(port) +``` + +"The port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule." + +### fn spec.openstackSDConfigs.withProjectID + +```ts +withProjectID(projectID) +``` + +" ProjectID" + +### fn spec.openstackSDConfigs.withProjectName + +```ts +withProjectName(projectName) +``` + +"The ProjectId and ProjectName fields are optional for the Identity V2 API.\nSome providers allow you to specify a ProjectName instead of the ProjectId.\nSome require both. Your provider's authentication policies will determine\nhow these fields influence authentication." + +### fn spec.openstackSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Refresh interval to re-read the instance list." + +### fn spec.openstackSDConfigs.withRegion + +```ts +withRegion(region) +``` + +"The OpenStack Region." + +### fn spec.openstackSDConfigs.withRole + +```ts +withRole(role) +``` + +"The OpenStack role of entities that should be discovered." + +### fn spec.openstackSDConfigs.withUserid + +```ts +withUserid(userid) +``` + +"UserID" + +### fn spec.openstackSDConfigs.withUsername + +```ts +withUsername(username) +``` + +"Username is required if using Identity V2 API. Consult with your provider's\ncontrol panel to discover your account's username.\nIn Identity V3, either userid or a combination of username\nand domainId or domainName are needed" + +## obj spec.openstackSDConfigs.applicationCredentialSecret + +"The applicationCredentialSecret field is required if using an application\ncredential to authenticate." + +### fn spec.openstackSDConfigs.applicationCredentialSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.openstackSDConfigs.applicationCredentialSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.openstackSDConfigs.applicationCredentialSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.openstackSDConfigs.password + +"Password for the Identity V2 and V3 APIs. Consult with your provider's\ncontrol panel to discover your account's preferred method of authentication." + +### fn spec.openstackSDConfigs.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.openstackSDConfigs.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.openstackSDConfigs.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.openstackSDConfigs.tlsConfig + +"TLS configuration applying to the target HTTP endpoint." + +### fn spec.openstackSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.openstackSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.openstackSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.openstackSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.openstackSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.openstackSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.openstackSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.openstackSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.openstackSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.openstackSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.openstackSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.openstackSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.openstackSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.openstackSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.openstackSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.openstackSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.openstackSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.openstackSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.openstackSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.openstackSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.openstackSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.openstackSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.openstackSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.openstackSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.openstackSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.openstackSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.ovhcloudSDConfigs + +"OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations." + +### fn spec.ovhcloudSDConfigs.withApplicationKey + +```ts +withApplicationKey(applicationKey) +``` + +"Access key to use. https://api.ovh.com." + +### fn spec.ovhcloudSDConfigs.withEndpoint + +```ts +withEndpoint(endpoint) +``` + +"Custom endpoint to be used." + +### fn spec.ovhcloudSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Refresh interval to re-read the resources list." + +### fn spec.ovhcloudSDConfigs.withService + +```ts +withService(service) +``` + +"Service of the targets to retrieve. Must be `VPS` or `DedicatedServer`." + +## obj spec.ovhcloudSDConfigs.applicationSecret + +"SecretKeySelector selects a key of a Secret." + +### fn spec.ovhcloudSDConfigs.applicationSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.ovhcloudSDConfigs.applicationSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.ovhcloudSDConfigs.applicationSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.ovhcloudSDConfigs.consumerKey + +"SecretKeySelector selects a key of a Secret." + +### fn spec.ovhcloudSDConfigs.consumerKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.ovhcloudSDConfigs.consumerKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.ovhcloudSDConfigs.consumerKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs + +"PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations." + +### fn spec.puppetDBSDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Configure whether to enable HTTP2." + +### fn spec.puppetDBSDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether the HTTP requests should follow HTTP 3xx redirects." + +### fn spec.puppetDBSDConfigs.withIncludeParameters + +```ts +withIncludeParameters(includeParameters) +``` + +"Whether to include the parameters as meta labels.\nNote: Enabling this exposes parameters in the Prometheus UI and API. Make sure\nthat you don't have secrets exposed as parameters if you enable this." + +### fn spec.puppetDBSDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.puppetDBSDConfigs.withPort + +```ts +withPort(port) +``` + +"Port to scrape the metrics from." + +### fn spec.puppetDBSDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.puppetDBSDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.puppetDBSDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.puppetDBSDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.puppetDBSDConfigs.withQuery + +```ts +withQuery(query) +``` + +"Puppet Query Language (PQL) query. Only resources are supported.\nhttps://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html" + +### fn spec.puppetDBSDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Refresh interval to re-read the list of resources." + +### fn spec.puppetDBSDConfigs.withUrl + +```ts +withUrl(url) +``` + +"The URL of the PuppetDB root query endpoint." + +## obj spec.puppetDBSDConfigs.authorization + +"Optional `authorization` HTTP header configuration.\nCannot be set at the same time as `basicAuth`, or `oauth2`." + +### fn spec.puppetDBSDConfigs.authorization.withType + +```ts +withType(type) +``` + +"Defines the authentication type. The value is case-insensitive.\n\n\n\"Basic\" is not a supported value.\n\n\nDefault: \"Bearer\ + +## obj spec.puppetDBSDConfigs.authorization.credentials + +"Selects a key of a Secret in the namespace that contains the credentials for authentication." + +### fn spec.puppetDBSDConfigs.authorization.credentials.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.authorization.credentials.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.authorization.credentials.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.basicAuth + +"Optional HTTP basic authentication information.\nCannot be set at the same time as `authorization`, or `oauth2`." + +## obj spec.puppetDBSDConfigs.basicAuth.password + +"`password` specifies a key of a Secret containing the password for\nauthentication." + +### fn spec.puppetDBSDConfigs.basicAuth.password.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.basicAuth.password.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.basicAuth.password.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.basicAuth.username + +"`username` specifies a key of a Secret containing the username for\nauthentication." + +### fn spec.puppetDBSDConfigs.basicAuth.username.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.basicAuth.username.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.basicAuth.username.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.oauth2 + +"Optional OAuth2.0 configuration.\nCannot be set at the same time as `basicAuth`, or `authorization`." + +### fn spec.puppetDBSDConfigs.oauth2.withEndpointParams + +```ts +withEndpointParams(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +### fn spec.puppetDBSDConfigs.oauth2.withEndpointParamsMixin + +```ts +withEndpointParamsMixin(endpointParams) +``` + +"`endpointParams` configures the HTTP parameters to append to the token\nURL." + +**Note:** This function appends passed data to existing values + +### fn spec.puppetDBSDConfigs.oauth2.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.puppetDBSDConfigs.oauth2.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.puppetDBSDConfigs.oauth2.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.puppetDBSDConfigs.oauth2.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.puppetDBSDConfigs.oauth2.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.puppetDBSDConfigs.oauth2.withScopes + +```ts +withScopes(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +### fn spec.puppetDBSDConfigs.oauth2.withScopesMixin + +```ts +withScopesMixin(scopes) +``` + +"`scopes` defines the OAuth2 scopes used for the token request." + +**Note:** This function appends passed data to existing values + +### fn spec.puppetDBSDConfigs.oauth2.withTokenUrl + +```ts +withTokenUrl(tokenUrl) +``` + +"`tokenURL` configures the URL to fetch the token from." + +## obj spec.puppetDBSDConfigs.oauth2.clientId + +"`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID." + +## obj spec.puppetDBSDConfigs.oauth2.clientId.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.oauth2.clientId.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.puppetDBSDConfigs.oauth2.clientId.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.oauth2.clientId.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.puppetDBSDConfigs.oauth2.clientId.secret + +"Secret containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.oauth2.clientId.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.oauth2.clientId.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.oauth2.clientId.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.oauth2.clientSecret + +"`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret." + +### fn spec.puppetDBSDConfigs.oauth2.clientSecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.oauth2.clientSecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.oauth2.clientSecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.oauth2.tlsConfig + +"TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.puppetDBSDConfigs.oauth2.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.oauth2.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.oauth2.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.oauth2.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.tlsConfig + +"TLS configuration to connect to the Puppet DB." + +### fn spec.puppetDBSDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.puppetDBSDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.puppetDBSDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.puppetDBSDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.puppetDBSDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.puppetDBSDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.puppetDBSDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.puppetDBSDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.puppetDBSDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.puppetDBSDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.puppetDBSDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.puppetDBSDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.puppetDBSDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.puppetDBSDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.puppetDBSDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.puppetDBSDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.relabelings + +"RelabelConfigs defines how to rewrite the target's labels before scraping.\nPrometheus Operator automatically adds relabelings for a few standard Kubernetes fields.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config" + +### fn spec.relabelings.withAction + +```ts +withAction(action) +``` + +"Action to perform based on the regex matching.\n\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\ + +### fn spec.relabelings.withModulus + +```ts +withModulus(modulus) +``` + +"Modulus to take of the hash of the source label values.\n\n\nOnly applicable when the action is `HashMod`." + +### fn spec.relabelings.withRegex + +```ts +withRegex(regex) +``` + +"Regular expression against which the extracted value is matched." + +### fn spec.relabelings.withReplacement + +```ts +withReplacement(replacement) +``` + +"Replacement value against which a Replace action is performed if the\nregular expression matches.\n\n\nRegex capture groups are available." + +### fn spec.relabelings.withSeparator + +```ts +withSeparator(separator) +``` + +"Separator is the string between concatenated SourceLabels." + +### fn spec.relabelings.withSourceLabels + +```ts +withSourceLabels(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +### fn spec.relabelings.withSourceLabelsMixin + +```ts +withSourceLabelsMixin(sourceLabels) +``` + +"The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression." + +**Note:** This function appends passed data to existing values + +### fn spec.relabelings.withTargetLabel + +```ts +withTargetLabel(targetLabel) +``` + +"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\n\nRegex capture groups are available." + +## obj spec.scalewaySDConfigs + +"ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations." + +### fn spec.scalewaySDConfigs.withAccessKey + +```ts +withAccessKey(accessKey) +``` + +"Access key to use. https://console.scaleway.com/project/credentials" + +### fn spec.scalewaySDConfigs.withApiURL + +```ts +withApiURL(apiURL) +``` + +"API URL to use when doing the server listing requests." + +### fn spec.scalewaySDConfigs.withEnableHTTP2 + +```ts +withEnableHTTP2(enableHTTP2) +``` + +"Whether to enable HTTP2." + +### fn spec.scalewaySDConfigs.withFollowRedirects + +```ts +withFollowRedirects(followRedirects) +``` + +"Configure whether HTTP requests follow HTTP 3xx redirects." + +### fn spec.scalewaySDConfigs.withNameFilter + +```ts +withNameFilter(nameFilter) +``` + +"NameFilter specify a name filter (works as a LIKE) to apply on the server listing request." + +### fn spec.scalewaySDConfigs.withNoProxy + +```ts +withNoProxy(noProxy) +``` + +"`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.scalewaySDConfigs.withPort + +```ts +withPort(port) +``` + +"The port to scrape metrics from." + +### fn spec.scalewaySDConfigs.withProjectID + +```ts +withProjectID(projectID) +``` + +"Project ID of the targets." + +### fn spec.scalewaySDConfigs.withProxyConnectHeader + +```ts +withProxyConnectHeader(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.scalewaySDConfigs.withProxyConnectHeaderMixin + +```ts +withProxyConnectHeaderMixin(proxyConnectHeader) +``` + +"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0." + +**Note:** This function appends passed data to existing values + +### fn spec.scalewaySDConfigs.withProxyFromEnvironment + +```ts +withProxyFromEnvironment(proxyFromEnvironment) +``` + +"Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\nIf unset, Prometheus uses its default value.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.scalewaySDConfigs.withProxyUrl + +```ts +withProxyUrl(proxyUrl) +``` + +"`proxyURL` defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0." + +### fn spec.scalewaySDConfigs.withRefreshInterval + +```ts +withRefreshInterval(refreshInterval) +``` + +"Refresh interval to re-read the list of instances." + +### fn spec.scalewaySDConfigs.withRole + +```ts +withRole(role) +``` + +"Service of the targets to retrieve. Must be `Instance` or `Baremetal`." + +### fn spec.scalewaySDConfigs.withTagsFilter + +```ts +withTagsFilter(tagsFilter) +``` + +"TagsFilter specify a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request." + +### fn spec.scalewaySDConfigs.withTagsFilterMixin + +```ts +withTagsFilterMixin(tagsFilter) +``` + +"TagsFilter specify a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request." + +**Note:** This function appends passed data to existing values + +### fn spec.scalewaySDConfigs.withZone + +```ts +withZone(zone) +``` + +"Zone is the availability zone of your targets (e.g. fr-par-1)." + +## obj spec.scalewaySDConfigs.secretKey + +"Secret key to use when listing targets." + +### fn spec.scalewaySDConfigs.secretKey.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scalewaySDConfigs.secretKey.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scalewaySDConfigs.secretKey.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.scalewaySDConfigs.tlsConfig + +"TLS configuration to use on every scrape request" + +### fn spec.scalewaySDConfigs.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.scalewaySDConfigs.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.scalewaySDConfigs.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.scalewaySDConfigs.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.scalewaySDConfigs.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.scalewaySDConfigs.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.scalewaySDConfigs.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.scalewaySDConfigs.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scalewaySDConfigs.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.scalewaySDConfigs.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.scalewaySDConfigs.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scalewaySDConfigs.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scalewaySDConfigs.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.scalewaySDConfigs.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.scalewaySDConfigs.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.scalewaySDConfigs.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.scalewaySDConfigs.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scalewaySDConfigs.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.scalewaySDConfigs.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.scalewaySDConfigs.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scalewaySDConfigs.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scalewaySDConfigs.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.scalewaySDConfigs.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.scalewaySDConfigs.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.scalewaySDConfigs.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.scalewaySDConfigs.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.staticConfigs + +"StaticConfigs defines a list of static targets with a common label set." + +### fn spec.staticConfigs.withLabels + +```ts +withLabels(labels) +``` + +"Labels assigned to all metrics scraped from the targets." + +### fn spec.staticConfigs.withLabelsMixin + +```ts +withLabelsMixin(labels) +``` + +"Labels assigned to all metrics scraped from the targets." + +**Note:** This function appends passed data to existing values + +### fn spec.staticConfigs.withTargets + +```ts +withTargets(targets) +``` + +"List of targets for this static configuration." + +### fn spec.staticConfigs.withTargetsMixin + +```ts +withTargetsMixin(targets) +``` + +"List of targets for this static configuration." + +**Note:** This function appends passed data to existing values + +## obj spec.tlsConfig + +"TLS configuration to use on every scrape request" + +### fn spec.tlsConfig.withInsecureSkipVerify + +```ts +withInsecureSkipVerify(insecureSkipVerify) +``` + +"Disable target certificate validation." + +### fn spec.tlsConfig.withMaxVersion + +```ts +withMaxVersion(maxVersion) +``` + +"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0." + +### fn spec.tlsConfig.withMinVersion + +```ts +withMinVersion(minVersion) +``` + +"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0." + +### fn spec.tlsConfig.withServerName + +```ts +withServerName(serverName) +``` + +"Used to verify the hostname for the targets." + +## obj spec.tlsConfig.ca + +"Certificate authority used when verifying server certificates." + +## obj spec.tlsConfig.ca.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.tlsConfig.ca.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.tlsConfig.ca.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.ca.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.tlsConfig.ca.secret + +"Secret containing data to use for the targets." + +### fn spec.tlsConfig.ca.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tlsConfig.ca.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.ca.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.tlsConfig.cert + +"Client certificate to present when doing client-authentication." + +## obj spec.tlsConfig.cert.configMap + +"ConfigMap containing data to use for the targets." + +### fn spec.tlsConfig.cert.configMap.withKey + +```ts +withKey(key) +``` + +"The key to select." + +### fn spec.tlsConfig.cert.configMap.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.cert.configMap.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the ConfigMap or its key must be defined" + +## obj spec.tlsConfig.cert.secret + +"Secret containing data to use for the targets." + +### fn spec.tlsConfig.cert.secret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tlsConfig.cert.secret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.cert.secret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" + +## obj spec.tlsConfig.keySecret + +"Secret containing the client key file for the targets." + +### fn spec.tlsConfig.keySecret.withKey + +```ts +withKey(key) +``` + +"The key of the secret to select from. Must be a valid secret key." + +### fn spec.tlsConfig.keySecret.withName + +```ts +withName(name) +``` + +"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop `kubebuilder:default` when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896." + +### fn spec.tlsConfig.keySecret.withOptional + +```ts +withOptional(optional) +``` + +"Specify whether the Secret or its key must be defined" \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index 85ff9f7..639589e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,3 +8,4 @@ This library is generated with [`k8s`](https://github.com/jsonnet-libs/k8s). - [0.11](0.11/README.md) - [0.12](0.12/README.md) - [0.13](0.13/README.md) +- [0.14](0.14/README.md)