monitoring.v1alpha1.alertmanagerConfig
"AlertmanagerConfig defines a namespaced AlertmanagerConfig to be aggregated across multiple namespaces configuring one Alertmanager cluster."
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 withInhibitRules(inhibitRules)fn withInhibitRulesMixin(inhibitRules)fn withMuteTimeIntervals(muteTimeIntervals)fn withMuteTimeIntervalsMixin(muteTimeIntervals)fn withReceivers(receivers)fn withReceiversMixin(receivers)obj spec.inhibitRulesobj spec.muteTimeIntervalsfn withName(name)fn withTimeIntervals(timeIntervals)fn withTimeIntervalsMixin(timeIntervals)obj spec.muteTimeIntervals.timeIntervalsfn withDaysOfMonth(daysOfMonth)fn withDaysOfMonthMixin(daysOfMonth)fn withMonths(months)fn withMonthsMixin(months)fn withTimes(times)fn withTimesMixin(times)fn withWeekdays(weekdays)fn withWeekdaysMixin(weekdays)fn withYears(years)fn withYearsMixin(years)obj spec.muteTimeIntervals.timeIntervals.daysOfMonthobj spec.muteTimeIntervals.timeIntervals.times
obj spec.receiversfn withEmailConfigs(emailConfigs)fn withEmailConfigsMixin(emailConfigs)fn withName(name)fn withOpsgenieConfigs(opsgenieConfigs)fn withOpsgenieConfigsMixin(opsgenieConfigs)fn withPagerdutyConfigs(pagerdutyConfigs)fn withPagerdutyConfigsMixin(pagerdutyConfigs)fn withPushoverConfigs(pushoverConfigs)fn withPushoverConfigsMixin(pushoverConfigs)fn withSlackConfigs(slackConfigs)fn withSlackConfigsMixin(slackConfigs)fn withSnsConfigs(snsConfigs)fn withSnsConfigsMixin(snsConfigs)fn withTelegramConfigs(telegramConfigs)fn withTelegramConfigsMixin(telegramConfigs)fn withVictoropsConfigs(victoropsConfigs)fn withVictoropsConfigsMixin(victoropsConfigs)fn withWebhookConfigs(webhookConfigs)fn withWebhookConfigsMixin(webhookConfigs)fn withWechatConfigs(wechatConfigs)fn withWechatConfigsMixin(wechatConfigs)obj spec.receivers.emailConfigsfn withAuthIdentity(authIdentity)fn withAuthUsername(authUsername)fn withFrom(from)fn withHeaders(headers)fn withHeadersMixin(headers)fn withHello(hello)fn withHtml(html)fn withRequireTLS(requireTLS)fn withSendResolved(sendResolved)fn withSmarthost(smarthost)fn withText(text)fn withTo(to)obj spec.receivers.emailConfigs.authPasswordobj spec.receivers.emailConfigs.authSecretobj spec.receivers.emailConfigs.headersobj spec.receivers.emailConfigs.tlsConfig
obj spec.receivers.opsgenieConfigsfn withActions(actions)fn withApiURL(apiURL)fn withDescription(description)fn withDetails(details)fn withDetailsMixin(details)fn withEntity(entity)fn withMessage(message)fn withNote(note)fn withPriority(priority)fn withResponders(responders)fn withRespondersMixin(responders)fn withSendResolved(sendResolved)fn withSource(source)fn withTags(tags)fn withUpdateAlerts(updateAlerts)obj spec.receivers.opsgenieConfigs.apiKeyobj spec.receivers.opsgenieConfigs.detailsobj spec.receivers.opsgenieConfigs.httpConfigfn withFollowRedirects(followRedirects)fn withProxyURL(proxyURL)obj spec.receivers.opsgenieConfigs.httpConfig.authorizationobj spec.receivers.opsgenieConfigs.httpConfig.basicAuthobj spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecretobj spec.receivers.opsgenieConfigs.httpConfig.oauth2obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig
obj spec.receivers.opsgenieConfigs.responders
obj spec.receivers.pagerdutyConfigsfn withClass(class)fn withClient(client)fn withClientURL(clientURL)fn withComponent(component)fn withDescription(description)fn withDetails(details)fn withDetailsMixin(details)fn withGroup(group)fn withPagerDutyImageConfigs(pagerDutyImageConfigs)fn withPagerDutyImageConfigsMixin(pagerDutyImageConfigs)fn withPagerDutyLinkConfigs(pagerDutyLinkConfigs)fn withPagerDutyLinkConfigsMixin(pagerDutyLinkConfigs)fn withSendResolved(sendResolved)fn withSeverity(severity)fn withUrl(url)obj spec.receivers.pagerdutyConfigs.detailsobj spec.receivers.pagerdutyConfigs.httpConfigfn withFollowRedirects(followRedirects)fn withProxyURL(proxyURL)obj spec.receivers.pagerdutyConfigs.httpConfig.authorizationobj spec.receivers.pagerdutyConfigs.httpConfig.basicAuthobj spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecretobj spec.receivers.pagerdutyConfigs.httpConfig.oauth2obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig
obj spec.receivers.pagerdutyConfigs.pagerDutyImageConfigsobj spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigsobj spec.receivers.pagerdutyConfigs.routingKeyobj spec.receivers.pagerdutyConfigs.serviceKey
obj spec.receivers.pushoverConfigsfn withExpire(expire)fn withHtml(html)fn withMessage(message)fn withPriority(priority)fn withRetry(retry)fn withSendResolved(sendResolved)fn withSound(sound)fn withTitle(title)fn withUrl(url)fn withUrlTitle(urlTitle)obj spec.receivers.pushoverConfigs.httpConfigfn withFollowRedirects(followRedirects)fn withProxyURL(proxyURL)obj spec.receivers.pushoverConfigs.httpConfig.authorizationobj spec.receivers.pushoverConfigs.httpConfig.basicAuthobj spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecretobj spec.receivers.pushoverConfigs.httpConfig.oauth2obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig
obj spec.receivers.pushoverConfigs.tokenobj spec.receivers.pushoverConfigs.userKey
obj spec.receivers.slackConfigsfn withActions(actions)fn withActionsMixin(actions)fn withCallbackId(callbackId)fn withChannel(channel)fn withColor(color)fn withFallback(fallback)fn withFields(fields)fn withFieldsMixin(fields)fn withFooter(footer)fn withIconEmoji(iconEmoji)fn withIconURL(iconURL)fn withImageURL(imageURL)fn withLinkNames(linkNames)fn withMrkdwnIn(mrkdwnIn)fn withMrkdwnInMixin(mrkdwnIn)fn withPretext(pretext)fn withSendResolved(sendResolved)fn withShortFields(shortFields)fn withText(text)fn withThumbURL(thumbURL)fn withTitle(title)fn withTitleLink(titleLink)fn withUsername(username)obj spec.receivers.slackConfigs.actionsobj spec.receivers.slackConfigs.apiURLobj spec.receivers.slackConfigs.fieldsobj spec.receivers.slackConfigs.httpConfigfn withFollowRedirects(followRedirects)fn withProxyURL(proxyURL)obj spec.receivers.slackConfigs.httpConfig.authorizationobj spec.receivers.slackConfigs.httpConfig.basicAuthobj spec.receivers.slackConfigs.httpConfig.bearerTokenSecretobj spec.receivers.slackConfigs.httpConfig.oauth2obj spec.receivers.slackConfigs.httpConfig.tlsConfig
obj spec.receivers.snsConfigsfn withApiURL(apiURL)fn withAttributes(attributes)fn withAttributesMixin(attributes)fn withMessage(message)fn withPhoneNumber(phoneNumber)fn withSendResolved(sendResolved)fn withSubject(subject)fn withTargetARN(targetARN)fn withTopicARN(topicARN)obj spec.receivers.snsConfigs.httpConfigfn withFollowRedirects(followRedirects)fn withProxyURL(proxyURL)obj spec.receivers.snsConfigs.httpConfig.authorizationobj spec.receivers.snsConfigs.httpConfig.basicAuthobj spec.receivers.snsConfigs.httpConfig.bearerTokenSecretobj spec.receivers.snsConfigs.httpConfig.oauth2obj spec.receivers.snsConfigs.httpConfig.tlsConfig
obj spec.receivers.snsConfigs.sigv4
obj spec.receivers.telegramConfigsfn withApiURL(apiURL)fn withChatID(chatID)fn withDisableNotifications(disableNotifications)fn withMessage(message)fn withParseMode(parseMode)fn withSendResolved(sendResolved)obj spec.receivers.telegramConfigs.botTokenobj spec.receivers.telegramConfigs.httpConfigfn withFollowRedirects(followRedirects)fn withProxyURL(proxyURL)obj spec.receivers.telegramConfigs.httpConfig.authorizationobj spec.receivers.telegramConfigs.httpConfig.basicAuthobj spec.receivers.telegramConfigs.httpConfig.bearerTokenSecretobj spec.receivers.telegramConfigs.httpConfig.oauth2obj spec.receivers.telegramConfigs.httpConfig.tlsConfig
obj spec.receivers.victoropsConfigsfn withApiUrl(apiUrl)fn withCustomFields(customFields)fn withCustomFieldsMixin(customFields)fn withEntityDisplayName(entityDisplayName)fn withMessageType(messageType)fn withMonitoringTool(monitoringTool)fn withRoutingKey(routingKey)fn withSendResolved(sendResolved)fn withStateMessage(stateMessage)obj spec.receivers.victoropsConfigs.apiKeyobj spec.receivers.victoropsConfigs.customFieldsobj spec.receivers.victoropsConfigs.httpConfigfn withFollowRedirects(followRedirects)fn withProxyURL(proxyURL)obj spec.receivers.victoropsConfigs.httpConfig.authorizationobj spec.receivers.victoropsConfigs.httpConfig.basicAuthobj spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecretobj spec.receivers.victoropsConfigs.httpConfig.oauth2obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig
obj spec.receivers.webhookConfigsfn withMaxAlerts(maxAlerts)fn withSendResolved(sendResolved)fn withUrl(url)obj spec.receivers.webhookConfigs.httpConfigfn withFollowRedirects(followRedirects)fn withProxyURL(proxyURL)obj spec.receivers.webhookConfigs.httpConfig.authorizationobj spec.receivers.webhookConfigs.httpConfig.basicAuthobj spec.receivers.webhookConfigs.httpConfig.bearerTokenSecretobj spec.receivers.webhookConfigs.httpConfig.oauth2obj spec.receivers.webhookConfigs.httpConfig.tlsConfig
obj spec.receivers.webhookConfigs.urlSecret
obj spec.receivers.wechatConfigsfn withAgentID(agentID)fn withApiURL(apiURL)fn withCorpID(corpID)fn withMessage(message)fn withMessageType(messageType)fn withSendResolved(sendResolved)fn withToParty(toParty)fn withToTag(toTag)fn withToUser(toUser)obj spec.receivers.wechatConfigs.apiSecretobj spec.receivers.wechatConfigs.httpConfigfn withFollowRedirects(followRedirects)fn withProxyURL(proxyURL)obj spec.receivers.wechatConfigs.httpConfig.authorizationobj spec.receivers.wechatConfigs.httpConfig.basicAuthobj spec.receivers.wechatConfigs.httpConfig.bearerTokenSecretobj spec.receivers.wechatConfigs.httpConfig.oauth2obj spec.receivers.wechatConfigs.httpConfig.tlsConfig
obj spec.routefn withContinue(continue)fn withGroupBy(groupBy)fn withGroupByMixin(groupBy)fn withGroupInterval(groupInterval)fn withGroupWait(groupWait)fn withMatchers(matchers)fn withMatchersMixin(matchers)fn withMuteTimeIntervals(muteTimeIntervals)fn withMuteTimeIntervalsMixin(muteTimeIntervals)fn withReceiver(receiver)fn withRepeatInterval(repeatInterval)fn withRoutes(routes)fn withRoutesMixin(routes)obj spec.route.matchers
Fields
fn new
new(name)
new returns an instance of AlertmanagerConfig
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
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
"AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration. By definition, the Alertmanager configuration only applies to alerts for which the namespace label is equal to the namespace of the AlertmanagerConfig resource."
fn spec.withInhibitRules
withInhibitRules(inhibitRules)
"List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace."
fn spec.withInhibitRulesMixin
withInhibitRulesMixin(inhibitRules)
"List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace."
Note: This function appends passed data to existing values
fn spec.withMuteTimeIntervals
withMuteTimeIntervals(muteTimeIntervals)
"List of MuteTimeInterval specifying when the routes should be muted."
fn spec.withMuteTimeIntervalsMixin
withMuteTimeIntervalsMixin(muteTimeIntervals)
"List of MuteTimeInterval specifying when the routes should be muted."
Note: This function appends passed data to existing values
fn spec.withReceivers
withReceivers(receivers)
"List of receivers."
fn spec.withReceiversMixin
withReceiversMixin(receivers)
"List of receivers."
Note: This function appends passed data to existing values
obj spec.inhibitRules
"List of inhibition rules. The rules will only apply to alerts matching the resource’s namespace."
fn spec.inhibitRules.withEqual
withEqual(equal)
"Labels that must have an equal value in the source and target alert for the inhibition to take effect."
fn spec.inhibitRules.withEqualMixin
withEqualMixin(equal)
"Labels that must have an equal value in the source and target alert for the inhibition to take effect."
Note: This function appends passed data to existing values
fn spec.inhibitRules.withSourceMatch
withSourceMatch(sourceMatch)
"Matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace."
fn spec.inhibitRules.withSourceMatchMixin
withSourceMatchMixin(sourceMatch)
"Matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace."
Note: This function appends passed data to existing values
fn spec.inhibitRules.withTargetMatch
withTargetMatch(targetMatch)
"Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace."
fn spec.inhibitRules.withTargetMatchMixin
withTargetMatchMixin(targetMatch)
"Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace."
Note: This function appends passed data to existing values
obj spec.inhibitRules.sourceMatch
"Matchers for which one or more alerts have to exist for the inhibition to take effect. The operator enforces that the alert matches the resource’s namespace."
fn spec.inhibitRules.sourceMatch.withMatchType
withMatchType(matchType)
"Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty."
fn spec.inhibitRules.sourceMatch.withName
withName(name)
"Label to match."
fn spec.inhibitRules.sourceMatch.withRegex
withRegex(regex)
"Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead."
fn spec.inhibitRules.sourceMatch.withValue
withValue(value)
"Label value to match."
obj spec.inhibitRules.targetMatch
"Matchers that have to be fulfilled in the alerts to be muted. The operator enforces that the alert matches the resource’s namespace."
fn spec.inhibitRules.targetMatch.withMatchType
withMatchType(matchType)
"Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty."
fn spec.inhibitRules.targetMatch.withName
withName(name)
"Label to match."
fn spec.inhibitRules.targetMatch.withRegex
withRegex(regex)
"Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead."
fn spec.inhibitRules.targetMatch.withValue
withValue(value)
"Label value to match."
obj spec.muteTimeIntervals
"List of MuteTimeInterval specifying when the routes should be muted."
fn spec.muteTimeIntervals.withName
withName(name)
"Name of the time interval"
fn spec.muteTimeIntervals.withTimeIntervals
withTimeIntervals(timeIntervals)
"TimeIntervals is a list of TimeInterval"
fn spec.muteTimeIntervals.withTimeIntervalsMixin
withTimeIntervalsMixin(timeIntervals)
"TimeIntervals is a list of TimeInterval"
Note: This function appends passed data to existing values
obj spec.muteTimeIntervals.timeIntervals
"TimeIntervals is a list of TimeInterval"
fn spec.muteTimeIntervals.timeIntervals.withDaysOfMonth
withDaysOfMonth(daysOfMonth)
"DaysOfMonth is a list of DayOfMonthRange"
fn spec.muteTimeIntervals.timeIntervals.withDaysOfMonthMixin
withDaysOfMonthMixin(daysOfMonth)
"DaysOfMonth is a list of DayOfMonthRange"
Note: This function appends passed data to existing values
fn spec.muteTimeIntervals.timeIntervals.withMonths
withMonths(months)
"Months is a list of MonthRange"
fn spec.muteTimeIntervals.timeIntervals.withMonthsMixin
withMonthsMixin(months)
"Months is a list of MonthRange"
Note: This function appends passed data to existing values
fn spec.muteTimeIntervals.timeIntervals.withTimes
withTimes(times)
"Times is a list of TimeRange"
fn spec.muteTimeIntervals.timeIntervals.withTimesMixin
withTimesMixin(times)
"Times is a list of TimeRange"
Note: This function appends passed data to existing values
fn spec.muteTimeIntervals.timeIntervals.withWeekdays
withWeekdays(weekdays)
"Weekdays is a list of WeekdayRange"
fn spec.muteTimeIntervals.timeIntervals.withWeekdaysMixin
withWeekdaysMixin(weekdays)
"Weekdays is a list of WeekdayRange"
Note: This function appends passed data to existing values
fn spec.muteTimeIntervals.timeIntervals.withYears
withYears(years)
"Years is a list of YearRange"
fn spec.muteTimeIntervals.timeIntervals.withYearsMixin
withYearsMixin(years)
"Years is a list of YearRange"
Note: This function appends passed data to existing values
obj spec.muteTimeIntervals.timeIntervals.daysOfMonth
"DaysOfMonth is a list of DayOfMonthRange"
fn spec.muteTimeIntervals.timeIntervals.daysOfMonth.withEnd
withEnd(end)
"End of the inclusive range"
fn spec.muteTimeIntervals.timeIntervals.daysOfMonth.withStart
withStart(start)
"Start of the inclusive range"
obj spec.muteTimeIntervals.timeIntervals.times
"Times is a list of TimeRange"
fn spec.muteTimeIntervals.timeIntervals.times.withEndTime
withEndTime(endTime)
"EndTime is the end time in 24hr format."
fn spec.muteTimeIntervals.timeIntervals.times.withStartTime
withStartTime(startTime)
"StartTime is the start time in 24hr format."
obj spec.receivers
"List of receivers."
fn spec.receivers.withEmailConfigs
withEmailConfigs(emailConfigs)
"List of Email configurations."
fn spec.receivers.withEmailConfigsMixin
withEmailConfigsMixin(emailConfigs)
"List of Email configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withName
withName(name)
"Name of the receiver. Must be unique across all items from the list."
fn spec.receivers.withOpsgenieConfigs
withOpsgenieConfigs(opsgenieConfigs)
"List of OpsGenie configurations."
fn spec.receivers.withOpsgenieConfigsMixin
withOpsgenieConfigsMixin(opsgenieConfigs)
"List of OpsGenie configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withPagerdutyConfigs
withPagerdutyConfigs(pagerdutyConfigs)
"List of PagerDuty configurations."
fn spec.receivers.withPagerdutyConfigsMixin
withPagerdutyConfigsMixin(pagerdutyConfigs)
"List of PagerDuty configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withPushoverConfigs
withPushoverConfigs(pushoverConfigs)
"List of Pushover configurations."
fn spec.receivers.withPushoverConfigsMixin
withPushoverConfigsMixin(pushoverConfigs)
"List of Pushover configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withSlackConfigs
withSlackConfigs(slackConfigs)
"List of Slack configurations."
fn spec.receivers.withSlackConfigsMixin
withSlackConfigsMixin(slackConfigs)
"List of Slack configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withSnsConfigs
withSnsConfigs(snsConfigs)
"List of SNS configurations"
fn spec.receivers.withSnsConfigsMixin
withSnsConfigsMixin(snsConfigs)
"List of SNS configurations"
Note: This function appends passed data to existing values
fn spec.receivers.withTelegramConfigs
withTelegramConfigs(telegramConfigs)
"List of Telegram configurations."
fn spec.receivers.withTelegramConfigsMixin
withTelegramConfigsMixin(telegramConfigs)
"List of Telegram configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withVictoropsConfigs
withVictoropsConfigs(victoropsConfigs)
"List of VictorOps configurations."
fn spec.receivers.withVictoropsConfigsMixin
withVictoropsConfigsMixin(victoropsConfigs)
"List of VictorOps configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withWebhookConfigs
withWebhookConfigs(webhookConfigs)
"List of webhook configurations."
fn spec.receivers.withWebhookConfigsMixin
withWebhookConfigsMixin(webhookConfigs)
"List of webhook configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withWechatConfigs
withWechatConfigs(wechatConfigs)
"List of WeChat configurations."
fn spec.receivers.withWechatConfigsMixin
withWechatConfigsMixin(wechatConfigs)
"List of WeChat configurations."
Note: This function appends passed data to existing values
obj spec.receivers.emailConfigs
"List of Email configurations."
fn spec.receivers.emailConfigs.withAuthIdentity
withAuthIdentity(authIdentity)
"The identity to use for authentication."
fn spec.receivers.emailConfigs.withAuthUsername
withAuthUsername(authUsername)
"The username to use for authentication."
fn spec.receivers.emailConfigs.withFrom
withFrom(from)
"The sender address."
fn spec.receivers.emailConfigs.withHeaders
withHeaders(headers)
"Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation."
fn spec.receivers.emailConfigs.withHeadersMixin
withHeadersMixin(headers)
"Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation."
Note: This function appends passed data to existing values
fn spec.receivers.emailConfigs.withHello
withHello(hello)
"The hostname to identify to the SMTP server."
fn spec.receivers.emailConfigs.withHtml
withHtml(html)
"The HTML body of the email notification."
fn spec.receivers.emailConfigs.withRequireTLS
withRequireTLS(requireTLS)
"The SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints."
fn spec.receivers.emailConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether or not to notify about resolved alerts."
fn spec.receivers.emailConfigs.withSmarthost
withSmarthost(smarthost)
"The SMTP host and port through which emails are sent. E.g. example.com:25"
fn spec.receivers.emailConfigs.withText
withText(text)
"The text body of the email notification."
fn spec.receivers.emailConfigs.withTo
withTo(to)
"The email address to send notifications to."
obj spec.receivers.emailConfigs.authPassword
"The secret's key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.emailConfigs.authPassword.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.emailConfigs.authPassword.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.emailConfigs.authPassword.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.emailConfigs.authSecret
"The secret's key that contains the CRAM-MD5 secret. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.emailConfigs.authSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.emailConfigs.authSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.emailConfigs.authSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.emailConfigs.headers
"Further headers email header key/value pairs. Overrides any headers previously set by the notification implementation."
fn spec.receivers.emailConfigs.headers.withKey
withKey(key)
"Key of the tuple."
fn spec.receivers.emailConfigs.headers.withValue
withValue(value)
"Value of the tuple."
obj spec.receivers.emailConfigs.tlsConfig
"TLS configuration"
fn spec.receivers.emailConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.emailConfigs.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.emailConfigs.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.emailConfigs.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.emailConfigs.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.emailConfigs.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.emailConfigs.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.emailConfigs.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.emailConfigs.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.emailConfigs.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.emailConfigs.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.emailConfigs.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.emailConfigs.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.emailConfigs.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.emailConfigs.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.emailConfigs.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.emailConfigs.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.emailConfigs.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.emailConfigs.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.emailConfigs.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.emailConfigs.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.emailConfigs.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.emailConfigs.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.emailConfigs.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs
"List of OpsGenie configurations."
fn spec.receivers.opsgenieConfigs.withActions
withActions(actions)
"Comma separated list of actions that will be available for the alert."
fn spec.receivers.opsgenieConfigs.withApiURL
withApiURL(apiURL)
"The URL to send OpsGenie API requests to."
fn spec.receivers.opsgenieConfigs.withDescription
withDescription(description)
"Description of the incident."
fn spec.receivers.opsgenieConfigs.withDetails
withDetails(details)
"A set of arbitrary key/value pairs that provide further detail about the incident."
fn spec.receivers.opsgenieConfigs.withDetailsMixin
withDetailsMixin(details)
"A set of arbitrary key/value pairs that provide further detail about the incident."
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.withEntity
withEntity(entity)
"Optional field that can be used to specify which domain alert is related to."
fn spec.receivers.opsgenieConfigs.withMessage
withMessage(message)
"Alert text limited to 130 characters."
fn spec.receivers.opsgenieConfigs.withNote
withNote(note)
"Additional alert note."
fn spec.receivers.opsgenieConfigs.withPriority
withPriority(priority)
"Priority level of alert. Possible values are P1, P2, P3, P4, and P5."
fn spec.receivers.opsgenieConfigs.withResponders
withResponders(responders)
"List of responders responsible for notifications."
fn spec.receivers.opsgenieConfigs.withRespondersMixin
withRespondersMixin(responders)
"List of responders responsible for notifications."
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether or not to notify about resolved alerts."
fn spec.receivers.opsgenieConfigs.withSource
withSource(source)
"Backlink to the sender of the notification."
fn spec.receivers.opsgenieConfigs.withTags
withTags(tags)
"Comma separated list of tags attached to the notifications."
fn spec.receivers.opsgenieConfigs.withUpdateAlerts
withUpdateAlerts(updateAlerts)
"Whether to update message and description of the alert in OpsGenie if it already exists By default, the alert is never updated in OpsGenie, the new message only appears in activity log."
obj spec.receivers.opsgenieConfigs.apiKey
"The secret's key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.opsgenieConfigs.apiKey.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.apiKey.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.apiKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.details
"A set of arbitrary key/value pairs that provide further detail about the incident."
fn spec.receivers.opsgenieConfigs.details.withKey
withKey(key)
"Key of the tuple."
fn spec.receivers.opsgenieConfigs.details.withValue
withValue(value)
"Value of the tuple."
obj spec.receivers.opsgenieConfigs.httpConfig
"HTTP client configuration."
fn spec.receivers.opsgenieConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."
fn spec.receivers.opsgenieConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"Optional proxy URL."
obj spec.receivers.opsgenieConfigs.httpConfig.authorization
"Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.opsgenieConfigs.httpConfig.authorization.withType
withType(type)
"Set the authentication type. Defaults to Bearer, Basic will cause an error"
obj spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials
"The secret's key that contains the credentials of the request"
fn spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth
"BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password
"The secret in the service monitor namespace that contains the password for authentication."
fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username
"The secret in the service monitor namespace that contains the username for authentication."
fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret
"The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2
"OAuth2 client credentials used to fetch a token for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"Parameters to append to the token URL"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"The URL to fetch the token from"
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId
"The secret or configmap containing the OAuth2 client id"
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret
"Secret containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret
"The secret containing the OAuth2 client secret"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig
"TLS configuration for the client."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.responders
"List of responders responsible for notifications."
fn spec.receivers.opsgenieConfigs.responders.withId
withId(id)
"ID of the responder."
fn spec.receivers.opsgenieConfigs.responders.withName
withName(name)
"Name of the responder."
fn spec.receivers.opsgenieConfigs.responders.withType
withType(type)
"Type of responder."
fn spec.receivers.opsgenieConfigs.responders.withUsername
withUsername(username)
"Username of the responder."
obj spec.receivers.pagerdutyConfigs
"List of PagerDuty configurations."
fn spec.receivers.pagerdutyConfigs.withClass
withClass(class)
"The class/type of the event."
fn spec.receivers.pagerdutyConfigs.withClient
withClient(client)
"Client identification."
fn spec.receivers.pagerdutyConfigs.withClientURL
withClientURL(clientURL)
"Backlink to the sender of notification."
fn spec.receivers.pagerdutyConfigs.withComponent
withComponent(component)
"The part or component of the affected system that is broken."
fn spec.receivers.pagerdutyConfigs.withDescription
withDescription(description)
"Description of the incident."
fn spec.receivers.pagerdutyConfigs.withDetails
withDetails(details)
"Arbitrary key/value pairs that provide further detail about the incident."
fn spec.receivers.pagerdutyConfigs.withDetailsMixin
withDetailsMixin(details)
"Arbitrary key/value pairs that provide further detail about the incident."
Note: This function appends passed data to existing values
fn spec.receivers.pagerdutyConfigs.withGroup
withGroup(group)
"A cluster or grouping of sources."
fn spec.receivers.pagerdutyConfigs.withPagerDutyImageConfigs
withPagerDutyImageConfigs(pagerDutyImageConfigs)
"A list of image details to attach that provide further detail about an incident."
fn spec.receivers.pagerdutyConfigs.withPagerDutyImageConfigsMixin
withPagerDutyImageConfigsMixin(pagerDutyImageConfigs)
"A list of image details to attach that provide further detail about an incident."
Note: This function appends passed data to existing values
fn spec.receivers.pagerdutyConfigs.withPagerDutyLinkConfigs
withPagerDutyLinkConfigs(pagerDutyLinkConfigs)
"A list of link details to attach that provide further detail about an incident."
fn spec.receivers.pagerdutyConfigs.withPagerDutyLinkConfigsMixin
withPagerDutyLinkConfigsMixin(pagerDutyLinkConfigs)
"A list of link details to attach that provide further detail about an incident."
Note: This function appends passed data to existing values
fn spec.receivers.pagerdutyConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether or not to notify about resolved alerts."
fn spec.receivers.pagerdutyConfigs.withSeverity
withSeverity(severity)
"Severity of the incident."
fn spec.receivers.pagerdutyConfigs.withUrl
withUrl(url)
"The URL to send requests to."
obj spec.receivers.pagerdutyConfigs.details
"Arbitrary key/value pairs that provide further detail about the incident."
fn spec.receivers.pagerdutyConfigs.details.withKey
withKey(key)
"Key of the tuple."
fn spec.receivers.pagerdutyConfigs.details.withValue
withValue(value)
"Value of the tuple."
obj spec.receivers.pagerdutyConfigs.httpConfig
"HTTP client configuration."
fn spec.receivers.pagerdutyConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."
fn spec.receivers.pagerdutyConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"Optional proxy URL."
obj spec.receivers.pagerdutyConfigs.httpConfig.authorization
"Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.pagerdutyConfigs.httpConfig.authorization.withType
withType(type)
"Set the authentication type. Defaults to Bearer, Basic will cause an error"
obj spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials
"The secret's key that contains the credentials of the request"
fn spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth
"BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password
"The secret in the service monitor namespace that contains the password for authentication."
fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username
"The secret in the service monitor namespace that contains the username for authentication."
fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret
"The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2
"OAuth2 client credentials used to fetch a token for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"Parameters to append to the token URL"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"The URL to fetch the token from"
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId
"The secret or configmap containing the OAuth2 client id"
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret
"Secret containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret
"The secret containing the OAuth2 client secret"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig
"TLS configuration for the client."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs
"A list of image details to attach that provide further detail about an incident."
fn spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs.withAlt
withAlt(alt)
"Alt is the optional alternative text for the image."
fn spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs.withHref
withHref(href)
"Optional URL; makes the image a clickable link."
fn spec.receivers.pagerdutyConfigs.pagerDutyImageConfigs.withSrc
withSrc(src)
"Src of the image being attached to the incident"
obj spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs
"A list of link details to attach that provide further detail about an incident."
fn spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs.withAlt
withAlt(alt)
"Text that describes the purpose of the link, and can be used as the link's text."
fn spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs.withHref
withHref(href)
"Href is the URL of the link to be attached"
obj spec.receivers.pagerdutyConfigs.routingKey
"The secret's key that contains the PagerDuty integration key (when using Events API v2). Either this field or serviceKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.pagerdutyConfigs.routingKey.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.routingKey.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.routingKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.serviceKey
"The secret's key that contains the PagerDuty service key (when using integration type \"Prometheus\"). Either this field or routingKey needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.pagerdutyConfigs.serviceKey.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.serviceKey.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pagerdutyConfigs.serviceKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs
"List of Pushover configurations."
fn spec.receivers.pushoverConfigs.withExpire
withExpire(expire)
"How long your notification will continue to be retried for, unless the user acknowledges the notification."
fn spec.receivers.pushoverConfigs.withHtml
withHtml(html)
"Whether notification message is HTML or plain text."
fn spec.receivers.pushoverConfigs.withMessage
withMessage(message)
"Notification message."
fn spec.receivers.pushoverConfigs.withPriority
withPriority(priority)
"Priority, see https://pushover.net/api#priority"
fn spec.receivers.pushoverConfigs.withRetry
withRetry(retry)
"How often the Pushover servers will send the same notification to the user. Must be at least 30 seconds."
fn spec.receivers.pushoverConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether or not to notify about resolved alerts."
fn spec.receivers.pushoverConfigs.withSound
withSound(sound)
"The name of one of the sounds supported by device clients to override the user's default sound choice"
fn spec.receivers.pushoverConfigs.withTitle
withTitle(title)
"Notification title."
fn spec.receivers.pushoverConfigs.withUrl
withUrl(url)
"A supplementary URL shown alongside the message."
fn spec.receivers.pushoverConfigs.withUrlTitle
withUrlTitle(urlTitle)
"A title for supplementary URL, otherwise just the URL is shown"
obj spec.receivers.pushoverConfigs.httpConfig
"HTTP client configuration."
fn spec.receivers.pushoverConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."
fn spec.receivers.pushoverConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"Optional proxy URL."
obj spec.receivers.pushoverConfigs.httpConfig.authorization
"Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.pushoverConfigs.httpConfig.authorization.withType
withType(type)
"Set the authentication type. Defaults to Bearer, Basic will cause an error"
obj spec.receivers.pushoverConfigs.httpConfig.authorization.credentials
"The secret's key that contains the credentials of the request"
fn spec.receivers.pushoverConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.basicAuth
"BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.pushoverConfigs.httpConfig.basicAuth.password
"The secret in the service monitor namespace that contains the password for authentication."
fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.basicAuth.username
"The secret in the service monitor namespace that contains the username for authentication."
fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret
"The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.oauth2
"OAuth2 client credentials used to fetch a token for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"Parameters to append to the token URL"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"The URL to fetch the token from"
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId
"The secret or configmap containing the OAuth2 client id"
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret
"Secret containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret
"The secret containing the OAuth2 client secret"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig
"TLS configuration for the client."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.token
"The secret's key that contains the registered application’s API token, see https://pushover.net/apps. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.pushoverConfigs.token.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.token.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.token.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.userKey
"The secret's key that contains the recipient user’s user key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.pushoverConfigs.userKey.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.userKey.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.pushoverConfigs.userKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs
"List of Slack configurations."
fn spec.receivers.slackConfigs.withActions
withActions(actions)
"A list of Slack actions that are sent with each notification."
fn spec.receivers.slackConfigs.withActionsMixin
withActionsMixin(actions)
"A list of Slack actions that are sent with each notification."
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.withCallbackId
withCallbackId(callbackId)
fn spec.receivers.slackConfigs.withChannel
withChannel(channel)
"The channel or user to send notifications to."
fn spec.receivers.slackConfigs.withColor
withColor(color)
fn spec.receivers.slackConfigs.withFallback
withFallback(fallback)
fn spec.receivers.slackConfigs.withFields
withFields(fields)
"A list of Slack fields that are sent with each notification."
fn spec.receivers.slackConfigs.withFieldsMixin
withFieldsMixin(fields)
"A list of Slack fields that are sent with each notification."
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.withFooter
withFooter(footer)
fn spec.receivers.slackConfigs.withIconEmoji
withIconEmoji(iconEmoji)
fn spec.receivers.slackConfigs.withIconURL
withIconURL(iconURL)
fn spec.receivers.slackConfigs.withImageURL
withImageURL(imageURL)
fn spec.receivers.slackConfigs.withLinkNames
withLinkNames(linkNames)
fn spec.receivers.slackConfigs.withMrkdwnIn
withMrkdwnIn(mrkdwnIn)
fn spec.receivers.slackConfigs.withMrkdwnInMixin
withMrkdwnInMixin(mrkdwnIn)
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.withPretext
withPretext(pretext)
fn spec.receivers.slackConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether or not to notify about resolved alerts."
fn spec.receivers.slackConfigs.withShortFields
withShortFields(shortFields)
fn spec.receivers.slackConfigs.withText
withText(text)
fn spec.receivers.slackConfigs.withThumbURL
withThumbURL(thumbURL)
fn spec.receivers.slackConfigs.withTitle
withTitle(title)
fn spec.receivers.slackConfigs.withTitleLink
withTitleLink(titleLink)
fn spec.receivers.slackConfigs.withUsername
withUsername(username)
obj spec.receivers.slackConfigs.actions
"A list of Slack actions that are sent with each notification."
fn spec.receivers.slackConfigs.actions.withName
withName(name)
fn spec.receivers.slackConfigs.actions.withStyle
withStyle(style)
fn spec.receivers.slackConfigs.actions.withText
withText(text)
fn spec.receivers.slackConfigs.actions.withType
withType(type)
fn spec.receivers.slackConfigs.actions.withUrl
withUrl(url)
fn spec.receivers.slackConfigs.actions.withValue
withValue(value)
obj spec.receivers.slackConfigs.actions.confirm
"SlackConfirmationField protect users from destructive actions or particularly distinguished decisions by asking them to confirm their button click one more time. See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields for more information."
fn spec.receivers.slackConfigs.actions.confirm.withDismissText
withDismissText(dismissText)
fn spec.receivers.slackConfigs.actions.confirm.withOkText
withOkText(okText)
fn spec.receivers.slackConfigs.actions.confirm.withText
withText(text)
fn spec.receivers.slackConfigs.actions.confirm.withTitle
withTitle(title)
obj spec.receivers.slackConfigs.apiURL
"The secret's key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.slackConfigs.apiURL.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.apiURL.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.apiURL.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.fields
"A list of Slack fields that are sent with each notification."
fn spec.receivers.slackConfigs.fields.withShort
withShort(short)
fn spec.receivers.slackConfigs.fields.withTitle
withTitle(title)
fn spec.receivers.slackConfigs.fields.withValue
withValue(value)
obj spec.receivers.slackConfigs.httpConfig
"HTTP client configuration."
fn spec.receivers.slackConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."
fn spec.receivers.slackConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"Optional proxy URL."
obj spec.receivers.slackConfigs.httpConfig.authorization
"Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.slackConfigs.httpConfig.authorization.withType
withType(type)
"Set the authentication type. Defaults to Bearer, Basic will cause an error"
obj spec.receivers.slackConfigs.httpConfig.authorization.credentials
"The secret's key that contains the credentials of the request"
fn spec.receivers.slackConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.basicAuth
"BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.slackConfigs.httpConfig.basicAuth.password
"The secret in the service monitor namespace that contains the password for authentication."
fn spec.receivers.slackConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.basicAuth.username
"The secret in the service monitor namespace that contains the username for authentication."
fn spec.receivers.slackConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.bearerTokenSecret
"The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.oauth2
"OAuth2 client credentials used to fetch a token for the targets."
fn spec.receivers.slackConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"Parameters to append to the token URL"
fn spec.receivers.slackConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.receivers.slackConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"The URL to fetch the token from"
obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId
"The secret or configmap containing the OAuth2 client id"
obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret
"Secret containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret
"The secret containing the OAuth2 client secret"
fn spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.tlsConfig
"TLS configuration for the client."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs
"List of SNS configurations"
fn spec.receivers.snsConfigs.withApiURL
withApiURL(apiURL)
"The SNS API URL i.e. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used."
fn spec.receivers.snsConfigs.withAttributes
withAttributes(attributes)
"SNS message attributes."
fn spec.receivers.snsConfigs.withAttributesMixin
withAttributesMixin(attributes)
"SNS message attributes."
Note: This function appends passed data to existing values
fn spec.receivers.snsConfigs.withMessage
withMessage(message)
"The message content of the SNS notification."
fn spec.receivers.snsConfigs.withPhoneNumber
withPhoneNumber(phoneNumber)
"Phone number if message is delivered via SMS in E.164 format. If you don't specify this value, you must specify a value for the TopicARN or TargetARN."
fn spec.receivers.snsConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether or not to notify about resolved alerts."
fn spec.receivers.snsConfigs.withSubject
withSubject(subject)
"Subject line when the message is delivered to email endpoints."
fn spec.receivers.snsConfigs.withTargetARN
withTargetARN(targetARN)
"The mobile platform endpoint ARN if message is delivered via mobile notifications. If you don't specify this value, you must specify a value for the topic_arn or PhoneNumber."
fn spec.receivers.snsConfigs.withTopicARN
withTopicARN(topicARN)
"SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic If you don't specify this value, you must specify a value for the PhoneNumber or TargetARN."
obj spec.receivers.snsConfigs.httpConfig
"HTTP client configuration."
fn spec.receivers.snsConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."
fn spec.receivers.snsConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"Optional proxy URL."
obj spec.receivers.snsConfigs.httpConfig.authorization
"Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.snsConfigs.httpConfig.authorization.withType
withType(type)
"Set the authentication type. Defaults to Bearer, Basic will cause an error"
obj spec.receivers.snsConfigs.httpConfig.authorization.credentials
"The secret's key that contains the credentials of the request"
fn spec.receivers.snsConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.basicAuth
"BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.snsConfigs.httpConfig.basicAuth.password
"The secret in the service monitor namespace that contains the password for authentication."
fn spec.receivers.snsConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.basicAuth.username
"The secret in the service monitor namespace that contains the username for authentication."
fn spec.receivers.snsConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.bearerTokenSecret
"The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.oauth2
"OAuth2 client credentials used to fetch a token for the targets."
fn spec.receivers.snsConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"Parameters to append to the token URL"
fn spec.receivers.snsConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.receivers.snsConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.receivers.snsConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.receivers.snsConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"The URL to fetch the token from"
obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId
"The secret or configmap containing the OAuth2 client id"
obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret
"Secret containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret
"The secret containing the OAuth2 client secret"
fn spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.tlsConfig
"TLS configuration for the client."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.sigv4
"Configures AWS's Signature Verification 4 signing process to sign requests."
fn spec.receivers.snsConfigs.sigv4.withProfile
withProfile(profile)
"Profile is the named AWS profile used to authenticate."
fn spec.receivers.snsConfigs.sigv4.withRegion
withRegion(region)
"Region is the AWS region. If blank, the region from the default credentials chain used."
fn spec.receivers.snsConfigs.sigv4.withRoleArn
withRoleArn(roleArn)
"RoleArn is the named AWS profile used to authenticate."
obj spec.receivers.snsConfigs.sigv4.accessKey
"AccessKey is the AWS API key. If blank, the environment variable AWS_ACCESS_KEY_ID is used."
fn spec.receivers.snsConfigs.sigv4.accessKey.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.sigv4.accessKey.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.sigv4.accessKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.sigv4.secretKey
"SecretKey is the AWS API secret. If blank, the environment variable AWS_SECRET_ACCESS_KEY is used."
fn spec.receivers.snsConfigs.sigv4.secretKey.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.sigv4.secretKey.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.snsConfigs.sigv4.secretKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs
"List of Telegram configurations."
fn spec.receivers.telegramConfigs.withApiURL
withApiURL(apiURL)
"The Telegram API URL i.e. https://api.telegram.org. If not specified, default API URL will be used."
fn spec.receivers.telegramConfigs.withChatID
withChatID(chatID)
"The Telegram chat ID."
fn spec.receivers.telegramConfigs.withDisableNotifications
withDisableNotifications(disableNotifications)
"Disable telegram notifications"
fn spec.receivers.telegramConfigs.withMessage
withMessage(message)
"Message template"
fn spec.receivers.telegramConfigs.withParseMode
withParseMode(parseMode)
"Parse mode for telegram message"
fn spec.receivers.telegramConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether to notify about resolved alerts."
obj spec.receivers.telegramConfigs.botToken
"Telegram bot token The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.telegramConfigs.botToken.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.botToken.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.botToken.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig
"HTTP client configuration."
fn spec.receivers.telegramConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."
fn spec.receivers.telegramConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"Optional proxy URL."
obj spec.receivers.telegramConfigs.httpConfig.authorization
"Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.telegramConfigs.httpConfig.authorization.withType
withType(type)
"Set the authentication type. Defaults to Bearer, Basic will cause an error"
obj spec.receivers.telegramConfigs.httpConfig.authorization.credentials
"The secret's key that contains the credentials of the request"
fn spec.receivers.telegramConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.basicAuth
"BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.telegramConfigs.httpConfig.basicAuth.password
"The secret in the service monitor namespace that contains the password for authentication."
fn spec.receivers.telegramConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.basicAuth.username
"The secret in the service monitor namespace that contains the username for authentication."
fn spec.receivers.telegramConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret
"The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.oauth2
"OAuth2 client credentials used to fetch a token for the targets."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"Parameters to append to the token URL"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"The URL to fetch the token from"
obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId
"The secret or configmap containing the OAuth2 client id"
obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret
"Secret containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret
"The secret containing the OAuth2 client secret"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig
"TLS configuration for the client."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs
"List of VictorOps configurations."
fn spec.receivers.victoropsConfigs.withApiUrl
withApiUrl(apiUrl)
"The VictorOps API URL."
fn spec.receivers.victoropsConfigs.withCustomFields
withCustomFields(customFields)
"Additional custom fields for notification."
fn spec.receivers.victoropsConfigs.withCustomFieldsMixin
withCustomFieldsMixin(customFields)
"Additional custom fields for notification."
Note: This function appends passed data to existing values
fn spec.receivers.victoropsConfigs.withEntityDisplayName
withEntityDisplayName(entityDisplayName)
"Contains summary of the alerted problem."
fn spec.receivers.victoropsConfigs.withMessageType
withMessageType(messageType)
"Describes the behavior of the alert (CRITICAL, WARNING, INFO)."
fn spec.receivers.victoropsConfigs.withMonitoringTool
withMonitoringTool(monitoringTool)
"The monitoring tool the state message is from."
fn spec.receivers.victoropsConfigs.withRoutingKey
withRoutingKey(routingKey)
"A key used to map the alert to a team."
fn spec.receivers.victoropsConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether or not to notify about resolved alerts."
fn spec.receivers.victoropsConfigs.withStateMessage
withStateMessage(stateMessage)
"Contains long explanation of the alerted problem."
obj spec.receivers.victoropsConfigs.apiKey
"The secret's key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.victoropsConfigs.apiKey.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.apiKey.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.apiKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.customFields
"Additional custom fields for notification."
fn spec.receivers.victoropsConfigs.customFields.withKey
withKey(key)
"Key of the tuple."
fn spec.receivers.victoropsConfigs.customFields.withValue
withValue(value)
"Value of the tuple."
obj spec.receivers.victoropsConfigs.httpConfig
"The HTTP client's configuration."
fn spec.receivers.victoropsConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."
fn spec.receivers.victoropsConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"Optional proxy URL."
obj spec.receivers.victoropsConfigs.httpConfig.authorization
"Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.victoropsConfigs.httpConfig.authorization.withType
withType(type)
"Set the authentication type. Defaults to Bearer, Basic will cause an error"
obj spec.receivers.victoropsConfigs.httpConfig.authorization.credentials
"The secret's key that contains the credentials of the request"
fn spec.receivers.victoropsConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.basicAuth
"BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.victoropsConfigs.httpConfig.basicAuth.password
"The secret in the service monitor namespace that contains the password for authentication."
fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.basicAuth.username
"The secret in the service monitor namespace that contains the username for authentication."
fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret
"The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.oauth2
"OAuth2 client credentials used to fetch a token for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"Parameters to append to the token URL"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"The URL to fetch the token from"
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId
"The secret or configmap containing the OAuth2 client id"
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret
"Secret containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret
"The secret containing the OAuth2 client secret"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig
"TLS configuration for the client."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs
"List of webhook configurations."
fn spec.receivers.webhookConfigs.withMaxAlerts
withMaxAlerts(maxAlerts)
"Maximum number of alerts to be sent per webhook message. When 0, all alerts are included."
fn spec.receivers.webhookConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether or not to notify about resolved alerts."
fn spec.receivers.webhookConfigs.withUrl
withUrl(url)
"The URL to send HTTP POST requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined."
obj spec.receivers.webhookConfigs.httpConfig
"HTTP client configuration."
fn spec.receivers.webhookConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."
fn spec.receivers.webhookConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"Optional proxy URL."
obj spec.receivers.webhookConfigs.httpConfig.authorization
"Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.webhookConfigs.httpConfig.authorization.withType
withType(type)
"Set the authentication type. Defaults to Bearer, Basic will cause an error"
obj spec.receivers.webhookConfigs.httpConfig.authorization.credentials
"The secret's key that contains the credentials of the request"
fn spec.receivers.webhookConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.basicAuth
"BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.webhookConfigs.httpConfig.basicAuth.password
"The secret in the service monitor namespace that contains the password for authentication."
fn spec.receivers.webhookConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.basicAuth.username
"The secret in the service monitor namespace that contains the username for authentication."
fn spec.receivers.webhookConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret
"The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.oauth2
"OAuth2 client credentials used to fetch a token for the targets."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"Parameters to append to the token URL"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"The URL to fetch the token from"
obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId
"The secret or configmap containing the OAuth2 client id"
obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret
"Secret containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret
"The secret containing the OAuth2 client secret"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig
"TLS configuration for the client."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.urlSecret
"The secret's key that contains the webhook URL to send HTTP requests to. urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.webhookConfigs.urlSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.urlSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.webhookConfigs.urlSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs
"List of WeChat configurations."
fn spec.receivers.wechatConfigs.withAgentID
withAgentID(agentID)
fn spec.receivers.wechatConfigs.withApiURL
withApiURL(apiURL)
"The WeChat API URL."
fn spec.receivers.wechatConfigs.withCorpID
withCorpID(corpID)
"The corp id for authentication."
fn spec.receivers.wechatConfigs.withMessage
withMessage(message)
"API request data as defined by the WeChat API."
fn spec.receivers.wechatConfigs.withMessageType
withMessageType(messageType)
fn spec.receivers.wechatConfigs.withSendResolved
withSendResolved(sendResolved)
"Whether or not to notify about resolved alerts."
fn spec.receivers.wechatConfigs.withToParty
withToParty(toParty)
fn spec.receivers.wechatConfigs.withToTag
withToTag(toTag)
fn spec.receivers.wechatConfigs.withToUser
withToUser(toUser)
obj spec.receivers.wechatConfigs.apiSecret
"The secret's key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.wechatConfigs.apiSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.apiSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.apiSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig
"HTTP client configuration."
fn spec.receivers.wechatConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"FollowRedirects specifies whether the client should follow HTTP 3xx redirects."
fn spec.receivers.wechatConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"Optional proxy URL."
obj spec.receivers.wechatConfigs.httpConfig.authorization
"Authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.wechatConfigs.httpConfig.authorization.withType
withType(type)
"Set the authentication type. Defaults to Bearer, Basic will cause an error"
obj spec.receivers.wechatConfigs.httpConfig.authorization.credentials
"The secret's key that contains the credentials of the request"
fn spec.receivers.wechatConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.basicAuth
"BasicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.wechatConfigs.httpConfig.basicAuth.password
"The secret in the service monitor namespace that contains the password for authentication."
fn spec.receivers.wechatConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.basicAuth.username
"The secret in the service monitor namespace that contains the username for authentication."
fn spec.receivers.wechatConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret
"The secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator."
fn spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.oauth2
"OAuth2 client credentials used to fetch a token for the targets."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"Parameters to append to the token URL"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"Parameters to append to the token URL"
Note: This function appends passed data to existing values
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"OAuth2 scopes used for the token request"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"OAuth2 scopes used for the token request"
Note: This function appends passed data to existing values
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"The URL to fetch the token from"
obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId
"The secret or configmap containing the OAuth2 client id"
obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret
"Secret containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret
"The secret containing the OAuth2 client secret"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig
"TLS configuration for the client."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"Disable target certificate validation."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"Used to verify the hostname for the targets."
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca
"Struct containing the CA cert to use for the targets."
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret
"Secret containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert
"Struct containing the client cert file for the targets."
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap
"ConfigMap containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret
"Secret containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret
"Secret containing the client key file for the targets."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?"
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.route
"The Alertmanager route definition for alerts matching the resource’s namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route."
fn spec.route.withContinue
withContinue(continue)
"Boolean indicating whether an alert should continue matching subsequent sibling nodes. It will always be overridden to true for the first-level route by the Prometheus operator."
fn spec.route.withGroupBy
withGroupBy(groupBy)
"List of labels to group by. Labels must not be repeated (unique list). Special label \"...\" (aggregate by all possible labels), if provided, must be the only element in the list."
fn spec.route.withGroupByMixin
withGroupByMixin(groupBy)
"List of labels to group by. Labels must not be repeated (unique list). Special label \"...\" (aggregate by all possible labels), if provided, must be the only element in the list."
Note: This function appends passed data to existing values
fn spec.route.withGroupInterval
withGroupInterval(groupInterval)
"How long to wait before sending an updated notification. Must match the regular expression^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$ Example: \"5m\
fn spec.route.withGroupWait
withGroupWait(groupWait)
"How long to wait before sending the initial notification. Must match the regular expression^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$ Example: \"30s\
fn spec.route.withMatchers
withMatchers(matchers)
"List of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher."
fn spec.route.withMatchersMixin
withMatchersMixin(matchers)
"List of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher."
Note: This function appends passed data to existing values
fn spec.route.withMuteTimeIntervals
withMuteTimeIntervals(muteTimeIntervals)
"Note: this comment applies to the field definition above but appears below otherwise it gets included in the generated manifest. CRD schema doesn't support self-referential types for now (see https://github.com/kubernetes/kubernetes/issues/62872). We have to use an alternative type to circumvent the limitation. The downside is that the Kube API can't validate the data beyond the fact that it is a valid JSON representation. MuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,"
fn spec.route.withMuteTimeIntervalsMixin
withMuteTimeIntervalsMixin(muteTimeIntervals)
"Note: this comment applies to the field definition above but appears below otherwise it gets included in the generated manifest. CRD schema doesn't support self-referential types for now (see https://github.com/kubernetes/kubernetes/issues/62872). We have to use an alternative type to circumvent the limitation. The downside is that the Kube API can't validate the data beyond the fact that it is a valid JSON representation. MuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,"
Note: This function appends passed data to existing values
fn spec.route.withReceiver
withReceiver(receiver)
"Name of the receiver for this route. If not empty, it should be listed in the receivers field."
fn spec.route.withRepeatInterval
withRepeatInterval(repeatInterval)
"How long to wait before repeating the last notification. Must match the regular expression^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$ Example: \"4h\
fn spec.route.withRoutes
withRoutes(routes)
"Child routes."
fn spec.route.withRoutesMixin
withRoutesMixin(routes)
"Child routes."
Note: This function appends passed data to existing values
obj spec.route.matchers
"List of matchers that the alert’s labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the namespace label and adds a namespace: <object namespace> matcher."
fn spec.route.matchers.withMatchType
withMatchType(matchType)
"Match operation available with AlertManager >= v0.22.0 and takes precedence over Regex (deprecated) if non-empty."
fn spec.route.matchers.withName
withName(name)
"Label to match."
fn spec.route.matchers.withRegex
withRegex(regex)
"Whether to match on equality (false) or regular-expression (true). Deprecated as of AlertManager >= v0.22.0 where a user should use MatchType instead."
fn spec.route.matchers.withValue
withValue(value)
"Label value to match."