monitoring.v1alpha1.scrapeConfig
"ScrapeConfig defines a namespaced Prometheus scrape_config to be aggregated across\nmultiple namespaces into the Prometheus configuration."
Index
fn new(name)obj metadatafn withAnnotations(annotations)fn withAnnotationsMixin(annotations)fn withClusterName(clusterName)fn withCreationTimestamp(creationTimestamp)fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)fn withDeletionTimestamp(deletionTimestamp)fn withFinalizers(finalizers)fn withFinalizersMixin(finalizers)fn withGenerateName(generateName)fn withGeneration(generation)fn withLabels(labels)fn withLabelsMixin(labels)fn withName(name)fn withNamespace(namespace)fn withOwnerReferences(ownerReferences)fn withOwnerReferencesMixin(ownerReferences)fn withResourceVersion(resourceVersion)fn withSelfLink(selfLink)fn withUid(uid)
obj specfn withAzureSDConfigs(azureSDConfigs)fn withAzureSDConfigsMixin(azureSDConfigs)fn withConsulSDConfigs(consulSDConfigs)fn withConsulSDConfigsMixin(consulSDConfigs)fn withDigitalOceanSDConfigs(digitalOceanSDConfigs)fn withDigitalOceanSDConfigsMixin(digitalOceanSDConfigs)fn withDnsSDConfigs(dnsSDConfigs)fn withDnsSDConfigsMixin(dnsSDConfigs)fn withDockerSDConfigs(dockerSDConfigs)fn withDockerSDConfigsMixin(dockerSDConfigs)fn withDockerSwarmSDConfigs(dockerSwarmSDConfigs)fn withDockerSwarmSDConfigsMixin(dockerSwarmSDConfigs)fn withEc2SDConfigs(ec2SDConfigs)fn withEc2SDConfigsMixin(ec2SDConfigs)fn withEnableCompression(enableCompression)fn withEurekaSDConfigs(eurekaSDConfigs)fn withEurekaSDConfigsMixin(eurekaSDConfigs)fn withFileSDConfigs(fileSDConfigs)fn withFileSDConfigsMixin(fileSDConfigs)fn withGceSDConfigs(gceSDConfigs)fn withGceSDConfigsMixin(gceSDConfigs)fn withHetznerSDConfigs(hetznerSDConfigs)fn withHetznerSDConfigsMixin(hetznerSDConfigs)fn withHonorLabels(honorLabels)fn withHonorTimestamps(honorTimestamps)fn withHttpSDConfigs(httpSDConfigs)fn withHttpSDConfigsMixin(httpSDConfigs)fn withJobName(jobName)fn withKeepDroppedTargets(keepDroppedTargets)fn withKubernetesSDConfigs(kubernetesSDConfigs)fn withKubernetesSDConfigsMixin(kubernetesSDConfigs)fn withKumaSDConfigs(kumaSDConfigs)fn withKumaSDConfigsMixin(kumaSDConfigs)fn withLabelLimit(labelLimit)fn withLabelNameLengthLimit(labelNameLengthLimit)fn withLabelValueLengthLimit(labelValueLengthLimit)fn withLightSailSDConfigs(lightSailSDConfigs)fn withLightSailSDConfigsMixin(lightSailSDConfigs)fn withLinodeSDConfigs(linodeSDConfigs)fn withLinodeSDConfigsMixin(linodeSDConfigs)fn withMetricRelabelings(metricRelabelings)fn withMetricRelabelingsMixin(metricRelabelings)fn withMetricsPath(metricsPath)fn withNoProxy(noProxy)fn withNomadSDConfigs(nomadSDConfigs)fn withNomadSDConfigsMixin(nomadSDConfigs)fn withOpenstackSDConfigs(openstackSDConfigs)fn withOpenstackSDConfigsMixin(openstackSDConfigs)fn withOvhcloudSDConfigs(ovhcloudSDConfigs)fn withOvhcloudSDConfigsMixin(ovhcloudSDConfigs)fn withParams(params)fn withParamsMixin(params)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withPuppetDBSDConfigs(puppetDBSDConfigs)fn withPuppetDBSDConfigsMixin(puppetDBSDConfigs)fn withRelabelings(relabelings)fn withRelabelingsMixin(relabelings)fn withSampleLimit(sampleLimit)fn withScalewaySDConfigs(scalewaySDConfigs)fn withScalewaySDConfigsMixin(scalewaySDConfigs)fn withScheme(scheme)fn withScrapeClass(scrapeClass)fn withScrapeInterval(scrapeInterval)fn withScrapeProtocols(scrapeProtocols)fn withScrapeProtocolsMixin(scrapeProtocols)fn withScrapeTimeout(scrapeTimeout)fn withStaticConfigs(staticConfigs)fn withStaticConfigsMixin(staticConfigs)fn withTargetLimit(targetLimit)fn withTrackTimestampsStaleness(trackTimestampsStaleness)obj spec.authorizationobj spec.azureSDConfigsfn withAuthenticationMethod(authenticationMethod)fn withClientID(clientID)fn withEnvironment(environment)fn withPort(port)fn withRefreshInterval(refreshInterval)fn withResourceGroup(resourceGroup)fn withSubscriptionID(subscriptionID)fn withTenantID(tenantID)obj spec.azureSDConfigs.clientSecret
obj spec.basicAuthobj spec.consulSDConfigsfn withAllowStale(allowStale)fn withDatacenter(datacenter)fn withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn withNamespace(namespace)fn withNoProxy(noProxy)fn withNodeMeta(nodeMeta)fn withNodeMetaMixin(nodeMeta)fn withPartition(partition)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withScheme(scheme)fn withServer(server)fn withServices(services)fn withServicesMixin(services)fn withTagSeparator(tagSeparator)fn withTags(tags)fn withTagsMixin(tags)obj spec.consulSDConfigs.authorizationobj spec.consulSDConfigs.basicAuthobj spec.consulSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.consulSDConfigs.oauth2.clientIdobj spec.consulSDConfigs.oauth2.clientSecretobj spec.consulSDConfigs.oauth2.tlsConfig
obj spec.consulSDConfigs.tlsConfigobj spec.consulSDConfigs.tokenRef
obj spec.digitalOceanSDConfigsfn withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withPort(port)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)obj spec.digitalOceanSDConfigs.authorizationobj spec.digitalOceanSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.digitalOceanSDConfigs.oauth2.clientIdobj spec.digitalOceanSDConfigs.oauth2.clientSecretobj spec.digitalOceanSDConfigs.oauth2.tlsConfig
obj spec.digitalOceanSDConfigs.tlsConfig
obj spec.dnsSDConfigsobj spec.dockerSDConfigsfn withEnableHTTP2(enableHTTP2)fn withFilters(filters)fn withFiltersMixin(filters)fn withFollowRedirects(followRedirects)fn withHost(host)fn withHostNetworkingHost(hostNetworkingHost)fn withNoProxy(noProxy)fn withPort(port)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)obj spec.dockerSDConfigs.authorizationobj spec.dockerSDConfigs.basicAuthobj spec.dockerSDConfigs.filtersobj spec.dockerSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.dockerSDConfigs.oauth2.clientIdobj spec.dockerSDConfigs.oauth2.clientSecretobj spec.dockerSDConfigs.oauth2.tlsConfig
obj spec.dockerSDConfigs.tlsConfig
obj spec.dockerSwarmSDConfigsfn withEnableHTTP2(enableHTTP2)fn withFilters(filters)fn withFiltersMixin(filters)fn withFollowRedirects(followRedirects)fn withHost(host)fn withNoProxy(noProxy)fn withPort(port)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withRole(role)obj spec.dockerSwarmSDConfigs.authorizationobj spec.dockerSwarmSDConfigs.basicAuthobj spec.dockerSwarmSDConfigs.filtersobj spec.dockerSwarmSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.dockerSwarmSDConfigs.oauth2.clientIdobj spec.dockerSwarmSDConfigs.oauth2.clientSecretobj spec.dockerSwarmSDConfigs.oauth2.tlsConfig
obj spec.dockerSwarmSDConfigs.tlsConfig
obj spec.ec2SDConfigsobj spec.eurekaSDConfigsfn withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withServer(server)obj spec.eurekaSDConfigs.authorizationobj spec.eurekaSDConfigs.basicAuthobj spec.eurekaSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.eurekaSDConfigs.oauth2.clientIdobj spec.eurekaSDConfigs.oauth2.clientSecretobj spec.eurekaSDConfigs.oauth2.tlsConfig
obj spec.eurekaSDConfigs.tlsConfig
obj spec.fileSDConfigsobj spec.gceSDConfigsobj spec.hetznerSDConfigsfn withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withPort(port)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withRole(role)obj spec.hetznerSDConfigs.authorizationobj spec.hetznerSDConfigs.basicAuthobj spec.hetznerSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.hetznerSDConfigs.oauth2.clientIdobj spec.hetznerSDConfigs.oauth2.clientSecretobj spec.hetznerSDConfigs.oauth2.tlsConfig
obj spec.hetznerSDConfigs.tlsConfig
obj spec.httpSDConfigsfn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withUrl(url)obj spec.httpSDConfigs.authorizationobj spec.httpSDConfigs.basicAuthobj spec.httpSDConfigs.tlsConfig
obj spec.kubernetesSDConfigsfn withApiServer(apiServer)fn withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRole(role)fn withSelectors(selectors)fn withSelectorsMixin(selectors)obj spec.kubernetesSDConfigs.attachMetadataobj spec.kubernetesSDConfigs.authorizationobj spec.kubernetesSDConfigs.basicAuthobj spec.kubernetesSDConfigs.namespacesobj spec.kubernetesSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.kubernetesSDConfigs.oauth2.clientIdobj spec.kubernetesSDConfigs.oauth2.clientSecretobj spec.kubernetesSDConfigs.oauth2.tlsConfig
obj spec.kubernetesSDConfigs.selectorsobj spec.kubernetesSDConfigs.tlsConfig
obj spec.kumaSDConfigsfn withClientID(clientID)fn withEnableHTTP2(enableHTTP2)fn withFetchTimeout(fetchTimeout)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withServer(server)obj spec.kumaSDConfigs.authorizationobj spec.kumaSDConfigs.basicAuthobj spec.kumaSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.kumaSDConfigs.oauth2.clientIdobj spec.kumaSDConfigs.oauth2.clientSecretobj spec.kumaSDConfigs.oauth2.tlsConfig
obj spec.kumaSDConfigs.tlsConfig
obj spec.lightSailSDConfigsfn withEnableHTTP2(enableHTTP2)fn withEndpoint(endpoint)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withPort(port)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withRegion(region)fn withRoleARN(roleARN)obj spec.lightSailSDConfigs.accessKeyobj spec.lightSailSDConfigs.authorizationobj spec.lightSailSDConfigs.basicAuthobj spec.lightSailSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.lightSailSDConfigs.oauth2.clientIdobj spec.lightSailSDConfigs.oauth2.clientSecretobj spec.lightSailSDConfigs.oauth2.tlsConfig
obj spec.lightSailSDConfigs.secretKeyobj spec.lightSailSDConfigs.tlsConfig
obj spec.linodeSDConfigsfn withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withPort(port)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withRegion(region)fn withTagSeparator(tagSeparator)obj spec.linodeSDConfigs.authorizationobj spec.linodeSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.linodeSDConfigs.oauth2.clientIdobj spec.linodeSDConfigs.oauth2.clientSecretobj spec.linodeSDConfigs.oauth2.tlsConfig
obj spec.linodeSDConfigs.tlsConfig
obj spec.metricRelabelingsobj spec.nomadSDConfigsfn withAllowStale(allowStale)fn withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn withNamespace(namespace)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withRegion(region)fn withServer(server)fn withTagSeparator(tagSeparator)obj spec.nomadSDConfigs.authorizationobj spec.nomadSDConfigs.basicAuthobj spec.nomadSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.nomadSDConfigs.oauth2.clientIdobj spec.nomadSDConfigs.oauth2.clientSecretobj spec.nomadSDConfigs.oauth2.tlsConfig
obj spec.nomadSDConfigs.tlsConfig
obj spec.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.oauth2.clientIdobj spec.oauth2.clientSecretobj spec.oauth2.tlsConfig
obj spec.openstackSDConfigsfn withAllTenants(allTenants)fn withApplicationCredentialId(applicationCredentialId)fn withApplicationCredentialName(applicationCredentialName)fn withAvailability(availability)fn withDomainID(domainID)fn withDomainName(domainName)fn withIdentityEndpoint(identityEndpoint)fn withPort(port)fn withProjectID(projectID)fn withProjectName(projectName)fn withRefreshInterval(refreshInterval)fn withRegion(region)fn withRole(role)fn withUserid(userid)fn withUsername(username)obj spec.openstackSDConfigs.applicationCredentialSecretobj spec.openstackSDConfigs.passwordobj spec.openstackSDConfigs.tlsConfig
obj spec.ovhcloudSDConfigsobj spec.puppetDBSDConfigsfn withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn withIncludeParameters(includeParameters)fn withNoProxy(noProxy)fn withPort(port)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withQuery(query)fn withRefreshInterval(refreshInterval)fn withUrl(url)obj spec.puppetDBSDConfigs.authorizationobj spec.puppetDBSDConfigs.basicAuthobj spec.puppetDBSDConfigs.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.puppetDBSDConfigs.oauth2.clientIdobj spec.puppetDBSDConfigs.oauth2.clientSecretobj spec.puppetDBSDConfigs.oauth2.tlsConfig
obj spec.puppetDBSDConfigs.tlsConfig
obj spec.relabelingsobj spec.scalewaySDConfigsfn withAccessKey(accessKey)fn withApiURL(apiURL)fn withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn withNameFilter(nameFilter)fn withNoProxy(noProxy)fn withPort(port)fn withProjectID(projectID)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withRefreshInterval(refreshInterval)fn withRole(role)fn withTagsFilter(tagsFilter)fn withTagsFilterMixin(tagsFilter)fn withZone(zone)obj spec.scalewaySDConfigs.secretKeyobj spec.scalewaySDConfigs.tlsConfig
obj spec.staticConfigsobj spec.tlsConfig
Fields
fn new
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
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
"ScrapeConfigSpec is a specification of the desired configuration for a scrape configuration."
fn spec.withAzureSDConfigs
withAzureSDConfigs(azureSDConfigs)
"AzureSDConfigs defines a list of Azure service discovery configurations."
fn spec.withAzureSDConfigsMixin
withAzureSDConfigsMixin(azureSDConfigs)
"AzureSDConfigs defines a list of Azure service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withConsulSDConfigs
withConsulSDConfigs(consulSDConfigs)
"ConsulSDConfigs defines a list of Consul service discovery configurations."
fn spec.withConsulSDConfigsMixin
withConsulSDConfigsMixin(consulSDConfigs)
"ConsulSDConfigs defines a list of Consul service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withDigitalOceanSDConfigs
withDigitalOceanSDConfigs(digitalOceanSDConfigs)
"DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations."
fn spec.withDigitalOceanSDConfigsMixin
withDigitalOceanSDConfigsMixin(digitalOceanSDConfigs)
"DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withDnsSDConfigs
withDnsSDConfigs(dnsSDConfigs)
"DNSSDConfigs defines a list of DNS service discovery configurations."
fn spec.withDnsSDConfigsMixin
withDnsSDConfigsMixin(dnsSDConfigs)
"DNSSDConfigs defines a list of DNS service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withDockerSDConfigs
withDockerSDConfigs(dockerSDConfigs)
"DockerSDConfigs defines a list of Docker service discovery configurations."
fn spec.withDockerSDConfigsMixin
withDockerSDConfigsMixin(dockerSDConfigs)
"DockerSDConfigs defines a list of Docker service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withDockerSwarmSDConfigs
withDockerSwarmSDConfigs(dockerSwarmSDConfigs)
"DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations."
fn spec.withDockerSwarmSDConfigsMixin
withDockerSwarmSDConfigsMixin(dockerSwarmSDConfigs)
"DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withEc2SDConfigs
withEc2SDConfigs(ec2SDConfigs)
"EC2SDConfigs defines a list of EC2 service discovery configurations."
fn spec.withEc2SDConfigsMixin
withEc2SDConfigsMixin(ec2SDConfigs)
"EC2SDConfigs defines a list of EC2 service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withEnableCompression
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
withEurekaSDConfigs(eurekaSDConfigs)
"EurekaSDConfigs defines a list of Eureka service discovery configurations."
fn spec.withEurekaSDConfigsMixin
withEurekaSDConfigsMixin(eurekaSDConfigs)
"EurekaSDConfigs defines a list of Eureka service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withFileSDConfigs
withFileSDConfigs(fileSDConfigs)
"FileSDConfigs defines a list of file service discovery configurations."
fn spec.withFileSDConfigsMixin
withFileSDConfigsMixin(fileSDConfigs)
"FileSDConfigs defines a list of file service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withGceSDConfigs
withGceSDConfigs(gceSDConfigs)
"GCESDConfigs defines a list of GCE service discovery configurations."
fn spec.withGceSDConfigsMixin
withGceSDConfigsMixin(gceSDConfigs)
"GCESDConfigs defines a list of GCE service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withHetznerSDConfigs
withHetznerSDConfigs(hetznerSDConfigs)
"HetznerSDConfigs defines a list of Hetzner service discovery configurations."
fn spec.withHetznerSDConfigsMixin
withHetznerSDConfigsMixin(hetznerSDConfigs)
"HetznerSDConfigs defines a list of Hetzner service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withHonorLabels
withHonorLabels(honorLabels)
"HonorLabels chooses the metric's labels on collisions with target labels."
fn spec.withHonorTimestamps
withHonorTimestamps(honorTimestamps)
"HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data."
fn spec.withHttpSDConfigs
withHttpSDConfigs(httpSDConfigs)
"HTTPSDConfigs defines a list of HTTP service discovery configurations."
fn spec.withHttpSDConfigsMixin
withHttpSDConfigsMixin(httpSDConfigs)
"HTTPSDConfigs defines a list of HTTP service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withJobName
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\njob label is set by means of relabeling configs."
fn spec.withKeepDroppedTargets
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
withKubernetesSDConfigs(kubernetesSDConfigs)
"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations."
fn spec.withKubernetesSDConfigsMixin
withKubernetesSDConfigsMixin(kubernetesSDConfigs)
"KubernetesSDConfigs defines a list of Kubernetes service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withKumaSDConfigs
withKumaSDConfigs(kumaSDConfigs)
"KumaSDConfigs defines a list of Kuma service discovery configurations."
fn spec.withKumaSDConfigsMixin
withKumaSDConfigsMixin(kumaSDConfigs)
"KumaSDConfigs defines a list of Kuma service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withLabelLimit
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
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
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
withLightSailSDConfigs(lightSailSDConfigs)
"LightsailSDConfigs defines a list of Lightsail service discovery configurations."
fn spec.withLightSailSDConfigsMixin
withLightSailSDConfigsMixin(lightSailSDConfigs)
"LightsailSDConfigs defines a list of Lightsail service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withLinodeSDConfigs
withLinodeSDConfigs(linodeSDConfigs)
"LinodeSDConfigs defines a list of Linode service discovery configurations."
fn spec.withLinodeSDConfigsMixin
withLinodeSDConfigsMixin(linodeSDConfigs)
"LinodeSDConfigs defines a list of Linode service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withMetricRelabelings
withMetricRelabelings(metricRelabelings)
"MetricRelabelConfigs to apply to samples before ingestion."
fn spec.withMetricRelabelingsMixin
withMetricRelabelingsMixin(metricRelabelings)
"MetricRelabelConfigs to apply to samples before ingestion."
Note: This function appends passed data to existing values
fn spec.withMetricsPath
withMetricsPath(metricsPath)
"MetricsPath HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics)."
fn spec.withNoProxy
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
withNomadSDConfigs(nomadSDConfigs)
"NomadSDConfigs defines a list of Nomad service discovery configurations."
fn spec.withNomadSDConfigsMixin
withNomadSDConfigsMixin(nomadSDConfigs)
"NomadSDConfigs defines a list of Nomad service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withOpenstackSDConfigs
withOpenstackSDConfigs(openstackSDConfigs)
"OpenStackSDConfigs defines a list of OpenStack service discovery configurations."
fn spec.withOpenstackSDConfigsMixin
withOpenstackSDConfigsMixin(openstackSDConfigs)
"OpenStackSDConfigs defines a list of OpenStack service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withOvhcloudSDConfigs
withOvhcloudSDConfigs(ovhcloudSDConfigs)
"OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations."
fn spec.withOvhcloudSDConfigsMixin
withOvhcloudSDConfigsMixin(ovhcloudSDConfigs)
"OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withParams
withParams(params)
"Optional HTTP URL parameters"
fn spec.withParamsMixin
withParamsMixin(params)
"Optional HTTP URL parameters"
Note: This function appends passed data to existing values
fn spec.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.withProxyConnectHeaderMixin
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.withPuppetDBSDConfigs
withPuppetDBSDConfigs(puppetDBSDConfigs)
"PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations."
fn spec.withPuppetDBSDConfigsMixin
withPuppetDBSDConfigsMixin(puppetDBSDConfigs)
"PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withRelabelings
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
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
withSampleLimit(sampleLimit)
"SampleLimit defines per-scrape limit on number of scraped samples that will be accepted."
fn spec.withScalewaySDConfigs
withScalewaySDConfigs(scalewaySDConfigs)
"ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations."
fn spec.withScalewaySDConfigsMixin
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
withScheme(scheme)
"Configures the protocol scheme used for requests.\nIf empty, Prometheus uses HTTP by default."
fn spec.withScrapeClass
withScrapeClass(scrapeClass)
"The scrape class to apply."
fn spec.withScrapeInterval
withScrapeInterval(scrapeInterval)
"ScrapeInterval is the interval between consecutive scrapes."
fn spec.withScrapeProtocols
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
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
withScrapeTimeout(scrapeTimeout)
"ScrapeTimeout is the number of seconds to wait until a scrape request times out."
fn spec.withStaticConfigs
withStaticConfigs(staticConfigs)
"StaticConfigs defines a list of static targets with a common label set."
fn spec.withStaticConfigsMixin
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
withTargetLimit(targetLimit)
"TargetLimit defines a limit on the number of scraped targets that will be accepted."
fn spec.withTrackTimestampsStaleness
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.authorization.credentials.withOptional
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
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
withClientID(clientID)
"Optional client ID. Only required with the OAuth authentication method."
fn spec.azureSDConfigs.withEnvironment
withEnvironment(environment)
"The Azure environment."
fn spec.azureSDConfigs.withPort
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
withRefreshInterval(refreshInterval)
"RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list."
fn spec.azureSDConfigs.withResourceGroup
withResourceGroup(resourceGroup)
"Optional resource group name. Limits discovery to this resource group."
fn spec.azureSDConfigs.withSubscriptionID
withSubscriptionID(subscriptionID)
"The subscription ID. Always required."
fn spec.azureSDConfigs.withTenantID
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.azureSDConfigs.clientSecret.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.basicAuth.username.withOptional
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
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
withDatacenter(datacenter)
"Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter."
fn spec.consulSDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2.\nIf unset, Prometheus uses its default value."
fn spec.consulSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects.\nIf unset, Prometheus uses its default value."
fn spec.consulSDConfigs.withNamespace
withNamespace(namespace)
"Namespaces are only supported in Consul Enterprise."
fn spec.consulSDConfigs.withNoProxy
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
withNodeMeta(nodeMeta)
"Node metadata key/value pairs to filter nodes for a given service."
fn spec.consulSDConfigs.withNodeMetaMixin
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
withPartition(partition)
"Admin Partitions are only supported in Consul Enterprise."
fn spec.consulSDConfigs.withProxyConnectHeader
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.consulSDConfigs.withRefreshInterval
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
withScheme(scheme)
"HTTP Scheme default \"http\
fn spec.consulSDConfigs.withServer
withServer(server)
"A valid string consisting of a hostname or IP followed by an optional port number."
fn spec.consulSDConfigs.withServices
withServices(services)
"A list of services for which targets are retrieved. If omitted, all services are scraped."
fn spec.consulSDConfigs.withServicesMixin
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
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
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
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.consulSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.consulSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.consulSDConfigs.basicAuth.username.withOptional
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.consulSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.consulSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.consulSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.consulSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.consulSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.consulSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.consulSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.consulSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.consulSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.consulSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.consulSDConfigs.tlsConfig
"TLS Config"
fn spec.consulSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.consulSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.consulSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.consulSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.consulSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.consulSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.consulSDConfigs.tokenRef.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.consulSDConfigs.tokenRef.withOptional
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
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.digitalOceanSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.digitalOceanSDConfigs.withNoProxy
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
withPort(port)
"The port to scrape metrics from."
fn spec.digitalOceanSDConfigs.withProxyConnectHeader
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.digitalOceanSDConfigs.withRefreshInterval
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.digitalOceanSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.digitalOceanSDConfigs.authorization.credentials.withOptional
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.digitalOceanSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.digitalOceanSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.digitalOceanSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.digitalOceanSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.digitalOceanSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.digitalOceanSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.digitalOceanSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.digitalOceanSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.digitalOceanSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.digitalOceanSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.digitalOceanSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.digitalOceanSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.digitalOceanSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.digitalOceanSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.digitalOceanSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withNames(names)
"A list of DNS domain names to be queried."
fn spec.dnsSDConfigs.withNamesMixin
withNamesMixin(names)
"A list of DNS domain names to be queried."
Note: This function appends passed data to existing values
fn spec.dnsSDConfigs.withPort
withPort(port)
"The port number used if the query type is not SRV\nIgnored for SRV records"
fn spec.dnsSDConfigs.withRefreshInterval
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
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
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.dockerSDConfigs.withFilters
withFilters(filters)
"Optional filters to limit the discovery process to a subset of the available resources."
fn spec.dockerSDConfigs.withFiltersMixin
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
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.dockerSDConfigs.withHost
withHost(host)
"Address of the docker daemon"
fn spec.dockerSDConfigs.withHostNetworkingHost
withHostNetworkingHost(hostNetworkingHost)
"The host to use if the container is in host networking mode."
fn spec.dockerSDConfigs.withNoProxy
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
withPort(port)
"The port to scrape metrics from."
fn spec.dockerSDConfigs.withProxyConnectHeader
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.dockerSDConfigs.withRefreshInterval
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.dockerSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.dockerSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.dockerSDConfigs.basicAuth.username.withOptional
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
withName(name)
"Name of the Filter."
fn spec.dockerSDConfigs.filters.withValues
withValues(values)
"Value to filter on."
fn spec.dockerSDConfigs.filters.withValuesMixin
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.dockerSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.dockerSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.dockerSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.dockerSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.dockerSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.dockerSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.dockerSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.dockerSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.dockerSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.dockerSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.dockerSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.dockerSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.dockerSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.dockerSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.dockerSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.dockerSwarmSDConfigs.withFilters
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
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
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.dockerSwarmSDConfigs.withHost
withHost(host)
"Address of the Docker daemon"
fn spec.dockerSwarmSDConfigs.withNoProxy
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.dockerSwarmSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"The time after which the service discovery data is refreshed."
fn spec.dockerSwarmSDConfigs.withRole
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.dockerSwarmSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.dockerSwarmSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.dockerSwarmSDConfigs.basicAuth.username.withOptional
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
withName(name)
"Name of the Filter."
fn spec.dockerSwarmSDConfigs.filters.withValues
withValues(values)
"Value to filter on."
fn spec.dockerSwarmSDConfigs.filters.withValuesMixin
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.dockerSwarmSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.dockerSwarmSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.dockerSwarmSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.dockerSwarmSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.dockerSwarmSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.dockerSwarmSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.dockerSwarmSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.dockerSwarmSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.dockerSwarmSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.dockerSwarmSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.dockerSwarmSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
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
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
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
withRefreshInterval(refreshInterval)
"RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list."
fn spec.ec2SDConfigs.withRegion
withRegion(region)
"The AWS region"
fn spec.ec2SDConfigs.withRoleARN
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ec2SDConfigs.accessKey.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.ec2SDConfigs.accessKey.withOptional
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
withName(name)
"Name of the Filter."
fn spec.ec2SDConfigs.filters.withValues
withValues(values)
"Value to filter on."
fn spec.ec2SDConfigs.filters.withValuesMixin
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ec2SDConfigs.secretKey.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.ec2SDConfigs.secretKey.withOptional
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
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.eurekaSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.eurekaSDConfigs.withNoProxy
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.eurekaSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"Refresh interval to re-read the instance list."
fn spec.eurekaSDConfigs.withServer
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.eurekaSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.eurekaSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.eurekaSDConfigs.basicAuth.username.withOptional
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.eurekaSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.eurekaSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.eurekaSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.eurekaSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.eurekaSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.eurekaSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.eurekaSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.eurekaSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.eurekaSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.eurekaSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.eurekaSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
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
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
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
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
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
withProject(project)
"The Google Cloud Project ID"
fn spec.gceSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list."
fn spec.gceSDConfigs.withTagSeparator
withTagSeparator(tagSeparator)
"The tag separator is used to separate the tags on concatenation"
fn spec.gceSDConfigs.withZone
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
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.hetznerSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.hetznerSDConfigs.withNoProxy
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
withPort(port)
"The port to scrape metrics from."
fn spec.hetznerSDConfigs.withProxyConnectHeader
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.hetznerSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"The time after which the servers are refreshed."
fn spec.hetznerSDConfigs.withRole
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.hetznerSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.hetznerSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.hetznerSDConfigs.basicAuth.username.withOptional
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.hetznerSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.hetznerSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.hetznerSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.hetznerSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.hetznerSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.hetznerSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.hetznerSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.hetznerSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.hetznerSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.hetznerSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.hetznerSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.httpSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"RefreshInterval configures the refresh interval at which Prometheus will re-query the\nendpoint to update the target list."
fn spec.httpSDConfigs.withUrl
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.httpSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.httpSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.httpSDConfigs.basicAuth.username.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.httpSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.httpSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.httpSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.httpSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.httpSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
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
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.kubernetesSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.kubernetesSDConfigs.withNoProxy
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.kubernetesSDConfigs.withRole
withRole(role)
"Role of the Kubernetes entities that should be discovered.\nRole Endpointslice requires Prometheus >= v2.21.0"
fn spec.kubernetesSDConfigs.withSelectors
withSelectors(selectors)
"Selector to select objects.\nIt requires Prometheus >= v2.17.0"
fn spec.kubernetesSDConfigs.withSelectorsMixin
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
withNode(node)
"Attaches node metadata to discovered targets.\nWhen set to true, Prometheus must have the get permission on the\nNodes 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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.kubernetesSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.kubernetesSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.kubernetesSDConfigs.basicAuth.username.withOptional
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
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
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
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.kubernetesSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.kubernetesSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.kubernetesSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.kubernetesSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.kubernetesSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
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
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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.kubernetesSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.kubernetesSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.kubernetesSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.kubernetesSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.kubernetesSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kubernetesSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withClientID(clientID)
"Client id is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend."
fn spec.kumaSDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.kumaSDConfigs.withFetchTimeout
withFetchTimeout(fetchTimeout)
"The time after which the monitoring assignments are refreshed."
fn spec.kumaSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.kumaSDConfigs.withNoProxy
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.kumaSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"The time to wait between polling update requests."
fn spec.kumaSDConfigs.withServer
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.kumaSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.kumaSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.kumaSDConfigs.basicAuth.username.withOptional
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.kumaSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.kumaSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.kumaSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.kumaSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.kumaSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.kumaSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.kumaSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.kumaSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.kumaSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.kumaSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.kumaSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.kumaSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.kumaSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.kumaSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.kumaSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.kumaSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withEnableHTTP2(enableHTTP2)
"Configure whether to enable HTTP2."
fn spec.lightSailSDConfigs.withEndpoint
withEndpoint(endpoint)
"Custom endpoint to be used."
fn spec.lightSailSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether the HTTP requests should follow HTTP 3xx redirects."
fn spec.lightSailSDConfigs.withNoProxy
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.lightSailSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"Refresh interval to re-read the list of instances."
fn spec.lightSailSDConfigs.withRegion
withRegion(region)
"The AWS region."
fn spec.lightSailSDConfigs.withRoleARN
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.accessKey.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.lightSailSDConfigs.accessKey.withOptional
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.lightSailSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.lightSailSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.lightSailSDConfigs.basicAuth.username.withOptional
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.lightSailSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.lightSailSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.lightSailSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.lightSailSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.lightSailSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.secretKey.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.lightSailSDConfigs.secretKey.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.lightSailSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.lightSailSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.lightSailSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.lightSailSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.lightSailSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.lightSailSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.linodeSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.linodeSDConfigs.withNoProxy
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
withPort(port)
"Default port to scrape metrics from."
fn spec.linodeSDConfigs.withProxyConnectHeader
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.linodeSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"Time after which the linode instances are refreshed."
fn spec.linodeSDConfigs.withRegion
withRegion(region)
"Optional region to filter on."
fn spec.linodeSDConfigs.withTagSeparator
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.linodeSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.linodeSDConfigs.authorization.credentials.withOptional
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.linodeSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.linodeSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.linodeSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.linodeSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.linodeSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.linodeSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.linodeSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.linodeSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.linodeSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.linodeSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.linodeSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.linodeSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.linodeSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.linodeSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.linodeSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.linodeSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.linodeSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.linodeSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.linodeSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.linodeSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.linodeSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.linodeSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.linodeSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withAction(action)
"Action to perform based on the regex matching.\n\n\nUppercase and Lowercase actions require Prometheus >= v2.36.0.\nDropEqual and KeepEqual actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\
fn spec.metricRelabelings.withModulus
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
withRegex(regex)
"Regular expression against which the extracted value is matched."
fn spec.metricRelabelings.withReplacement
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
withSeparator(separator)
"Separator is the string between concatenated SourceLabels."
fn spec.metricRelabelings.withSourceLabels
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
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
withTargetLabel(targetLabel)
"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for Replace, HashMod, Lowercase, Uppercase,\nKeepEqual 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
withAllowStale(allowStale)
"The information to access the Nomad API. It is to be defined\nas the Nomad documentation requires."
fn spec.nomadSDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.nomadSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.nomadSDConfigs.withNamespace
withNamespace(namespace)
fn spec.nomadSDConfigs.withNoProxy
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.nomadSDConfigs.withRefreshInterval
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
withRegion(region)
fn spec.nomadSDConfigs.withServer
withServer(server)
fn spec.nomadSDConfigs.withTagSeparator
withTagSeparator(tagSeparator)
obj spec.nomadSDConfigs.authorization
"Authorization header to use on every scrape request."
fn spec.nomadSDConfigs.authorization.withType
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.nomadSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.nomadSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.nomadSDConfigs.basicAuth.username.withOptional
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.nomadSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.nomadSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.nomadSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.nomadSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.nomadSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.nomadSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.nomadSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.nomadSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.nomadSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.nomadSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.nomadSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.nomadSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.nomadSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.nomadSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.nomadSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.nomadSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
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
withApplicationCredentialId(applicationCredentialId)
"ApplicationCredentialID"
fn spec.openstackSDConfigs.withApplicationCredentialName
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
withAvailability(availability)
"Availability of the endpoint to connect to."
fn spec.openstackSDConfigs.withDomainID
withDomainID(domainID)
"DomainID"
fn spec.openstackSDConfigs.withDomainName
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
withIdentityEndpoint(identityEndpoint)
"IdentityEndpoint specifies the HTTP endpoint that is required to work with\nthe Identity API of the appropriate version."
fn spec.openstackSDConfigs.withPort
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
withProjectID(projectID)
" ProjectID"
fn spec.openstackSDConfigs.withProjectName
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
withRefreshInterval(refreshInterval)
"Refresh interval to re-read the instance list."
fn spec.openstackSDConfigs.withRegion
withRegion(region)
"The OpenStack Region."
fn spec.openstackSDConfigs.withRole
withRole(role)
"The OpenStack role of entities that should be discovered."
fn spec.openstackSDConfigs.withUserid
withUserid(userid)
"UserID"
fn spec.openstackSDConfigs.withUsername
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.openstackSDConfigs.applicationCredentialSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.openstackSDConfigs.applicationCredentialSecret.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.openstackSDConfigs.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.openstackSDConfigs.password.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.openstackSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.openstackSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.openstackSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.openstackSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.openstackSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.openstackSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.openstackSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.openstackSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withApplicationKey(applicationKey)
"Access key to use. https://api.ovh.com."
fn spec.ovhcloudSDConfigs.withEndpoint
withEndpoint(endpoint)
"Custom endpoint to be used."
fn spec.ovhcloudSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"Refresh interval to re-read the resources list."
fn spec.ovhcloudSDConfigs.withService
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ovhcloudSDConfigs.applicationSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.ovhcloudSDConfigs.applicationSecret.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ovhcloudSDConfigs.consumerKey.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.ovhcloudSDConfigs.consumerKey.withOptional
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
withEnableHTTP2(enableHTTP2)
"Configure whether to enable HTTP2."
fn spec.puppetDBSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether the HTTP requests should follow HTTP 3xx redirects."
fn spec.puppetDBSDConfigs.withIncludeParameters
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
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
withPort(port)
"Port to scrape the metrics from."
fn spec.puppetDBSDConfigs.withProxyConnectHeader
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.puppetDBSDConfigs.withQuery
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
withRefreshInterval(refreshInterval)
"Refresh interval to re-read the list of resources."
fn spec.puppetDBSDConfigs.withUrl
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.puppetDBSDConfigs.authorization.credentials.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.puppetDBSDConfigs.basicAuth.password.withOptional
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.puppetDBSDConfigs.basicAuth.username.withOptional
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
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.puppetDBSDConfigs.oauth2.withEndpointParamsMixin
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
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
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.puppetDBSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.puppetDBSDConfigs.oauth2.withScopesMixin
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
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
withKey(key)
"The key to select."
fn spec.puppetDBSDConfigs.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.puppetDBSDConfigs.oauth2.clientSecret.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.puppetDBSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.puppetDBSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.puppetDBSDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.puppetDBSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.puppetDBSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.puppetDBSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withAction(action)
"Action to perform based on the regex matching.\n\n\nUppercase and Lowercase actions require Prometheus >= v2.36.0.\nDropEqual and KeepEqual actions require Prometheus >= v2.41.0.\n\n\nDefault: \"Replace\
fn spec.relabelings.withModulus
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
withRegex(regex)
"Regular expression against which the extracted value is matched."
fn spec.relabelings.withReplacement
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
withSeparator(separator)
"Separator is the string between concatenated SourceLabels."
fn spec.relabelings.withSourceLabels
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
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
withTargetLabel(targetLabel)
"Label to which the resulting string is written in a replacement.\n\n\nIt is mandatory for Replace, HashMod, Lowercase, Uppercase,\nKeepEqual 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
withAccessKey(accessKey)
"Access key to use. https://console.scaleway.com/project/credentials"
fn spec.scalewaySDConfigs.withApiURL
withApiURL(apiURL)
"API URL to use when doing the server listing requests."
fn spec.scalewaySDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"Whether to enable HTTP2."
fn spec.scalewaySDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"Configure whether HTTP requests follow HTTP 3xx redirects."
fn spec.scalewaySDConfigs.withNameFilter
withNameFilter(nameFilter)
"NameFilter specify a name filter (works as a LIKE) to apply on the server listing request."
fn spec.scalewaySDConfigs.withNoProxy
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
withPort(port)
"The port to scrape metrics from."
fn spec.scalewaySDConfigs.withProjectID
withProjectID(projectID)
"Project ID of the targets."
fn spec.scalewaySDConfigs.withProxyConnectHeader
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
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
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
withProxyUrl(proxyUrl)
"proxyURL defines the HTTP proxy server to use.\n\n\nIt requires Prometheus >= v2.43.0."
fn spec.scalewaySDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"Refresh interval to re-read the list of instances."
fn spec.scalewaySDConfigs.withRole
withRole(role)
"Service of the targets to retrieve. Must be Instance or Baremetal."
fn spec.scalewaySDConfigs.withTagsFilter
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
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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.scalewaySDConfigs.secretKey.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\nTODO: Drop kubebuilder:default when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896."
fn spec.scalewaySDConfigs.secretKey.withOptional
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.scalewaySDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.scalewaySDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.scalewaySDConfigs.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.scalewaySDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.scalewaySDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.scalewaySDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.scalewaySDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.scalewaySDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withLabels(labels)
"Labels assigned to all metrics scraped from the targets."
fn spec.staticConfigs.withLabelsMixin
withLabelsMixin(labels)
"Labels assigned to all metrics scraped from the targets."
Note: This function appends passed data to existing values
fn spec.staticConfigs.withTargets
withTargets(targets)
"List of targets for this static configuration."
fn spec.staticConfigs.withTargetsMixin
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
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"Maximum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.41.0."
fn spec.tlsConfig.withMinVersion
withMinVersion(minVersion)
"Minimum acceptable TLS version.\n\n\nIt requires Prometheus >= v2.35.0."
fn spec.tlsConfig.withServerName
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
withKey(key)
"The key to select."
fn spec.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
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
withKey(key)
"The key to select."
fn spec.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nTODO: Add other useful fields. apiVersion, kind, uid?\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-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
withOptional(optional)
"Specify whether the Secret or its key must be defined"