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 withConvertClassicHistogramsToNHCB(convertClassicHistogramsToNHCB)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 withEnableHTTP2(enableHTTP2)fn withEurekaSDConfigs(eurekaSDConfigs)fn withEurekaSDConfigsMixin(eurekaSDConfigs)fn withFallbackScrapeProtocol(fallbackScrapeProtocol)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 withIonosSDConfigs(ionosSDConfigs)fn withIonosSDConfigsMixin(ionosSDConfigs)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 withNameEscapingScheme(nameEscapingScheme)fn withNameValidationScheme(nameValidationScheme)fn withNativeHistogramBucketLimit(nativeHistogramBucketLimit)fn withNativeHistogramMinBucketFactor(nativeHistogramMinBucketFactor)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 withScrapeClassicHistograms(scrapeClassicHistograms)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 withEnableHTTP2(enableHTTP2)fn withEnvironment(environment)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 withResourceGroup(resourceGroup)fn withSubscriptionID(subscriptionID)fn withTenantID(tenantID)obj spec.azureSDConfigs.authorizationobj spec.azureSDConfigs.basicAuthobj spec.azureSDConfigs.clientSecretobj spec.azureSDConfigs.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.azureSDConfigs.oauth2.clientIdobj spec.azureSDConfigs.oauth2.clientSecretobj spec.azureSDConfigs.oauth2.tlsConfig
obj spec.azureSDConfigs.tlsConfig
obj spec.basicAuthobj spec.consulSDConfigsfn withAllowStale(allowStale)fn withDatacenter(datacenter)fn withEnableHTTP2(enableHTTP2)fn withFilter(filter)fn withFollowRedirects(followRedirects)fn withNamespace(namespace)fn withNoProxy(noProxy)fn withNodeMeta(nodeMeta)fn withNodeMetaMixin(nodeMeta)fn withPartition(partition)fn withPathPrefix(pathPrefix)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 withMatchFirstNetwork(matchFirstNetwork)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.ec2SDConfigsfn withEnableHTTP2(enableHTTP2)fn withFilters(filters)fn withFiltersMixin(filters)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.ec2SDConfigs.accessKeyobj spec.ec2SDConfigs.filtersobj spec.ec2SDConfigs.secretKeyobj spec.ec2SDConfigs.tlsConfig
obj 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 withLabelSelector(labelSelector)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 withEnableHTTP2(enableHTTP2)fn withFollowRedirects(followRedirects)fn 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.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.httpSDConfigs.oauth2.clientIdobj spec.httpSDConfigs.oauth2.clientSecretobj spec.httpSDConfigs.oauth2.tlsConfig
obj spec.httpSDConfigs.tlsConfig
obj spec.ionosSDConfigsfn withDatacenterID(datacenterID)fn 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.ionosSDConfigs.authorizationobj spec.ionosSDConfigs.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.ionosSDConfigs.oauth2.clientIdobj spec.ionosSDConfigs.oauth2.clientSecretobj spec.ionosSDConfigs.oauth2.tlsConfig
obj spec.ionosSDConfigs.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
"spec defines the specification of ScrapeConfigSpec."
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.withConvertClassicHistogramsToNHCB
withConvertClassicHistogramsToNHCB(convertClassicHistogramsToNHCB)
"convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets.\nIt requires Prometheus >= v3.0.0."
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)
"enableCompression when false, Prometheus will request uncompressed response from the scraped target.\n\nIt requires Prometheus >= v2.49.0.\n\nIf unset, Prometheus uses true by default."
fn spec.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"enableHTTP2 defines whether to enable HTTP2."
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.withFallbackScrapeProtocol
withFallbackScrapeProtocol(fallbackScrapeProtocol)
"fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\n\nIt requires Prometheus >= v3.0.0."
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 defines when true the metric's labels when they collide\nwith the target's labels."
fn spec.withHonorTimestamps
withHonorTimestamps(honorTimestamps)
"honorTimestamps defines whether Prometheus preserves the timestamps\nwhen exposed by the target."
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.withIonosSDConfigs
withIonosSDConfigs(ionosSDConfigs)
"ionosSDConfigs defines a list of IONOS service discovery configurations."
fn spec.withIonosSDConfigsMixin
withIonosSDConfigsMixin(ionosSDConfigs)
"ionosSDConfigs defines a list of IONOS service discovery configurations."
Note: This function appends passed data to existing values
fn spec.withJobName
withJobName(jobName)
"jobName defines the value of the job label assigned to the scraped metrics by default.\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)
"keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\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)
"labelLimit defines the 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)
"labelNameLengthLimit defines the 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)
"labelValueLengthLimit defines the 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)
"metricRelabelings defines the metricRelabelings to apply to samples before ingestion."
fn spec.withMetricRelabelingsMixin
withMetricRelabelingsMixin(metricRelabelings)
"metricRelabelings defines the metricRelabelings to apply to samples before ingestion."
Note: This function appends passed data to existing values
fn spec.withMetricsPath
withMetricsPath(metricsPath)
"metricsPath defines the HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics)."
fn spec.withNameEscapingScheme
withNameEscapingScheme(nameEscapingScheme)
"nameEscapingScheme defines the metric name escaping mode to request through content negotiation.\n\nIt requires Prometheus >= v3.4.0."
fn spec.withNameValidationScheme
withNameValidationScheme(nameValidationScheme)
"nameValidationScheme defines the validation scheme for metric and label names.\n\nIt requires Prometheus >= v3.0.0."
fn spec.withNativeHistogramBucketLimit
withNativeHistogramBucketLimit(nativeHistogramBucketLimit)
"nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram,\nbuckets will be merged to stay within the limit.\nIt requires Prometheus >= v2.45.0."
fn spec.withNativeHistogramMinBucketFactor
withNativeHistogramMinBucketFactor(nativeHistogramMinBucketFactor)
"nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this,\nbuckets will be merged to increase the factor sufficiently.\nIt requires Prometheus >= v2.50.0."
fn spec.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.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)
"params defines optional HTTP URL parameters"
fn spec.withParamsMixin
withParamsMixin(params)
"params defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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)
"relabelings 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)
"relabelings 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)
"scheme defines the protocol scheme used for requests.\nIf empty, Prometheus uses HTTP by default."
fn spec.withScrapeClass
withScrapeClass(scrapeClass)
"scrapeClass defines the scrape class to apply."
fn spec.withScrapeClassicHistograms
withScrapeClassicHistograms(scrapeClassicHistograms)
"scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.\nIt requires Prometheus >= v2.45.0.\n\nNotice: scrapeClassicHistograms corresponds to the always_scrape_classic_histograms field in the Prometheus configuration."
fn spec.withScrapeInterval
withScrapeInterval(scrapeInterval)
"scrapeInterval defines the interval between consecutive scrapes."
fn spec.withScrapeProtocols
withScrapeProtocols(scrapeProtocols)
"scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0."
fn spec.withScrapeProtocolsMixin
withScrapeProtocolsMixin(scrapeProtocols)
"scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0."
Note: This function appends passed data to existing values
fn spec.withScrapeTimeout
withScrapeTimeout(scrapeTimeout)
"scrapeTimeout defines the number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource."
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 defines 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 defines the header to use on every scrape request."
fn spec.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"authenticationMethod defines 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)
"clientID defines client ID. Only required with the OAuth authentication method."
fn spec.azureSDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.azureSDConfigs.withEnvironment
withEnvironment(environment)
"environment defines the Azure environment."
fn spec.azureSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.azureSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.azureSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule."
fn spec.azureSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.azureSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.azureSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.azureSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.azureSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.azureSDConfigs.withResourceGroup
withResourceGroup(resourceGroup)
"resourceGroup defines resource group name. Limits discovery to this resource group.\nRequires Prometheus v2.35.0 and above"
fn spec.azureSDConfigs.withSubscriptionID
withSubscriptionID(subscriptionID)
"subscriptionID defines subscription ID. Always required."
fn spec.azureSDConfigs.withTenantID
withTenantID(tenantID)
"tenantID defines tenant ID. Only required with the OAuth authentication method."
obj spec.azureSDConfigs.authorization
"authorization defines the authorization header configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as oAuth2, or basicAuth."
fn spec.azureSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.azureSDConfigs.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
fn spec.azureSDConfigs.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.basicAuth
"basicAuth defines the information to authenticate against the target HTTP endpoint.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints\nCannot be set at the same time as authorization, or oAuth2."
obj spec.azureSDConfigs.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
fn spec.azureSDConfigs.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.basicAuth.username
"username defines a key of a Secret containing the username for\nauthentication."
fn spec.azureSDConfigs.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.clientSecret
"clientSecret defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.oauth2
"oauth2 defines the configuration to use on every scrape request."
fn spec.azureSDConfigs.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.azureSDConfigs.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.azureSDConfigs.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.azureSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.azureSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.azureSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.azureSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.azureSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.azureSDConfigs.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.azureSDConfigs.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.azureSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.azureSDConfigs.oauth2.clientId.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.azureSDConfigs.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.azureSDConfigs.oauth2.clientId.secret
"secret defines the Secret containing data to use for the targets."
fn spec.azureSDConfigs.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.oauth2.clientSecret
"clientSecret defines a key of a Secret containing the OAuth2\nclient's secret."
fn spec.azureSDConfigs.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.azureSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.azureSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.azureSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.azureSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.azureSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.azureSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.azureSDConfigs.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.azureSDConfigs.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.azureSDConfigs.oauth2.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.azureSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.azureSDConfigs.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.azureSDConfigs.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.azureSDConfigs.oauth2.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.azureSDConfigs.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.tlsConfig
"tlsConfig defies the TLS configuration applying to the target HTTP endpoint."
fn spec.azureSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.azureSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.azureSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.azureSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.azureSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.azureSDConfigs.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.azureSDConfigs.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.azureSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.azureSDConfigs.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.azureSDConfigs.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.azureSDConfigs.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.azureSDConfigs.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.azureSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.azureSDConfigs.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.azureSDConfigs.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.azureSDConfigs.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.azureSDConfigs.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.azureSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.azureSDConfigs.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.basicAuth
"basicAuth defines information to use on every scrape request."
obj spec.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"allowStale 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)
"datacenter defines the consul Datacenter name, if not provided it will use the local Consul Agent Datacenter."
fn spec.consulSDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.consulSDConfigs.withFilter
withFilter(filter)
"filter defines the filter expression used to filter the catalog results.\nSee https://www.consul.io/api-docs/catalog#list-services\nIt requires Prometheus >= 3.0.0."
fn spec.consulSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.consulSDConfigs.withNamespace
withNamespace(namespace)
"namespace are only supported in Consul Enterprise.\n\nIt requires Prometheus >= 2.28.0."
fn spec.consulSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.consulSDConfigs.withNodeMeta
withNodeMeta(nodeMeta)
"nodeMeta defines the node metadata key/value pairs to filter nodes for a given service.\nStarting with Consul 1.14, it is recommended to use filter with the NodeMeta selector instead."
fn spec.consulSDConfigs.withNodeMetaMixin
withNodeMetaMixin(nodeMeta)
"nodeMeta defines the node metadata key/value pairs to filter nodes for a given service.\nStarting with Consul 1.14, it is recommended to use filter with the NodeMeta selector instead."
Note: This function appends passed data to existing values
fn spec.consulSDConfigs.withPartition
withPartition(partition)
"partition defines the admin Partitions are only supported in Consul Enterprise."
fn spec.consulSDConfigs.withPathPrefix
withPathPrefix(pathPrefix)
"pathPrefix defines the prefix for URIs for when consul is behind an API gateway (reverse proxy).\n\nIt requires Prometheus >= 2.45.0."
fn spec.consulSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.consulSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.consulSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.consulSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.consulSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.consulSDConfigs.withScheme
withScheme(scheme)
"scheme defines the HTTP Scheme default \"http\
fn spec.consulSDConfigs.withServer
withServer(server)
"server defines the consul server address. A valid string consisting of a hostname or IP followed by an optional port number."
fn spec.consulSDConfigs.withServices
withServices(services)
"services defines a list of services for which targets are retrieved. If omitted, all services are scraped."
fn spec.consulSDConfigs.withServicesMixin
withServicesMixin(services)
"services defines 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)
"tagSeparator defines 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)
"tags defines an optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.\nStarting with Consul 1.14, it is recommended to use filter with the ServiceTags selector instead."
fn spec.consulSDConfigs.withTagsMixin
withTagsMixin(tags)
"tags defines an optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.\nStarting with Consul 1.14, it is recommended to use filter with the ServiceTags selector instead."
Note: This function appends passed data to existing values
obj spec.consulSDConfigs.authorization
"authorization defines the header configuration to authenticate against the Consul Server.\nCannot be set at the same time as basicAuth, or oauth2."
fn spec.consulSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.consulSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.consulSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.consulSDConfigs.basicAuth
"basicAuth defines the information to authenticate against the Consul Server.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints\nCannot be set at the same time as authorization, or oauth2."
obj spec.consulSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.consulSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.consulSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.consulSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.consulSDConfigs.oauth2
"oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as authorization, or basicAuth."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.consulSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.consulSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.consulSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.consulSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.consulSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.consulSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.consulSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.consulSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.consulSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.consulSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.consulSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.consulSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.consulSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.consulSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.consulSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.consulSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.consulSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.consulSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.consulSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.consulSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.consulSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.consulSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.consulSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.consulSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.consulSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.consulSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.consulSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.consulSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.consulSDConfigs.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.consulSDConfigs.tokenRef
"tokenRef defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.digitalOceanSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.digitalOceanSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.digitalOceanSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must"
fn spec.digitalOceanSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.digitalOceanSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.digitalOceanSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.digitalOceanSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.digitalOceanSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
obj spec.digitalOceanSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.digitalOceanSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.digitalOceanSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.digitalOceanSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.digitalOceanSDConfigs.oauth2
"oauth2 defines the configuration to use on every scrape request."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.digitalOceanSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.digitalOceanSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.digitalOceanSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.digitalOceanSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.digitalOceanSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.digitalOceanSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.digitalOceanSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.digitalOceanSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.digitalOceanSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.digitalOceanSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.digitalOceanSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.digitalOceanSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.digitalOceanSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.digitalOceanSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.digitalOceanSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.digitalOceanSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.digitalOceanSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.digitalOceanSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.digitalOceanSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.digitalOceanSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.digitalOceanSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.digitalOceanSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"names defines a list of DNS domain names to be queried."
fn spec.dnsSDConfigs.withNamesMixin
withNamesMixin(names)
"names defines a list of DNS domain names to be queried."
Note: This function appends passed data to existing values
fn spec.dnsSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must\nIgnored for SRV records"
fn spec.dnsSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.dnsSDConfigs.withType
withType(type)
"type defines the type of DNS query to perform. One of SRV, A, AAAA, MX or NS.\nIf not set, Prometheus uses its default value.\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)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.dockerSDConfigs.withFilters
withFilters(filters)
"filters defines filters to limit the discovery process to a subset of the available resources."
fn spec.dockerSDConfigs.withFiltersMixin
withFiltersMixin(filters)
"filters defines 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)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.dockerSDConfigs.withHost
withHost(host)
"host defines the address of the docker daemon"
fn spec.dockerSDConfigs.withHostNetworkingHost
withHostNetworkingHost(hostNetworkingHost)
"hostNetworkingHost defines the host to use if the container is in host networking mode."
fn spec.dockerSDConfigs.withMatchFirstNetwork
withMatchFirstNetwork(matchFirstNetwork)
"matchFirstNetwork defines whether to match the first network if the container has multiple networks defined.\nIf unset, Prometheus uses true by default.\nIt requires Prometheus >= v2.54.1."
fn spec.dockerSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must"
fn spec.dockerSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.dockerSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.dockerSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
obj spec.dockerSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.dockerSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.dockerSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSDConfigs.basicAuth
"basicAuth defines information to use on every scrape request."
obj spec.dockerSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSDConfigs.filters
"filters defines 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)
"values defines values to filter on."
fn spec.dockerSDConfigs.filters.withValuesMixin
withValuesMixin(values)
"values defines values to filter on."
Note: This function appends passed data to existing values
obj spec.dockerSDConfigs.oauth2
"oauth2 defines the configuration to use on every scrape request."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.dockerSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.dockerSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.dockerSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.dockerSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.dockerSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.dockerSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.dockerSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.dockerSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.dockerSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.dockerSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.dockerSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.dockerSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.dockerSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.dockerSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.dockerSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.dockerSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.dockerSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.dockerSwarmSDConfigs.withFilters
withFilters(filters)
"filters defines the 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)
"filters defines the 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)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.dockerSwarmSDConfigs.withHost
withHost(host)
"host defines the address of the Docker daemon"
fn spec.dockerSwarmSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSwarmSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must\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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSwarmSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.dockerSwarmSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSwarmSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.dockerSwarmSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.dockerSwarmSDConfigs.withRole
withRole(role)
"role of the targets to retrieve. Must be Services, Tasks, or Nodes."
obj spec.dockerSwarmSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.dockerSwarmSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.dockerSwarmSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSwarmSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSwarmSDConfigs.basicAuth
"basicAuth defines information to use on every scrape request."
obj spec.dockerSwarmSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSwarmSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSwarmSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSwarmSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSwarmSDConfigs.filters
"filters defines the 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)
"values defines values to filter on."
fn spec.dockerSwarmSDConfigs.filters.withValuesMixin
withValuesMixin(values)
"values defines values to filter on."
Note: This function appends passed data to existing values
obj spec.dockerSwarmSDConfigs.oauth2
"oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSwarmSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSwarmSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.dockerSwarmSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.dockerSwarmSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.dockerSwarmSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.dockerSwarmSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSwarmSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.dockerSwarmSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSwarmSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSwarmSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.dockerSwarmSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.dockerSwarmSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.dockerSwarmSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.dockerSwarmSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.dockerSwarmSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.dockerSwarmSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSwarmSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSwarmSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.dockerSwarmSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.dockerSwarmSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.dockerSwarmSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"enableHTTP2 defines whether to enable HTTP2.\nIt requires Prometheus >= v2.41.0"
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\nIt requires Prometheus >= v2.3.0"
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\nIt requires Prometheus >= v2.3.0"
Note: This function appends passed data to existing values
fn spec.ec2SDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nIt requires Prometheus >= v2.41.0"
fn spec.ec2SDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.ec2SDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule."
fn spec.ec2SDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.ec2SDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.ec2SDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.ec2SDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.ec2SDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.ec2SDConfigs.withRegion
withRegion(region)
"region defines the AWS region."
fn spec.ec2SDConfigs.withRoleARN
withRoleARN(roleARN)
"roleARN defines an alternative to using AWS API keys."
obj spec.ec2SDConfigs.accessKey
"accessKey defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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\nIt requires Prometheus >= v2.3.0"
fn spec.ec2SDConfigs.filters.withName
withName(name)
"name of the Filter."
fn spec.ec2SDConfigs.filters.withValues
withValues(values)
"values defines values to filter on."
fn spec.ec2SDConfigs.filters.withValuesMixin
withValuesMixin(values)
"values defines values to filter on."
Note: This function appends passed data to existing values
obj spec.ec2SDConfigs.secretKey
"secretKey defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ec2SDConfigs.secretKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ec2SDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API.\nIt requires Prometheus >= v2.41.0"
fn spec.ec2SDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.ec2SDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.ec2SDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.ec2SDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.ec2SDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.ec2SDConfigs.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.ec2SDConfigs.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.ec2SDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ec2SDConfigs.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.ec2SDConfigs.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.ec2SDConfigs.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ec2SDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ec2SDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ec2SDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.ec2SDConfigs.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.ec2SDConfigs.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.ec2SDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ec2SDConfigs.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.ec2SDConfigs.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.ec2SDConfigs.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ec2SDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ec2SDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ec2SDConfigs.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.ec2SDConfigs.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ec2SDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ec2SDConfigs.tlsConfig.keySecret.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)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.eurekaSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.eurekaSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.eurekaSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.eurekaSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.eurekaSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.eurekaSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.eurekaSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.eurekaSDConfigs.withServer
withServer(server)
"server defines the URL to connect to the Eureka server."
obj spec.eurekaSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.eurekaSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.eurekaSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.eurekaSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.eurekaSDConfigs.basicAuth
"basicAuth defines the BasicAuth information to use on every scrape request."
obj spec.eurekaSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.eurekaSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.eurekaSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.eurekaSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.eurekaSDConfigs.oauth2
"oauth2 defines the configuration to use on every scrape request."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.eurekaSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.eurekaSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.eurekaSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.eurekaSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.eurekaSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.eurekaSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.eurekaSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.eurekaSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.eurekaSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.eurekaSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.eurekaSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.eurekaSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.eurekaSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.eurekaSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.eurekaSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.eurekaSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.eurekaSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.eurekaSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.eurekaSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.eurekaSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.eurekaSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.eurekaSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.eurekaSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.eurekaSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.eurekaSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"files defines the 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)
"files defines the 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 defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
obj spec.gceSDConfigs
"gceSDConfigs defines a list of GCE service discovery configurations."
fn spec.gceSDConfigs.withFilter
withFilter(filter)
"filter defines the filter that 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)
"port defines 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)
"project defines the Google Cloud Project ID"
fn spec.gceSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.gceSDConfigs.withTagSeparator
withTagSeparator(tagSeparator)
"tagSeparator defines the tag separator is used to separate the tags on concatenation"
fn spec.gceSDConfigs.withZone
withZone(zone)
"zone defines 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)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.hetznerSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.hetznerSDConfigs.withLabelSelector
withLabelSelector(labelSelector)
"labelSelector defines the label selector used to filter the servers when fetching them from the API.\nIt requires Prometheus >= v3.5.0."
fn spec.hetznerSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.hetznerSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must"
fn spec.hetznerSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.hetznerSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.hetznerSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.hetznerSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.hetznerSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.hetznerSDConfigs.withRole
withRole(role)
"role defines the Hetzner role of entities that should be discovered."
obj spec.hetznerSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.hetznerSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.hetznerSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.hetznerSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.hetznerSDConfigs.basicAuth
"basicAuth defines information to use on every scrape request."
obj spec.hetznerSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.hetznerSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.hetznerSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.hetznerSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.hetznerSDConfigs.oauth2
"oauth2 defines the configuration to use on every scrape request."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.hetznerSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.hetznerSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.hetznerSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.hetznerSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.hetznerSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.hetznerSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.hetznerSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.hetznerSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.hetznerSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.hetznerSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.hetznerSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.hetznerSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.hetznerSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.hetznerSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.hetznerSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.hetznerSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.hetznerSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.hetznerSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.hetznerSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.hetznerSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.hetznerSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.hetznerSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.hetznerSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.hetznerSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.hetznerSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.httpSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.httpSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.httpSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.httpSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.httpSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.httpSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.httpSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.httpSDConfigs.withUrl
withUrl(url)
"url defines the URL from which the targets are fetched."
obj spec.httpSDConfigs.authorization
"authorization defines the authorization header configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as oAuth2, or basicAuth."
fn spec.httpSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.httpSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.basicAuth
"basicAuth defines information to use on every scrape request.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints\nCannot be set at the same time as authorization, or oAuth2."
obj spec.httpSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.oauth2
"oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as authorization, or basicAuth."
fn spec.httpSDConfigs.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.httpSDConfigs.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.httpSDConfigs.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.httpSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.httpSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.httpSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.httpSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.httpSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.httpSDConfigs.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.httpSDConfigs.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.httpSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.httpSDConfigs.oauth2.clientId.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.httpSDConfigs.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.httpSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.httpSDConfigs.oauth2.clientId.secret
"secret defines the Secret containing data to use for the targets."
fn spec.httpSDConfigs.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.oauth2.clientSecret
"clientSecret defines a key of a Secret containing the OAuth2\nclient's secret."
fn spec.httpSDConfigs.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.httpSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.httpSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.httpSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.httpSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.httpSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.httpSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.httpSDConfigs.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.httpSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.httpSDConfigs.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.httpSDConfigs.oauth2.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.httpSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.httpSDConfigs.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.httpSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.httpSDConfigs.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.httpSDConfigs.oauth2.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.httpSDConfigs.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.httpSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration applying to the target HTTP endpoint."
fn spec.httpSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.httpSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.httpSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.httpSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.httpSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.httpSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.httpSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.httpSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.httpSDConfigs.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ionosSDConfigs
"ionosSDConfigs defines a list of IONOS service discovery configurations."
fn spec.ionosSDConfigs.withDatacenterID
withDatacenterID(datacenterID)
"datacenterID defines the unique ID of the IONOS data center."
fn spec.ionosSDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.ionosSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.ionosSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.ionosSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must"
fn spec.ionosSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.ionosSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.ionosSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.ionosSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.ionosSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
obj spec.ionosSDConfigs.authorization
"authorization defines the header configuration to authenticate against the IONOS.\nCannot be set at the same time as oauth2."
fn spec.ionosSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.ionosSDConfigs.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
fn spec.ionosSDConfigs.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ionosSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ionosSDConfigs.oauth2
"oauth2 defines the configuration to use on every scrape request."
fn spec.ionosSDConfigs.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.ionosSDConfigs.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.ionosSDConfigs.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.ionosSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.ionosSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.ionosSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.ionosSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.ionosSDConfigs.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.ionosSDConfigs.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.ionosSDConfigs.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.ionosSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.ionosSDConfigs.oauth2.clientId.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.ionosSDConfigs.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.ionosSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.ionosSDConfigs.oauth2.clientId.secret
"secret defines the Secret containing data to use for the targets."
fn spec.ionosSDConfigs.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ionosSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ionosSDConfigs.oauth2.clientSecret
"clientSecret defines a key of a Secret containing the OAuth2\nclient's secret."
fn spec.ionosSDConfigs.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ionosSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ionosSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.ionosSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.ionosSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.ionosSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.ionosSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.ionosSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.ionosSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.ionosSDConfigs.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.ionosSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.ionosSDConfigs.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.ionosSDConfigs.oauth2.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ionosSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ionosSDConfigs.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.ionosSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.ionosSDConfigs.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.ionosSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.ionosSDConfigs.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.ionosSDConfigs.oauth2.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ionosSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ionosSDConfigs.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.ionosSDConfigs.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ionosSDConfigs.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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ionosSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.ionosSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.ionosSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.ionosSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.ionosSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.ionosSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.ionosSDConfigs.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.ionosSDConfigs.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.ionosSDConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.ionosSDConfigs.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.ionosSDConfigs.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ionosSDConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ionosSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.ionosSDConfigs.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.ionosSDConfigs.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.ionosSDConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.ionosSDConfigs.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.ionosSDConfigs.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ionosSDConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ionosSDConfigs.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.ionosSDConfigs.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.ionosSDConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ionosSDConfigs.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)
"apiServer defines 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)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.kubernetesSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.kubernetesSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kubernetesSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kubernetesSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.kubernetesSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kubernetesSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.kubernetesSDConfigs.withRole
withRole(role)
"role defines the Kubernetes role of the entities that should be discovered.\nRole Endpointslice requires Prometheus >= v2.21.0"
fn spec.kubernetesSDConfigs.withSelectors
withSelectors(selectors)
"selectors defines the selector to select objects.\nIt requires Prometheus >= v2.17.0"
fn spec.kubernetesSDConfigs.withSelectorsMixin
withSelectorsMixin(selectors)
"selectors defines the selector to select objects.\nIt requires Prometheus >= v2.17.0"
Note: This function appends passed data to existing values
obj spec.kubernetesSDConfigs.attachMetadata
"attachMetadata defines the 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)
"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 defines the 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)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.kubernetesSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kubernetesSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kubernetesSDConfigs.basicAuth
"basicAuth defines information to use on every scrape request.\nCannot be set at the same time as authorization, or oauth2."
obj spec.kubernetesSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kubernetesSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kubernetesSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kubernetesSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kubernetesSDConfigs.namespaces
"namespaces defines the namespace discovery. If omitted, Prometheus discovers targets across all namespaces."
fn spec.kubernetesSDConfigs.namespaces.withNames
withNames(names)
"names defines a 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)
"names defines a 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)
"ownNamespace includes the namespace in which the Prometheus pod runs to the list of watched namespaces."
obj spec.kubernetesSDConfigs.oauth2
"oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kubernetesSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kubernetesSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.kubernetesSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kubernetesSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.kubernetesSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.kubernetesSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kubernetesSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kubernetesSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.kubernetesSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.kubernetesSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.kubernetesSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kubernetesSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kubernetesSDConfigs.selectors
"selectors defines the selector to select objects.\nIt requires Prometheus >= v2.17.0"
fn spec.kubernetesSDConfigs.selectors.withField
withField(field)
"field defines 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)
"label defines 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 defines the type of Kubernetes resource to limit the service discovery to.\nAccepted values are: Node, Pod, Endpoints, EndpointSlice, Service, Ingress."
obj spec.kubernetesSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Kubernetes API."
fn spec.kubernetesSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.kubernetesSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.kubernetesSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.kubernetesSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.kubernetesSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.kubernetesSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kubernetesSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kubernetesSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.kubernetesSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kubernetesSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kubernetesSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"clientID is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend.\nIt requires Prometheus >= v2.50.0."
fn spec.kumaSDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.kumaSDConfigs.withFetchTimeout
withFetchTimeout(fetchTimeout)
"fetchTimeout defines the time after which the monitoring assignments are refreshed."
fn spec.kumaSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.kumaSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kumaSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kumaSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.kumaSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kumaSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.kumaSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.kumaSDConfigs.withServer
withServer(server)
"server defines the address of the Kuma Control Plane's MADS xDS server."
obj spec.kumaSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.kumaSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.kumaSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kumaSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kumaSDConfigs.basicAuth
"basicAuth defines information to use on every scrape request."
obj spec.kumaSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kumaSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kumaSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kumaSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kumaSDConfigs.oauth2
"oauth2 defines the configuration to use on every scrape request."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kumaSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kumaSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.kumaSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.kumaSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.kumaSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.kumaSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kumaSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kumaSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.kumaSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.kumaSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.kumaSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.kumaSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.kumaSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.kumaSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.kumaSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kumaSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kumaSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.kumaSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.kumaSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.kumaSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.kumaSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.kumaSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.kumaSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kumaSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kumaSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.kumaSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.kumaSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.kumaSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.lightSailSDConfigs.withEndpoint
withEndpoint(endpoint)
"endpoint defines the custom endpoint to be used."
fn spec.lightSailSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.lightSailSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.lightSailSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must"
fn spec.lightSailSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.lightSailSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.lightSailSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.lightSailSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.lightSailSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.lightSailSDConfigs.withRegion
withRegion(region)
"region defines the AWS region."
fn spec.lightSailSDConfigs.withRoleARN
withRoleARN(roleARN)
"roleARN defines the AWS Role ARN, an alternative to using AWS API keys."
obj spec.lightSailSDConfigs.accessKey
"accessKey defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.lightSailSDConfigs.accessKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.lightSailSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.lightSailSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.lightSailSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.lightSailSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.lightSailSDConfigs.basicAuth
"basicAuth defines information to use on every scrape request.\nCannot be set at the same time as authorization, or oauth2."
obj spec.lightSailSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.lightSailSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.lightSailSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.lightSailSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.lightSailSDConfigs.oauth2
"oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as authorization, or basicAuth."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.lightSailSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.lightSailSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.lightSailSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.lightSailSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.lightSailSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.lightSailSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.lightSailSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.lightSailSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.lightSailSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.lightSailSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.lightSailSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.lightSailSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.lightSailSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.lightSailSDConfigs.secretKey
"secretKey defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.lightSailSDConfigs.secretKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.lightSailSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.lightSailSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.lightSailSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.lightSailSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.lightSailSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.lightSailSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.lightSailSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.lightSailSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.lightSailSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.lightSailSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.lightSailSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.lightSailSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.linodeSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.linodeSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.linodeSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must"
fn spec.linodeSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.linodeSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.linodeSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.linodeSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.linodeSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.linodeSDConfigs.withRegion
withRegion(region)
"region defines the region to filter on."
fn spec.linodeSDConfigs.withTagSeparator
withTagSeparator(tagSeparator)
"tagSeparator defines the string by which Linode Instance tags are joined into the tag label.el."
obj spec.linodeSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.linodeSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.linodeSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.linodeSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.linodeSDConfigs.oauth2
"oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as authorization, or basicAuth."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.linodeSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.linodeSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.linodeSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.linodeSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.linodeSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.linodeSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.linodeSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.linodeSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.linodeSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.linodeSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.linodeSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.linodeSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.linodeSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.linodeSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.linodeSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.linodeSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.linodeSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.linodeSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.linodeSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.linodeSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.linodeSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.linodeSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.linodeSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.linodeSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.linodeSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.linodeSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.linodeSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.linodeSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.linodeSDConfigs.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.metricRelabelings
"metricRelabelings defines the metricRelabelings to apply to samples before ingestion."
fn spec.metricRelabelings.withAction
withAction(action)
"action to perform based on the regex matching.\n\nUppercase and Lowercase actions require Prometheus >= v2.36.0.\nDropEqual and KeepEqual actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\
fn spec.metricRelabelings.withModulus
withModulus(modulus)
"modulus to take of the hash of the source label values.\n\nOnly applicable when the action is HashMod."
fn spec.metricRelabelings.withRegex
withRegex(regex)
"regex defines the 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\nRegex capture groups are available."
fn spec.metricRelabelings.withSeparator
withSeparator(separator)
"separator defines the string between concatenated SourceLabels."
fn spec.metricRelabelings.withSourceLabels
withSourceLabels(sourceLabels)
"sourceLabels defines 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)
"sourceLabels defines 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)
"targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for Replace, HashMod, Lowercase, Uppercase,\nKeepEqual and DropEqual actions.\n\nRegex capture groups are available."
obj spec.nomadSDConfigs
"nomadSDConfigs defines a list of Nomad service discovery configurations."
fn spec.nomadSDConfigs.withAllowStale
withAllowStale(allowStale)
"allowStale defines the information to access the Nomad API. It is to be defined\nas the Nomad documentation requires."
fn spec.nomadSDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.nomadSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.nomadSDConfigs.withNamespace
withNamespace(namespace)
"namespace defines the Nomad namespace to query for service discovery.\nWhen specified, only resources within this namespace will be discovered."
fn spec.nomadSDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.nomadSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.nomadSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.nomadSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.nomadSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.nomadSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.nomadSDConfigs.withRegion
withRegion(region)
"region defines the Nomad region to query for service discovery.\nWhen specified, only resources within this region will be discovered."
fn spec.nomadSDConfigs.withServer
withServer(server)
"server defines the Nomad server address to connect to for service discovery.\nThis should be the full URL including protocol (e.g., \"https://nomad.example.com:4646\")."
fn spec.nomadSDConfigs.withTagSeparator
withTagSeparator(tagSeparator)
"tagSeparator defines the separator used to join multiple tags.\nThis determines how Nomad service tags are concatenated into Prometheus labels."
obj spec.nomadSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.nomadSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.nomadSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.nomadSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.nomadSDConfigs.basicAuth
"basicAuth defines information to use on every scrape request."
obj spec.nomadSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.nomadSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.nomadSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.nomadSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.nomadSDConfigs.oauth2
"oauth2 defines the configuration to use on every scrape request."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.nomadSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.nomadSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.nomadSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.nomadSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.nomadSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.nomadSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.nomadSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.nomadSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.nomadSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.nomadSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.nomadSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.nomadSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.nomadSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.nomadSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.nomadSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.nomadSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.nomadSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.nomadSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.nomadSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.nomadSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.nomadSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.nomadSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.nomadSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.nomadSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.nomadSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.nomadSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.nomadSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.nomadSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.nomadSDConfigs.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.oauth2
"oauth2 defines the configuration to use on every scrape request."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.oauth2.clientId.secret
"secret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.oauth2.clientSecret
"clientSecret defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.oauth2.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"allTenants defines 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 defines the OpenStack applicationCredentialId."
fn spec.openstackSDConfigs.withApplicationCredentialName
withApplicationCredentialName(applicationCredentialName)
"applicationCredentialName defines 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 defines the availability of the endpoint to connect to."
fn spec.openstackSDConfigs.withDomainID
withDomainID(domainID)
"domainID defines The OpenStack domainID."
fn spec.openstackSDConfigs.withDomainName
withDomainName(domainName)
"domainName defines at most one of domainId and domainName that must be provided if using username\nwith Identity V3. Otherwise, either are optional."
fn spec.openstackSDConfigs.withIdentityEndpoint
withIdentityEndpoint(identityEndpoint)
"identityEndpoint defines the HTTP endpoint that is required to work with\nthe Identity API of the appropriate version."
fn spec.openstackSDConfigs.withPort
withPort(port)
"port defines 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 defines the OpenStack projectID."
fn spec.openstackSDConfigs.withProjectName
withProjectName(projectName)
"projectName defines an optional field 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)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.openstackSDConfigs.withRegion
withRegion(region)
"region defines the OpenStack Region."
fn spec.openstackSDConfigs.withRole
withRole(role)
"role defines the OpenStack role of entities that should be discovered.\n\nNote: The LoadBalancer role requires Prometheus >= v3.2.0."
fn spec.openstackSDConfigs.withUserid
withUserid(userid)
"userid defines the OpenStack userid."
fn spec.openstackSDConfigs.withUsername
withUsername(username)
"username defines the username 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
"applicationCredentialSecret defines the required field 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.openstackSDConfigs.applicationCredentialSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.openstackSDConfigs.password
"password defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.openstackSDConfigs.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.openstackSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration applying to the target HTTP endpoint."
fn spec.openstackSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.openstackSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.openstackSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.openstackSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.openstackSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.openstackSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.openstackSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.openstackSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.openstackSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.openstackSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.openstackSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"applicationKey defines the access key to use for OVHCloud API authentication.\nThis is obtained from the OVHCloud API credentials at https://api.ovh.com."
fn spec.ovhcloudSDConfigs.withEndpoint
withEndpoint(endpoint)
"endpoint defines a custom API endpoint to be used.\nWhen not specified, defaults to the standard OVHCloud API endpoint for the region."
fn spec.ovhcloudSDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.ovhcloudSDConfigs.withService
withService(service)
"service defines the service type of the targets to retrieve.\nMust be either VPS or DedicatedServer to specify which OVHCloud resources to discover."
obj spec.ovhcloudSDConfigs.applicationSecret
"applicationSecret defines the secret key for OVHCloud API authentication.\nThis contains the application secret obtained during OVHCloud API credential creation."
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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.ovhcloudSDConfigs.applicationSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.ovhcloudSDConfigs.consumerKey
"consumerKey defines the consumer key for OVHCloud API authentication.\nThis is the third component of OVHCloud's three-key authentication system."
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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.puppetDBSDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.puppetDBSDConfigs.withIncludeParameters
withIncludeParameters(includeParameters)
"includeParameters defines 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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.puppetDBSDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must"
fn spec.puppetDBSDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.puppetDBSDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.puppetDBSDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.puppetDBSDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.puppetDBSDConfigs.withQuery
withQuery(query)
"query defines the 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)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.puppetDBSDConfigs.withUrl
withUrl(url)
"url defines the URL of the PuppetDB root query endpoint."
obj spec.puppetDBSDConfigs.authorization
"authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as oauth2."
fn spec.puppetDBSDConfigs.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.puppetDBSDConfigs.authorization.credentials
"credentials defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.puppetDBSDConfigs.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.puppetDBSDConfigs.basicAuth
"basicAuth defines information to use on every scrape request.\nCannot be set at the same time as authorization, or oauth2."
obj spec.puppetDBSDConfigs.basicAuth.password
"password defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.puppetDBSDConfigs.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.puppetDBSDConfigs.basicAuth.username
"username defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.puppetDBSDConfigs.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.puppetDBSDConfigs.oauth2
"oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as authorization, or basicAuth."
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 defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.puppetDBSDConfigs.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.puppetDBSDConfigs.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.puppetDBSDConfigs.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.puppetDBSDConfigs.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
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 defines the URL to fetch the token from."
obj spec.puppetDBSDConfigs.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.puppetDBSDConfigs.oauth2.clientId.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.puppetDBSDConfigs.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.puppetDBSDConfigs.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.puppetDBSDConfigs.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.puppetDBSDConfigs.oauth2.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.puppetDBSDConfigs.oauth2.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.puppetDBSDConfigs.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.puppetDBSDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.puppetDBSDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.puppetDBSDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.puppetDBSDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.puppetDBSDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.puppetDBSDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.puppetDBSDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.puppetDBSDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.puppetDBSDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.puppetDBSDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.puppetDBSDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.puppetDBSDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.puppetDBSDConfigs.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.relabelings
"relabelings 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\nUppercase and Lowercase actions require Prometheus >= v2.36.0.\nDropEqual and KeepEqual actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\
fn spec.relabelings.withModulus
withModulus(modulus)
"modulus to take of the hash of the source label values.\n\nOnly applicable when the action is HashMod."
fn spec.relabelings.withRegex
withRegex(regex)
"regex defines the 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\nRegex capture groups are available."
fn spec.relabelings.withSeparator
withSeparator(separator)
"separator defines the string between concatenated SourceLabels."
fn spec.relabelings.withSourceLabels
withSourceLabels(sourceLabels)
"sourceLabels defines 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)
"sourceLabels defines 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)
"targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for Replace, HashMod, Lowercase, Uppercase,\nKeepEqual and DropEqual actions.\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)
"accessKey defines the access key to use. https://console.scaleway.com/project/credentials"
fn spec.scalewaySDConfigs.withApiURL
withApiURL(apiURL)
"apiURL defines the API URL to use when doing the server listing requests."
fn spec.scalewaySDConfigs.withEnableHTTP2
withEnableHTTP2(enableHTTP2)
"enableHTTP2 defines whether to enable HTTP2."
fn spec.scalewaySDConfigs.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects defines whether HTTP requests follow HTTP 3xx redirects."
fn spec.scalewaySDConfigs.withNameFilter
withNameFilter(nameFilter)
"nameFilter defines a name filter (works as a LIKE) to apply on the server listing request."
fn spec.scalewaySDConfigs.withNoProxy
withNoProxy(noProxy)
"noProxy defines 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\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.scalewaySDConfigs.withPort
withPort(port)
"port defines the port to scrape metrics from. If using the public IP address, this must"
fn spec.scalewaySDConfigs.withProjectID
withProjectID(projectID)
"projectID defines the Project ID of the targets."
fn spec.scalewaySDConfigs.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.scalewaySDConfigs.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.scalewaySDConfigs.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.scalewaySDConfigs.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.scalewaySDConfigs.withRefreshInterval
withRefreshInterval(refreshInterval)
"refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value."
fn spec.scalewaySDConfigs.withRole
withRole(role)
"role defines the service of the targets to retrieve. Must be Instance or Baremetal."
fn spec.scalewaySDConfigs.withTagsFilter
withTagsFilter(tagsFilter)
"tagsFilter defines 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 defines 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 defines the availability zone of your targets (e.g. fr-par-1)."
obj spec.scalewaySDConfigs.secretKey
"secretKey defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.scalewaySDConfigs.secretKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.scalewaySDConfigs.tlsConfig
"tlsConfig defines the TLS configuration to connect to the Consul API."
fn spec.scalewaySDConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.scalewaySDConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.scalewaySDConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.scalewaySDConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.scalewaySDConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.scalewaySDConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.scalewaySDConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.scalewaySDConfigs.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.scalewaySDConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.scalewaySDConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.scalewaySDConfigs.tlsConfig.keySecret
"keySecret defines the 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.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines labels assigned to all metrics scraped from the targets."
fn spec.staticConfigs.withLabelsMixin
withLabelsMixin(labels)
"labels defines labels assigned to all metrics scraped from the targets."
Note: This function appends passed data to existing values
fn spec.staticConfigs.withTargets
withTargets(targets)
"targets defines the list of targets for this static configuration."
fn spec.staticConfigs.withTargetsMixin
withTargetsMixin(targets)
"targets defines the list of targets for this static configuration."
Note: This function appends passed data to existing values
obj spec.tlsConfig
"tlsConfig defines the TLS configuration to use on every scrape request"
fn spec.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"