monitoring.v1alpha1.alertmanagerConfig
"AlertmanagerConfig configures the Prometheus Alertmanager,\nspecifying how alerts should be grouped, inhibited and notified to external systems."
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 withDiscordConfigs(discordConfigs)fn withDiscordConfigsMixin(discordConfigs)fn withEmailConfigs(emailConfigs)fn withEmailConfigsMixin(emailConfigs)fn withMsteamsConfigs(msteamsConfigs)fn withMsteamsConfigsMixin(msteamsConfigs)fn withMsteamsv2Configs(msteamsv2Configs)fn withMsteamsv2ConfigsMixin(msteamsv2Configs)fn withName(name)fn withOpsgenieConfigs(opsgenieConfigs)fn withOpsgenieConfigsMixin(opsgenieConfigs)fn withPagerdutyConfigs(pagerdutyConfigs)fn withPagerdutyConfigsMixin(pagerdutyConfigs)fn withPushoverConfigs(pushoverConfigs)fn withPushoverConfigsMixin(pushoverConfigs)fn withRocketchatConfigs(rocketchatConfigs)fn withRocketchatConfigsMixin(rocketchatConfigs)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 withWebexConfigs(webexConfigs)fn withWebexConfigsMixin(webexConfigs)fn withWebhookConfigs(webhookConfigs)fn withWebhookConfigsMixin(webhookConfigs)fn withWechatConfigs(wechatConfigs)fn withWechatConfigsMixin(wechatConfigs)obj spec.receivers.discordConfigsfn withAvatarURL(avatarURL)fn withContent(content)fn withMessage(message)fn withSendResolved(sendResolved)fn withTitle(title)fn withUsername(username)obj spec.receivers.discordConfigs.apiURLobj spec.receivers.discordConfigs.httpConfigfn withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.discordConfigs.httpConfig.authorizationobj spec.receivers.discordConfigs.httpConfig.basicAuthobj spec.receivers.discordConfigs.httpConfig.bearerTokenSecretobj spec.receivers.discordConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.discordConfigs.httpConfig.oauth2.clientIdobj spec.receivers.discordConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.discordConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.discordConfigs.httpConfig.tlsConfig.caobj spec.receivers.discordConfigs.httpConfig.tlsConfig.certobj spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret
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.msteamsConfigsfn withSendResolved(sendResolved)fn withSummary(summary)fn withText(text)fn withTitle(title)obj spec.receivers.msteamsConfigs.httpConfigfn withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.msteamsConfigs.httpConfig.authorizationobj spec.receivers.msteamsConfigs.httpConfig.basicAuthobj spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecretobj spec.receivers.msteamsConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientIdobj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.msteamsConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.caobj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.certobj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret
obj spec.receivers.msteamsConfigs.webhookUrl
obj spec.receivers.msteamsv2Configsfn withSendResolved(sendResolved)fn withText(text)fn withTitle(title)obj spec.receivers.msteamsv2Configs.httpConfigfn withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.msteamsv2Configs.httpConfig.authorizationobj spec.receivers.msteamsv2Configs.httpConfig.basicAuthobj spec.receivers.msteamsv2Configs.httpConfig.bearerTokenSecretobj spec.receivers.msteamsv2Configs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientIdobj spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientSecretobj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.caobj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.certobj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.keySecret
obj spec.receivers.msteamsv2Configs.webhookURL
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 withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.opsgenieConfigs.httpConfig.authorizationobj spec.receivers.opsgenieConfigs.httpConfig.basicAuthobj spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecretobj spec.receivers.opsgenieConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientIdobj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.caobj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.certobj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.keySecret
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 withSource(source)fn withUrl(url)obj spec.receivers.pagerdutyConfigs.detailsobj spec.receivers.pagerdutyConfigs.httpConfigfn withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.pagerdutyConfigs.httpConfig.authorizationobj spec.receivers.pagerdutyConfigs.httpConfig.basicAuthobj spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecretobj spec.receivers.pagerdutyConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientIdobj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.caobj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.certobj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.keySecret
obj spec.receivers.pagerdutyConfigs.pagerDutyImageConfigsobj spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigsobj spec.receivers.pagerdutyConfigs.routingKeyobj spec.receivers.pagerdutyConfigs.serviceKey
obj spec.receivers.pushoverConfigsfn withDevice(device)fn withExpire(expire)fn withHtml(html)fn withMessage(message)fn withPriority(priority)fn withRetry(retry)fn withSendResolved(sendResolved)fn withSound(sound)fn withTitle(title)fn withTokenFile(tokenFile)fn withTtl(ttl)fn withUrl(url)fn withUrlTitle(urlTitle)fn withUserKeyFile(userKeyFile)obj spec.receivers.pushoverConfigs.httpConfigfn withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.pushoverConfigs.httpConfig.authorizationobj spec.receivers.pushoverConfigs.httpConfig.basicAuthobj spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecretobj spec.receivers.pushoverConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientIdobj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.caobj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.certobj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.keySecret
obj spec.receivers.pushoverConfigs.tokenobj spec.receivers.pushoverConfigs.userKey
obj spec.receivers.rocketchatConfigsfn withActions(actions)fn withActionsMixin(actions)fn withApiURL(apiURL)fn withChannel(channel)fn withColor(color)fn withEmoji(emoji)fn withFields(fields)fn withFieldsMixin(fields)fn withIconURL(iconURL)fn withImageURL(imageURL)fn withLinkNames(linkNames)fn withSendResolved(sendResolved)fn withShortFields(shortFields)fn withText(text)fn withThumbURL(thumbURL)fn withTitle(title)fn withTitleLink(titleLink)obj spec.receivers.rocketchatConfigs.actionsobj spec.receivers.rocketchatConfigs.fieldsobj spec.receivers.rocketchatConfigs.httpConfigfn withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.rocketchatConfigs.httpConfig.authorizationobj spec.receivers.rocketchatConfigs.httpConfig.basicAuthobj spec.receivers.rocketchatConfigs.httpConfig.bearerTokenSecretobj spec.receivers.rocketchatConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientIdobj spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.caobj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.certobj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.keySecret
obj spec.receivers.rocketchatConfigs.tokenobj spec.receivers.rocketchatConfigs.tokenID
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 withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.slackConfigs.httpConfig.authorizationobj spec.receivers.slackConfigs.httpConfig.basicAuthobj spec.receivers.slackConfigs.httpConfig.bearerTokenSecretobj spec.receivers.slackConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.slackConfigs.httpConfig.oauth2.clientIdobj spec.receivers.slackConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.slackConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.slackConfigs.httpConfig.tlsConfig.caobj spec.receivers.slackConfigs.httpConfig.tlsConfig.certobj spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret
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 withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.snsConfigs.httpConfig.authorizationobj spec.receivers.snsConfigs.httpConfig.basicAuthobj spec.receivers.snsConfigs.httpConfig.bearerTokenSecretobj spec.receivers.snsConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.snsConfigs.httpConfig.oauth2.clientIdobj spec.receivers.snsConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.snsConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.snsConfigs.httpConfig.tlsConfig.caobj spec.receivers.snsConfigs.httpConfig.tlsConfig.certobj spec.receivers.snsConfigs.httpConfig.tlsConfig.keySecret
obj spec.receivers.snsConfigs.sigv4
obj spec.receivers.telegramConfigsfn withApiURL(apiURL)fn withBotTokenFile(botTokenFile)fn withChatID(chatID)fn withDisableNotifications(disableNotifications)fn withMessage(message)fn withMessageThreadID(messageThreadID)fn withParseMode(parseMode)fn withSendResolved(sendResolved)obj spec.receivers.telegramConfigs.botTokenobj spec.receivers.telegramConfigs.httpConfigfn withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.telegramConfigs.httpConfig.authorizationobj spec.receivers.telegramConfigs.httpConfig.basicAuthobj spec.receivers.telegramConfigs.httpConfig.bearerTokenSecretobj spec.receivers.telegramConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientIdobj spec.receivers.telegramConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.telegramConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.caobj spec.receivers.telegramConfigs.httpConfig.tlsConfig.certobj spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret
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 withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.victoropsConfigs.httpConfig.authorizationobj spec.receivers.victoropsConfigs.httpConfig.basicAuthobj spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecretobj spec.receivers.victoropsConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientIdobj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.caobj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.certobj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret
obj spec.receivers.webexConfigsfn withApiURL(apiURL)fn withMessage(message)fn withRoomID(roomID)fn withSendResolved(sendResolved)obj spec.receivers.webexConfigs.httpConfigfn withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.webexConfigs.httpConfig.authorizationobj spec.receivers.webexConfigs.httpConfig.basicAuthobj spec.receivers.webexConfigs.httpConfig.bearerTokenSecretobj spec.receivers.webexConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.webexConfigs.httpConfig.oauth2.clientIdobj spec.receivers.webexConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.webexConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.webexConfigs.httpConfig.tlsConfig.caobj spec.receivers.webexConfigs.httpConfig.tlsConfig.certobj spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret
obj spec.receivers.webhookConfigsfn withMaxAlerts(maxAlerts)fn withSendResolved(sendResolved)fn withTimeout(timeout)fn withUrl(url)obj spec.receivers.webhookConfigs.httpConfigfn withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.webhookConfigs.httpConfig.authorizationobj spec.receivers.webhookConfigs.httpConfig.basicAuthobj spec.receivers.webhookConfigs.httpConfig.bearerTokenSecretobj spec.receivers.webhookConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientIdobj spec.receivers.webhookConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.webhookConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.caobj spec.receivers.webhookConfigs.httpConfig.tlsConfig.certobj spec.receivers.webhookConfigs.httpConfig.tlsConfig.keySecret
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 withEnableHttp2(enableHttp2)fn withFollowRedirects(followRedirects)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyURL(proxyURL)fn withProxyUrl(proxyUrl)obj spec.receivers.wechatConfigs.httpConfig.authorizationobj spec.receivers.wechatConfigs.httpConfig.basicAuthobj spec.receivers.wechatConfigs.httpConfig.bearerTokenSecretobj spec.receivers.wechatConfigs.httpConfig.oauth2fn withEndpointParams(endpointParams)fn withEndpointParamsMixin(endpointParams)fn withNoProxy(noProxy)fn withProxyConnectHeader(proxyConnectHeader)fn withProxyConnectHeaderMixin(proxyConnectHeader)fn withProxyFromEnvironment(proxyFromEnvironment)fn withProxyUrl(proxyUrl)fn withScopes(scopes)fn withScopesMixin(scopes)fn withTokenUrl(tokenUrl)obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientIdobj spec.receivers.wechatConfigs.httpConfig.oauth2.clientSecretobj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.caobj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.certobj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret
obj spec.receivers.wechatConfigs.httpConfig.tlsConfigfn withInsecureSkipVerify(insecureSkipVerify)fn withMaxVersion(maxVersion)fn withMinVersion(minVersion)fn withServerName(serverName)obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.caobj spec.receivers.wechatConfigs.httpConfig.tlsConfig.certobj spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret
obj spec.routefn withActiveTimeIntervals(activeTimeIntervals)fn withActiveTimeIntervalsMixin(activeTimeIntervals)fn 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
"spec defines the specification of AlertmanagerConfigSpec"
fn spec.withInhibitRules
withInhibitRules(inhibitRules)
"inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace."
fn spec.withInhibitRulesMixin
withInhibitRulesMixin(inhibitRules)
"inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace."
Note: This function appends passed data to existing values
fn spec.withMuteTimeIntervals
withMuteTimeIntervals(muteTimeIntervals)
"muteTimeIntervals defines the list of MuteTimeInterval specifying when the routes should be muted."
fn spec.withMuteTimeIntervalsMixin
withMuteTimeIntervalsMixin(muteTimeIntervals)
"muteTimeIntervals defines the list of MuteTimeInterval specifying when the routes should be muted."
Note: This function appends passed data to existing values
fn spec.withReceivers
withReceivers(receivers)
"receivers defines the list of receivers."
fn spec.withReceiversMixin
withReceiversMixin(receivers)
"receivers defines the list of receivers."
Note: This function appends passed data to existing values
obj spec.inhibitRules
"inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace."
fn spec.inhibitRules.withEqual
withEqual(equal)
"equal defines labels that must have an equal value in the source and target alert\nfor the inhibition to take effect. This ensures related alerts are properly grouped."
fn spec.inhibitRules.withEqualMixin
withEqualMixin(equal)
"equal defines labels that must have an equal value in the source and target alert\nfor the inhibition to take effect. This ensures related alerts are properly grouped."
Note: This function appends passed data to existing values
fn spec.inhibitRules.withSourceMatch
withSourceMatch(sourceMatch)
"sourceMatch defines matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the resource's namespace.\nThese are the \"trigger\" alerts that cause other alerts to be inhibited."
fn spec.inhibitRules.withSourceMatchMixin
withSourceMatchMixin(sourceMatch)
"sourceMatch defines matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the resource's namespace.\nThese are the \"trigger\" alerts that cause other alerts to be inhibited."
Note: This function appends passed data to existing values
fn spec.inhibitRules.withTargetMatch
withTargetMatch(targetMatch)
"targetMatch defines matchers that have to be fulfilled in the alerts to be muted.\nThe operator enforces that the alert matches the resource's namespace.\nWhen these conditions are met, matching alerts will be inhibited (silenced)."
fn spec.inhibitRules.withTargetMatchMixin
withTargetMatchMixin(targetMatch)
"targetMatch defines matchers that have to be fulfilled in the alerts to be muted.\nThe operator enforces that the alert matches the resource's namespace.\nWhen these conditions are met, matching alerts will be inhibited (silenced)."
Note: This function appends passed data to existing values
obj spec.inhibitRules.sourceMatch
"sourceMatch defines matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the resource's namespace.\nThese are the \"trigger\" alerts that cause other alerts to be inhibited."
fn spec.inhibitRules.sourceMatch.withMatchType
withMatchType(matchType)
"matchType defines the match operation available with AlertManager >= v0.22.0.\nTakes precedence over Regex (deprecated) if non-empty.\nValid values: \"=\" (equality), \"!=\" (inequality), \"=~\" (regex match), \"!~\" (regex non-match)."
fn spec.inhibitRules.sourceMatch.withName
withName(name)
"name defines the label to match.\nThis specifies which alert label should be evaluated."
fn spec.inhibitRules.sourceMatch.withRegex
withRegex(regex)
"regex defines whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, matchType should be used instead."
fn spec.inhibitRules.sourceMatch.withValue
withValue(value)
"value defines the label value to match.\nThis is the expected value for the specified label."
obj spec.inhibitRules.targetMatch
"targetMatch defines matchers that have to be fulfilled in the alerts to be muted.\nThe operator enforces that the alert matches the resource's namespace.\nWhen these conditions are met, matching alerts will be inhibited (silenced)."
fn spec.inhibitRules.targetMatch.withMatchType
withMatchType(matchType)
"matchType defines the match operation available with AlertManager >= v0.22.0.\nTakes precedence over Regex (deprecated) if non-empty.\nValid values: \"=\" (equality), \"!=\" (inequality), \"=~\" (regex match), \"!~\" (regex non-match)."
fn spec.inhibitRules.targetMatch.withName
withName(name)
"name defines the label to match.\nThis specifies which alert label should be evaluated."
fn spec.inhibitRules.targetMatch.withRegex
withRegex(regex)
"regex defines whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, matchType should be used instead."
fn spec.inhibitRules.targetMatch.withValue
withValue(value)
"value defines the label value to match.\nThis is the expected value for the specified label."
obj spec.muteTimeIntervals
"muteTimeIntervals defines the 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 defines a list of TimeInterval"
fn spec.muteTimeIntervals.withTimeIntervalsMixin
withTimeIntervalsMixin(timeIntervals)
"timeIntervals defines a list of TimeInterval"
Note: This function appends passed data to existing values
obj spec.muteTimeIntervals.timeIntervals
"timeIntervals defines a list of TimeInterval"
fn spec.muteTimeIntervals.timeIntervals.withDaysOfMonth
withDaysOfMonth(daysOfMonth)
"daysOfMonth defines a list of DayOfMonthRange"
fn spec.muteTimeIntervals.timeIntervals.withDaysOfMonthMixin
withDaysOfMonthMixin(daysOfMonth)
"daysOfMonth defines a list of DayOfMonthRange"
Note: This function appends passed data to existing values
fn spec.muteTimeIntervals.timeIntervals.withMonths
withMonths(months)
"months defines a list of MonthRange"
fn spec.muteTimeIntervals.timeIntervals.withMonthsMixin
withMonthsMixin(months)
"months defines a list of MonthRange"
Note: This function appends passed data to existing values
fn spec.muteTimeIntervals.timeIntervals.withTimes
withTimes(times)
"times defines a list of TimeRange"
fn spec.muteTimeIntervals.timeIntervals.withTimesMixin
withTimesMixin(times)
"times defines a list of TimeRange"
Note: This function appends passed data to existing values
fn spec.muteTimeIntervals.timeIntervals.withWeekdays
withWeekdays(weekdays)
"weekdays defines a list of WeekdayRange"
fn spec.muteTimeIntervals.timeIntervals.withWeekdaysMixin
withWeekdaysMixin(weekdays)
"weekdays defines a list of WeekdayRange"
Note: This function appends passed data to existing values
fn spec.muteTimeIntervals.timeIntervals.withYears
withYears(years)
"years defines a list of YearRange"
fn spec.muteTimeIntervals.timeIntervals.withYearsMixin
withYearsMixin(years)
"years defines a list of YearRange"
Note: This function appends passed data to existing values
obj spec.muteTimeIntervals.timeIntervals.daysOfMonth
"daysOfMonth defines 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 defines a list of TimeRange"
fn spec.muteTimeIntervals.timeIntervals.times.withEndTime
withEndTime(endTime)
"endTime defines the end time in 24hr format."
fn spec.muteTimeIntervals.timeIntervals.times.withStartTime
withStartTime(startTime)
"startTime defines the start time in 24hr format."
obj spec.receivers
"receivers defines the list of receivers."
fn spec.receivers.withDiscordConfigs
withDiscordConfigs(discordConfigs)
"discordConfigs defines the list of Slack configurations."
fn spec.receivers.withDiscordConfigsMixin
withDiscordConfigsMixin(discordConfigs)
"discordConfigs defines the list of Slack configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withEmailConfigs
withEmailConfigs(emailConfigs)
"emailConfigs defines the list of Email configurations."
fn spec.receivers.withEmailConfigsMixin
withEmailConfigsMixin(emailConfigs)
"emailConfigs defines the list of Email configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withMsteamsConfigs
withMsteamsConfigs(msteamsConfigs)
"msteamsConfigs defines the list of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0."
fn spec.receivers.withMsteamsConfigsMixin
withMsteamsConfigsMixin(msteamsConfigs)
"msteamsConfigs defines the list of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0."
Note: This function appends passed data to existing values
fn spec.receivers.withMsteamsv2Configs
withMsteamsv2Configs(msteamsv2Configs)
"msteamsv2Configs defines the list of MSTeamsV2 configurations.\nIt requires Alertmanager >= 0.28.0."
fn spec.receivers.withMsteamsv2ConfigsMixin
withMsteamsv2ConfigsMixin(msteamsv2Configs)
"msteamsv2Configs defines the list of MSTeamsV2 configurations.\nIt requires Alertmanager >= 0.28.0."
Note: This function appends passed data to existing values
fn spec.receivers.withName
withName(name)
"name defines the name of the receiver. Must be unique across all items from the list."
fn spec.receivers.withOpsgenieConfigs
withOpsgenieConfigs(opsgenieConfigs)
"opsgenieConfigs defines the list of OpsGenie configurations."
fn spec.receivers.withOpsgenieConfigsMixin
withOpsgenieConfigsMixin(opsgenieConfigs)
"opsgenieConfigs defines the list of OpsGenie configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withPagerdutyConfigs
withPagerdutyConfigs(pagerdutyConfigs)
"pagerdutyConfigs defines the List of PagerDuty configurations."
fn spec.receivers.withPagerdutyConfigsMixin
withPagerdutyConfigsMixin(pagerdutyConfigs)
"pagerdutyConfigs defines the List of PagerDuty configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withPushoverConfigs
withPushoverConfigs(pushoverConfigs)
"pushoverConfigs defines the list of Pushover configurations."
fn spec.receivers.withPushoverConfigsMixin
withPushoverConfigsMixin(pushoverConfigs)
"pushoverConfigs defines the list of Pushover configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withRocketchatConfigs
withRocketchatConfigs(rocketchatConfigs)
"rocketchatConfigs defines the list of RocketChat configurations.\nIt requires Alertmanager >= 0.28.0."
fn spec.receivers.withRocketchatConfigsMixin
withRocketchatConfigsMixin(rocketchatConfigs)
"rocketchatConfigs defines the list of RocketChat configurations.\nIt requires Alertmanager >= 0.28.0."
Note: This function appends passed data to existing values
fn spec.receivers.withSlackConfigs
withSlackConfigs(slackConfigs)
"slackConfigs defines the list of Slack configurations."
fn spec.receivers.withSlackConfigsMixin
withSlackConfigsMixin(slackConfigs)
"slackConfigs defines the list of Slack configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withSnsConfigs
withSnsConfigs(snsConfigs)
"snsConfigs defines the list of SNS configurations"
fn spec.receivers.withSnsConfigsMixin
withSnsConfigsMixin(snsConfigs)
"snsConfigs defines the list of SNS configurations"
Note: This function appends passed data to existing values
fn spec.receivers.withTelegramConfigs
withTelegramConfigs(telegramConfigs)
"telegramConfigs defines the list of Telegram configurations."
fn spec.receivers.withTelegramConfigsMixin
withTelegramConfigsMixin(telegramConfigs)
"telegramConfigs defines the list of Telegram configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withVictoropsConfigs
withVictoropsConfigs(victoropsConfigs)
"victoropsConfigs defines the list of VictorOps configurations."
fn spec.receivers.withVictoropsConfigsMixin
withVictoropsConfigsMixin(victoropsConfigs)
"victoropsConfigs defines the list of VictorOps configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withWebexConfigs
withWebexConfigs(webexConfigs)
"webexConfigs defines the list of Webex configurations."
fn spec.receivers.withWebexConfigsMixin
withWebexConfigsMixin(webexConfigs)
"webexConfigs defines the list of Webex configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withWebhookConfigs
withWebhookConfigs(webhookConfigs)
"webhookConfigs defines the List of webhook configurations."
fn spec.receivers.withWebhookConfigsMixin
withWebhookConfigsMixin(webhookConfigs)
"webhookConfigs defines the List of webhook configurations."
Note: This function appends passed data to existing values
fn spec.receivers.withWechatConfigs
withWechatConfigs(wechatConfigs)
"wechatConfigs defines the list of WeChat configurations."
fn spec.receivers.withWechatConfigsMixin
withWechatConfigsMixin(wechatConfigs)
"wechatConfigs defines the list of WeChat configurations."
Note: This function appends passed data to existing values
obj spec.receivers.discordConfigs
"discordConfigs defines the list of Slack configurations."
fn spec.receivers.discordConfigs.withAvatarURL
withAvatarURL(avatarURL)
"avatarURL defines the avatar url of the message sender."
fn spec.receivers.discordConfigs.withContent
withContent(content)
"content defines the template of the content's body."
fn spec.receivers.discordConfigs.withMessage
withMessage(message)
"message defines the template of the message's body."
fn spec.receivers.discordConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.discordConfigs.withTitle
withTitle(title)
"title defines the template of the message's title."
fn spec.receivers.discordConfigs.withUsername
withUsername(username)
"username defines the username of the message sender."
obj spec.receivers.discordConfigs.apiURL
"apiURL defines the secret's key that contains the Discord webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.discordConfigs.apiURL.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.apiURL.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.apiURL.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig
"httpConfig defines the HTTP client configuration."
fn spec.receivers.discordConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.discordConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.discordConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.discordConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.discordConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.discordConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.discordConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.discordConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.discordConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.discordConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.discordConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
fn spec.receivers.discordConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.basicAuth
"basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.discordConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
fn spec.receivers.discordConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.basicAuth.username
"username defines a key of a Secret containing the username for\nauthentication."
fn spec.receivers.discordConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.bearerTokenSecret
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.discordConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.oauth2
"oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.discordConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.discordConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.discordConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.discordConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.discordConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.discordConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.discordConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.discordConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.discordConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.discordConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.discordConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret
"clientSecret defines a key of a Secret containing the OAuth2\nclient's secret."
fn spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.discordConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.discordConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.emailConfigs
"emailConfigs defines the list of Email configurations."
fn spec.receivers.emailConfigs.withAuthIdentity
withAuthIdentity(authIdentity)
"authIdentity defines the identity to use for SMTP authentication.\nThis is typically used with PLAIN authentication mechanism."
fn spec.receivers.emailConfigs.withAuthUsername
withAuthUsername(authUsername)
"authUsername defines the username to use for SMTP authentication.\nThis is used for SMTP AUTH when the server requires authentication."
fn spec.receivers.emailConfigs.withFrom
withFrom(from)
"from defines the sender address for email notifications.\nThis appears as the \"From\" field in the email header."
fn spec.receivers.emailConfigs.withHeaders
withHeaders(headers)
"headers defines additional email header key/value pairs.\nThese override any headers previously set by the notification implementation."
fn spec.receivers.emailConfigs.withHeadersMixin
withHeadersMixin(headers)
"headers defines additional email header key/value pairs.\nThese override any headers previously set by the notification implementation."
Note: This function appends passed data to existing values
fn spec.receivers.emailConfigs.withHello
withHello(hello)
"hello defines the hostname to identify to the SMTP server.\nThis is used in the SMTP HELO/EHLO command during the connection handshake."
fn spec.receivers.emailConfigs.withHtml
withHtml(html)
"html defines the HTML body of the email notification.\nThis allows for rich formatting in the email content."
fn spec.receivers.emailConfigs.withRequireTLS
withRequireTLS(requireTLS)
"requireTLS defines the SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints."
fn spec.receivers.emailConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.emailConfigs.withSmarthost
withSmarthost(smarthost)
"smarthost defines the SMTP host and port through which emails are sent.\nFormat should be \"hostname:port\", e.g. \"smtp.example.com:587\"."
fn spec.receivers.emailConfigs.withText
withText(text)
"text defines the plain text body of the email notification.\nThis provides a fallback for email clients that don't support HTML."
fn spec.receivers.emailConfigs.withTo
withTo(to)
"to defines the email address to send notifications to.\nThis is the recipient address for alert notifications."
obj spec.receivers.emailConfigs.authPassword
"authPassword defines the secret's key that contains the password to use for authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.emailConfigs.authPassword.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.emailConfigs.authPassword.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.emailConfigs.authSecret
"authSecret defines the secret's key that contains the CRAM-MD5 secret.\nThis is used for CRAM-MD5 authentication mechanism.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.emailConfigs.authSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.emailConfigs.authSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.emailConfigs.headers
"headers defines additional email header key/value pairs.\nThese override any headers previously set by the notification implementation."
fn spec.receivers.emailConfigs.headers.withKey
withKey(key)
"key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair."
fn spec.receivers.emailConfigs.headers.withValue
withValue(value)
"value defines the value of the tuple.\nThis is the data or content associated with the key."
obj spec.receivers.emailConfigs.tlsConfig
"tlsConfig defines the TLS configuration for SMTP connections.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.emailConfigs.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.emailConfigs.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.emailConfigs.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.emailConfigs.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.emailConfigs.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.emailConfigs.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.emailConfigs.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.emailConfigs.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs
"msteamsConfigs defines the list of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0."
fn spec.receivers.msteamsConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.msteamsConfigs.withSummary
withSummary(summary)
"summary defines the message summary template for Teams notifications.\nThis provides a brief overview that appears in Teams notification previews.\nIt requires Alertmanager >= 0.27.0."
fn spec.receivers.msteamsConfigs.withText
withText(text)
"text defines the message body template for Teams notifications.\nThis contains the detailed content of the Teams message."
fn spec.receivers.msteamsConfigs.withTitle
withTitle(title)
"title defines the message title template for Teams notifications.\nThis appears as the main heading of the Teams message card."
obj spec.receivers.msteamsConfigs.httpConfig
"httpConfig defines the HTTP client configuration for Teams webhook requests."
fn spec.receivers.msteamsConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.msteamsConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.msteamsConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.msteamsConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.msteamsConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.msteamsConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.msteamsConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.msteamsConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
fn spec.receivers.msteamsConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.basicAuth
"basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.msteamsConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.basicAuth.username
"username defines a key of a Secret containing the username for\nauthentication."
fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecret
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.oauth2
"oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecret
"clientSecret defines a key of a Secret containing the OAuth2\nclient's secret."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsConfigs.webhookUrl
"webhookUrl defines the MSTeams webhook URL for sending notifications.\nThis is the incoming webhook URL configured in your Teams channel."
fn spec.receivers.msteamsConfigs.webhookUrl.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsConfigs.webhookUrl.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsConfigs.webhookUrl.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs
"msteamsv2Configs defines the list of MSTeamsV2 configurations.\nIt requires Alertmanager >= 0.28.0."
fn spec.receivers.msteamsv2Configs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.msteamsv2Configs.withText
withText(text)
"text defines the message body template for adaptive card notifications.\nThis contains the detailed content displayed in the Teams adaptive card format."
fn spec.receivers.msteamsv2Configs.withTitle
withTitle(title)
"title defines the message title template for adaptive card notifications.\nThis appears as the main heading in the Teams adaptive card."
obj spec.receivers.msteamsv2Configs.httpConfig
"httpConfig defines the HTTP client configuration for Teams webhook requests."
fn spec.receivers.msteamsv2Configs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.msteamsv2Configs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.msteamsv2Configs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsv2Configs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsv2Configs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.msteamsv2Configs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsv2Configs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.msteamsv2Configs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.msteamsv2Configs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.msteamsv2Configs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.msteamsv2Configs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
fn spec.receivers.msteamsv2Configs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.basicAuth
"basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.msteamsv2Configs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
fn spec.receivers.msteamsv2Configs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.basicAuth.username
"username defines a key of a Secret containing the username for\nauthentication."
fn spec.receivers.msteamsv2Configs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.bearerTokenSecret
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.msteamsv2Configs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2
"oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientId.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientId.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientSecret
"clientSecret defines a key of a Secret containing the OAuth2\nclient's secret."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.msteamsv2Configs.webhookURL
"webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications.\nThis webhook must support the newer adaptive cards format required by Teams flows."
fn spec.receivers.msteamsv2Configs.webhookURL.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.msteamsv2Configs.webhookURL.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.msteamsv2Configs.webhookURL.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs
"opsgenieConfigs defines the list of OpsGenie configurations."
fn spec.receivers.opsgenieConfigs.withActions
withActions(actions)
"actions defines a comma separated list of actions that will be available for the alert.\nThese appear as action buttons in the OpsGenie interface."
fn spec.receivers.opsgenieConfigs.withApiURL
withApiURL(apiURL)
"apiURL defines the URL to send OpsGenie API requests to.\nWhen not specified, defaults to the standard OpsGenie API endpoint."
fn spec.receivers.opsgenieConfigs.withDescription
withDescription(description)
"description defines the detailed description of the incident.\nThis provides additional context beyond the message field."
fn spec.receivers.opsgenieConfigs.withDetails
withDetails(details)
"details defines a set of arbitrary key/value pairs that provide further detail about the incident.\nThese appear as additional fields in the OpsGenie alert."
fn spec.receivers.opsgenieConfigs.withDetailsMixin
withDetailsMixin(details)
"details defines a set of arbitrary key/value pairs that provide further detail about the incident.\nThese appear as additional fields in the OpsGenie alert."
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.withEntity
withEntity(entity)
"entity defines an optional field that can be used to specify which domain alert is related to.\nThis helps group related alerts together in OpsGenie."
fn spec.receivers.opsgenieConfigs.withMessage
withMessage(message)
"message defines the alert text limited to 130 characters.\nThis appears as the main alert title in OpsGenie."
fn spec.receivers.opsgenieConfigs.withNote
withNote(note)
"note defines an additional alert note.\nThis provides supplementary information about the alert."
fn spec.receivers.opsgenieConfigs.withPriority
withPriority(priority)
"priority defines the priority level of alert.\nPossible values are P1, P2, P3, P4, and P5, where P1 is highest priority."
fn spec.receivers.opsgenieConfigs.withResponders
withResponders(responders)
"responders defines the list of responders responsible for notifications.\nThese determine who gets notified when the alert is created."
fn spec.receivers.opsgenieConfigs.withRespondersMixin
withRespondersMixin(responders)
"responders defines the list of responders responsible for notifications.\nThese determine who gets notified when the alert is created."
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.opsgenieConfigs.withSource
withSource(source)
"source defines the backlink to the sender of the notification.\nThis helps identify where the alert originated from."
fn spec.receivers.opsgenieConfigs.withTags
withTags(tags)
"tags defines a comma separated list of tags attached to the notifications.\nThese help categorize and filter alerts within OpsGenie."
fn spec.receivers.opsgenieConfigs.withUpdateAlerts
withUpdateAlerts(updateAlerts)
"updateAlerts defines Whether to update message and description of the alert in OpsGenie if it already exists\nBy default, the alert is never updated in OpsGenie, the new message only appears in activity log."
obj spec.receivers.opsgenieConfigs.apiKey
"apiKey defines the secret's key that contains the OpsGenie API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.opsgenieConfigs.apiKey.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.opsgenieConfigs.apiKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.details
"details defines a set of arbitrary key/value pairs that provide further detail about the incident.\nThese appear as additional fields in the OpsGenie alert."
fn spec.receivers.opsgenieConfigs.details.withKey
withKey(key)
"key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair."
fn spec.receivers.opsgenieConfigs.details.withValue
withValue(value)
"value defines the value of the tuple.\nThis is the data or content associated with the key."
obj spec.receivers.opsgenieConfigs.httpConfig
"httpConfig defines the HTTP client configuration for OpsGenie API requests."
fn spec.receivers.opsgenieConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.opsgenieConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.opsgenieConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.opsgenieConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.opsgenieConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.opsgenieConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.opsgenieConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.opsgenieConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.opsgenieConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.opsgenieConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.opsgenieConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"username defines a key of a Secret containing the username for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.opsgenieConfigs.httpConfig.bearerTokenSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"clientSecret defines a key of a Secret containing the OAuth2\nclient's 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.opsgenieConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.opsgenieConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"responders defines the list of responders responsible for notifications.\nThese determine who gets notified when the alert is created."
fn spec.receivers.opsgenieConfigs.responders.withId
withId(id)
"id defines the unique identifier of the responder.\nThis corresponds to the responder's ID within OpsGenie."
fn spec.receivers.opsgenieConfigs.responders.withName
withName(name)
"name defines the display name of the responder.\nThis is used when the responder is identified by name rather than ID."
fn spec.receivers.opsgenieConfigs.responders.withType
withType(type)
"type defines the type of responder.\nValid values include \"user\", \"team\", \"schedule\", and \"escalation\".\nThis determines how OpsGenie interprets the other identifier fields."
fn spec.receivers.opsgenieConfigs.responders.withUsername
withUsername(username)
"username defines the username of the responder.\nThis is typically used for user-type responders when identifying by username."
obj spec.receivers.pagerdutyConfigs
"pagerdutyConfigs defines the List of PagerDuty configurations."
fn spec.receivers.pagerdutyConfigs.withClass
withClass(class)
"class defines the class/type of the event."
fn spec.receivers.pagerdutyConfigs.withClient
withClient(client)
"client defines the client identification."
fn spec.receivers.pagerdutyConfigs.withClientURL
withClientURL(clientURL)
"clientURL defines the backlink to the sender of notification."
fn spec.receivers.pagerdutyConfigs.withComponent
withComponent(component)
"component defines 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)
"details defines the arbitrary key/value pairs that provide further detail about the incident."
fn spec.receivers.pagerdutyConfigs.withDetailsMixin
withDetailsMixin(details)
"details defines the 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)
"group defines a cluster or grouping of sources."
fn spec.receivers.pagerdutyConfigs.withPagerDutyImageConfigs
withPagerDutyImageConfigs(pagerDutyImageConfigs)
"pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident."
fn spec.receivers.pagerdutyConfigs.withPagerDutyImageConfigsMixin
withPagerDutyImageConfigsMixin(pagerDutyImageConfigs)
"pagerDutyImageConfigs defines 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)
"pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident."
fn spec.receivers.pagerdutyConfigs.withPagerDutyLinkConfigsMixin
withPagerDutyLinkConfigsMixin(pagerDutyLinkConfigs)
"pagerDutyLinkConfigs defines 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)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.pagerdutyConfigs.withSeverity
withSeverity(severity)
"severity of the incident."
fn spec.receivers.pagerdutyConfigs.withSource
withSource(source)
"source defines the unique location of the affected system."
fn spec.receivers.pagerdutyConfigs.withUrl
withUrl(url)
"url defines the URL to send requests to."
obj spec.receivers.pagerdutyConfigs.details
"details defines the arbitrary key/value pairs that provide further detail about the incident."
fn spec.receivers.pagerdutyConfigs.details.withKey
withKey(key)
"key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair."
fn spec.receivers.pagerdutyConfigs.details.withValue
withValue(value)
"value defines the value of the tuple.\nThis is the data or content associated with the key."
obj spec.receivers.pagerdutyConfigs.httpConfig
"httpConfig defines the HTTP client configuration."
fn spec.receivers.pagerdutyConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.pagerdutyConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.pagerdutyConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.pagerdutyConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.pagerdutyConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.pagerdutyConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.pagerdutyConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.pagerdutyConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.pagerdutyConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"username defines a key of a Secret containing the username for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.pagerdutyConfigs.httpConfig.bearerTokenSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"clientSecret defines a key of a Secret containing the OAuth2\nclient's 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pagerdutyConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.pagerdutyConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"pagerDutyImageConfigs defines 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)
"href defines the 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
"pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident."
fn spec.receivers.pagerdutyConfigs.pagerDutyLinkConfigs.withAlt
withAlt(alt)
"alt defines the 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 defines the URL of the link to be attached"
obj spec.receivers.pagerdutyConfigs.routingKey
"routingKey defines the secret's key that contains the PagerDuty integration key (when using\nEvents API v2). Either this field or serviceKey needs to be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.pagerdutyConfigs.routingKey.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pagerdutyConfigs.routingKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pagerdutyConfigs.serviceKey
"serviceKey defines the secret's key that contains the PagerDuty service key (when using\nintegration type \"Prometheus\"). Either this field or routingKey needs to\nbe defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.pagerdutyConfigs.serviceKey.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pagerdutyConfigs.serviceKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs
"pushoverConfigs defines the list of Pushover configurations."
fn spec.receivers.pushoverConfigs.withDevice
withDevice(device)
"device defines the name of a specific device to send the notification to.\nIf not specified, the notification is sent to all user's devices."
fn spec.receivers.pushoverConfigs.withExpire
withExpire(expire)
"expire defines how long your notification will continue to be retried for,\nunless the user acknowledges the notification. Only applies to priority 2 notifications."
fn spec.receivers.pushoverConfigs.withHtml
withHtml(html)
"html defines whether notification message is HTML or plain text.\nWhen true, the message can include HTML formatting tags."
fn spec.receivers.pushoverConfigs.withMessage
withMessage(message)
"message defines the notification message content.\nThis is the main body text of the Pushover notification."
fn spec.receivers.pushoverConfigs.withPriority
withPriority(priority)
"priority defines the notification priority level.\nSee https://pushover.net/api#priority for valid values and behavior."
fn spec.receivers.pushoverConfigs.withRetry
withRetry(retry)
"retry defines how often the Pushover servers will send the same notification to the user.\nMust be at least 30 seconds. Only applies to priority 2 notifications."
fn spec.receivers.pushoverConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.pushoverConfigs.withSound
withSound(sound)
"sound defines the name of one of the sounds supported by device clients.\nThis overrides the user's default sound choice for this notification."
fn spec.receivers.pushoverConfigs.withTitle
withTitle(title)
"title defines the notification title displayed in the Pushover message.\nThis appears as the bold header text in the notification."
fn spec.receivers.pushoverConfigs.withTokenFile
withTokenFile(tokenFile)
"tokenFile defines the token file that contains the registered application's API token.\nSee https://pushover.net/apps for application registration.\nEither token or tokenFile is required.\nIt requires Alertmanager >= v0.26.0."
fn spec.receivers.pushoverConfigs.withTtl
withTtl(ttl)
"ttl defines the time to live for the alert notification.\nThis determines how long the notification remains active before expiring."
fn spec.receivers.pushoverConfigs.withUrl
withUrl(url)
"url defines a supplementary URL shown alongside the message.\nThis creates a clickable link within the Pushover notification."
fn spec.receivers.pushoverConfigs.withUrlTitle
withUrlTitle(urlTitle)
"urlTitle defines a title for the supplementary URL.\nIf not specified, the raw URL is shown instead."
fn spec.receivers.pushoverConfigs.withUserKeyFile
withUserKeyFile(userKeyFile)
"userKeyFile defines the user key file that contains the recipient user's user key.\nEither userKey or userKeyFile is required.\nIt requires Alertmanager >= v0.26.0."
obj spec.receivers.pushoverConfigs.httpConfig
"httpConfig defines the HTTP client configuration for Pushover API requests."
fn spec.receivers.pushoverConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.pushoverConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.pushoverConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pushoverConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pushoverConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.pushoverConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pushoverConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.pushoverConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.pushoverConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.pushoverConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.pushoverConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.pushoverConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"username defines a key of a Secret containing the username for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.pushoverConfigs.httpConfig.bearerTokenSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"clientSecret defines a key of a Secret containing the OAuth2\nclient's 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pushoverConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.pushoverConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.pushoverConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"token defines the secret's key that contains the registered application's API token.\nSee https://pushover.net/apps for application registration.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither token or tokenFile is required."
fn spec.receivers.pushoverConfigs.token.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pushoverConfigs.token.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.pushoverConfigs.userKey
"userKey defines the secret's key that contains the recipient user's user key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither userKey or userKeyFile is required."
fn spec.receivers.pushoverConfigs.userKey.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.pushoverConfigs.userKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs
"rocketchatConfigs defines the list of RocketChat configurations.\nIt requires Alertmanager >= 0.28.0."
fn spec.receivers.rocketchatConfigs.withActions
withActions(actions)
"actions defines interactive actions to include in the message.\nThese appear as buttons that users can click to trigger responses."
fn spec.receivers.rocketchatConfigs.withActionsMixin
withActionsMixin(actions)
"actions defines interactive actions to include in the message.\nThese appear as buttons that users can click to trigger responses."
Note: This function appends passed data to existing values
fn spec.receivers.rocketchatConfigs.withApiURL
withApiURL(apiURL)
"apiURL defines the API URL for RocketChat.\nDefaults to https://open.rocket.chat/ if not specified."
fn spec.receivers.rocketchatConfigs.withChannel
withChannel(channel)
"channel defines the channel to send alerts to.\nThis can be a channel name (e.g., \"#alerts\") or a direct message recipient."
fn spec.receivers.rocketchatConfigs.withColor
withColor(color)
"color defines the message color displayed in RocketChat.\nThis appears as a colored bar alongside the message."
fn spec.receivers.rocketchatConfigs.withEmoji
withEmoji(emoji)
"emoji defines the emoji to be displayed as an avatar.\nIf provided, this emoji will be used instead of the default avatar or iconURL."
fn spec.receivers.rocketchatConfigs.withFields
withFields(fields)
"fields defines additional fields for the message attachment.\nThese appear as structured key-value pairs within the message."
fn spec.receivers.rocketchatConfigs.withFieldsMixin
withFieldsMixin(fields)
"fields defines additional fields for the message attachment.\nThese appear as structured key-value pairs within the message."
Note: This function appends passed data to existing values
fn spec.receivers.rocketchatConfigs.withIconURL
withIconURL(iconURL)
"iconURL defines the icon URL for the message avatar.\nThis displays a custom image as the message sender's avatar."
fn spec.receivers.rocketchatConfigs.withImageURL
withImageURL(imageURL)
"imageURL defines the image URL to display within the message.\nThis embeds an image directly in the message attachment."
fn spec.receivers.rocketchatConfigs.withLinkNames
withLinkNames(linkNames)
"linkNames defines whether to enable automatic linking of usernames and channels.\nWhen true, @username and #channel references become clickable links."
fn spec.receivers.rocketchatConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.rocketchatConfigs.withShortFields
withShortFields(shortFields)
"shortFields defines whether to use short fields in the message layout.\nWhen true, fields may be displayed side by side to save space."
fn spec.receivers.rocketchatConfigs.withText
withText(text)
"text defines the message text to send.\nThis is optional because attachments can be used instead of or alongside text."
fn spec.receivers.rocketchatConfigs.withThumbURL
withThumbURL(thumbURL)
"thumbURL defines the thumbnail URL for the message.\nThis displays a small thumbnail image alongside the message content."
fn spec.receivers.rocketchatConfigs.withTitle
withTitle(title)
"title defines the message title displayed prominently in the message.\nThis appears as bold text at the top of the message attachment."
fn spec.receivers.rocketchatConfigs.withTitleLink
withTitleLink(titleLink)
"titleLink defines the URL that the title will link to when clicked.\nThis makes the message title clickable in the RocketChat interface."
obj spec.receivers.rocketchatConfigs.actions
"actions defines interactive actions to include in the message.\nThese appear as buttons that users can click to trigger responses."
fn spec.receivers.rocketchatConfigs.actions.withMsg
withMsg(msg)
"msg defines the message to send when the button is clicked.\nThis allows the button to post a predefined message to the channel."
fn spec.receivers.rocketchatConfigs.actions.withText
withText(text)
"text defines the button text displayed to users.\nThis is the label that appears on the interactive button."
fn spec.receivers.rocketchatConfigs.actions.withUrl
withUrl(url)
"url defines the URL the button links to when clicked.\nThis creates a clickable button that opens the specified URL."
obj spec.receivers.rocketchatConfigs.fields
"fields defines additional fields for the message attachment.\nThese appear as structured key-value pairs within the message."
fn spec.receivers.rocketchatConfigs.fields.withShort
withShort(short)
"short defines whether this field should be a short field.\nWhen true, the field may be displayed inline with other short fields to save space."
fn spec.receivers.rocketchatConfigs.fields.withTitle
withTitle(title)
"title defines the title of this field.\nThis appears as bold text labeling the field content."
fn spec.receivers.rocketchatConfigs.fields.withValue
withValue(value)
"value defines the value of this field, displayed underneath the title.\nThis contains the actual data or content for the field."
obj spec.receivers.rocketchatConfigs.httpConfig
"httpConfig defines the HTTP client configuration for RocketChat API requests."
fn spec.receivers.rocketchatConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.rocketchatConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.rocketchatConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.rocketchatConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.rocketchatConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.rocketchatConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.rocketchatConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.rocketchatConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.rocketchatConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.rocketchatConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.rocketchatConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
fn spec.receivers.rocketchatConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.basicAuth
"basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.rocketchatConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
fn spec.receivers.rocketchatConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.basicAuth.username
"username defines a key of a Secret containing the username for\nauthentication."
fn spec.receivers.rocketchatConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.bearerTokenSecret
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.rocketchatConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2
"oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientId.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientSecret
"clientSecret defines a key of a Secret containing the OAuth2\nclient's secret."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.token
"token defines the sender token for RocketChat authentication.\nThis is the personal access token or bot token used to authenticate API requests."
fn spec.receivers.rocketchatConfigs.token.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.token.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.token.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.rocketchatConfigs.tokenID
"tokenID defines the sender token ID for RocketChat authentication.\nThis is the user ID associated with the token used for API requests."
fn spec.receivers.rocketchatConfigs.tokenID.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.rocketchatConfigs.tokenID.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.rocketchatConfigs.tokenID.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs
"slackConfigs defines the list of Slack configurations."
fn spec.receivers.slackConfigs.withActions
withActions(actions)
"actions defines a list of Slack actions that are sent with each notification."
fn spec.receivers.slackConfigs.withActionsMixin
withActionsMixin(actions)
"actions defines 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)
"callbackId defines an identifier for the message used in interactive components."
fn spec.receivers.slackConfigs.withChannel
withChannel(channel)
"channel defines the channel or user to send notifications to."
fn spec.receivers.slackConfigs.withColor
withColor(color)
"color defines the color of the left border of the Slack message attachment.\nCan be a hex color code (e.g., \"#ff0000\") or a predefined color name."
fn spec.receivers.slackConfigs.withFallback
withFallback(fallback)
"fallback defines a plain-text summary of the attachment for clients that don't support attachments."
fn spec.receivers.slackConfigs.withFields
withFields(fields)
"fields defines a list of Slack fields that are sent with each notification."
fn spec.receivers.slackConfigs.withFieldsMixin
withFieldsMixin(fields)
"fields defines 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)
"footer defines small text displayed at the bottom of the message attachment."
fn spec.receivers.slackConfigs.withIconEmoji
withIconEmoji(iconEmoji)
"iconEmoji defines the emoji to use as the bot's avatar (e.g., \":ghost:\")."
fn spec.receivers.slackConfigs.withIconURL
withIconURL(iconURL)
"iconURL defines the URL to an image to use as the bot's avatar."
fn spec.receivers.slackConfigs.withImageURL
withImageURL(imageURL)
"imageURL defines the URL to an image file that will be displayed inside the message attachment."
fn spec.receivers.slackConfigs.withLinkNames
withLinkNames(linkNames)
"linkNames enables automatic linking of channel names and usernames in the message.\nWhen true, @channel and @username will be converted to clickable links."
fn spec.receivers.slackConfigs.withMrkdwnIn
withMrkdwnIn(mrkdwnIn)
"mrkdwnIn defines which fields should be parsed as Slack markdown.\nValid values include \"pretext\", \"text\", and \"fields\"."
fn spec.receivers.slackConfigs.withMrkdwnInMixin
withMrkdwnInMixin(mrkdwnIn)
"mrkdwnIn defines which fields should be parsed as Slack markdown.\nValid values include \"pretext\", \"text\", and \"fields\"."
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.withPretext
withPretext(pretext)
"pretext defines optional text that appears above the message attachment block."
fn spec.receivers.slackConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.slackConfigs.withShortFields
withShortFields(shortFields)
"shortFields determines whether fields are displayed in a compact format.\nWhen true, fields are shown side by side when possible."
fn spec.receivers.slackConfigs.withText
withText(text)
"text defines the main text content of the Slack message attachment."
fn spec.receivers.slackConfigs.withThumbURL
withThumbURL(thumbURL)
"thumbURL defines the URL to an image file that will be displayed as a thumbnail\non the right side of the message attachment."
fn spec.receivers.slackConfigs.withTitle
withTitle(title)
"title defines the title text displayed in the Slack message attachment."
fn spec.receivers.slackConfigs.withTitleLink
withTitleLink(titleLink)
"titleLink defines the URL that the title will link to when clicked."
fn spec.receivers.slackConfigs.withUsername
withUsername(username)
"username defines the slack bot user name."
obj spec.receivers.slackConfigs.actions
"actions defines a list of Slack actions that are sent with each notification."
fn spec.receivers.slackConfigs.actions.withName
withName(name)
"name defines a unique identifier for the action within the message.\nThis value is sent back to your application when the action is triggered."
fn spec.receivers.slackConfigs.actions.withStyle
withStyle(style)
"style defines the visual appearance of the action element.\nValid values include \"default\", \"primary\" (green), and \"danger\" (red)."
fn spec.receivers.slackConfigs.actions.withText
withText(text)
"text defines the user-visible label displayed on the action element.\nFor buttons, this is the button text. For select menus, this is the placeholder text."
fn spec.receivers.slackConfigs.actions.withType
withType(type)
"type defines the type of interactive component.\nCommon values include \"button\" for clickable buttons and \"select\" for dropdown menus."
fn spec.receivers.slackConfigs.actions.withUrl
withUrl(url)
"url defines the URL to open when the action is triggered.\nOnly applicable for button-type actions. When set, clicking the button opens this URL."
fn spec.receivers.slackConfigs.actions.withValue
withValue(value)
"value defines the payload sent when the action is triggered.\nThis data is included in the callback sent to your application."
obj spec.receivers.slackConfigs.actions.confirm
"confirm defines an optional confirmation dialog that appears before the action is executed.\nWhen set, users must confirm their intent before the action proceeds."
fn spec.receivers.slackConfigs.actions.confirm.withDismissText
withDismissText(dismissText)
"dismissText defines the label for the cancel button in the dialog.\nWhen not specified, defaults to \"Cancel\". This button cancels the action."
fn spec.receivers.slackConfigs.actions.confirm.withOkText
withOkText(okText)
"okText defines the label for the confirmation button in the dialog.\nWhen not specified, defaults to \"Okay\". This button proceeds with the action."
fn spec.receivers.slackConfigs.actions.confirm.withText
withText(text)
"text defines the main message displayed in the confirmation dialog.\nThis should be a clear question or statement asking the user to confirm their action."
fn spec.receivers.slackConfigs.actions.confirm.withTitle
withTitle(title)
"title defines the title text displayed at the top of the confirmation dialog.\nWhen not specified, a default title will be used."
obj spec.receivers.slackConfigs.apiURL
"apiURL defines the secret's key that contains the Slack webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.slackConfigs.apiURL.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.slackConfigs.apiURL.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.fields
"fields defines a list of Slack fields that are sent with each notification."
fn spec.receivers.slackConfigs.fields.withShort
withShort(short)
"short determines whether this field can be displayed alongside other short fields.\nWhen true, Slack may display this field side by side with other short fields.\nWhen false or not specified, the field takes the full width of the message."
fn spec.receivers.slackConfigs.fields.withTitle
withTitle(title)
"title defines the label or header text displayed for this field.\nThis appears as bold text above the field value in the Slack message."
fn spec.receivers.slackConfigs.fields.withValue
withValue(value)
"value defines the content or data displayed for this field.\nThis appears below the title and can contain plain text or Slack markdown."
obj spec.receivers.slackConfigs.httpConfig
"httpConfig defines the HTTP client configuration."
fn spec.receivers.slackConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.slackConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.slackConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.slackConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.slackConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.slackConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.slackConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.slackConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.slackConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.slackConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.slackConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"username defines a key of a Secret containing the username for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.slackConfigs.httpConfig.bearerTokenSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.slackConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.slackConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.slackConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.slackConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.slackConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.slackConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.slackConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.slackConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.slackConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"clientSecret defines a key of a Secret containing the OAuth2\nclient's 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.slackConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.slackConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.slackConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.slackConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.slackConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs
"snsConfigs defines the list of SNS configurations"
fn spec.receivers.snsConfigs.withApiURL
withApiURL(apiURL)
"apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com.\nIf not specified, the SNS API URL from the SNS SDK will be used."
fn spec.receivers.snsConfigs.withAttributes
withAttributes(attributes)
"attributes defines SNS message attributes as key-value pairs.\nThese provide additional metadata that can be used for message filtering and routing."
fn spec.receivers.snsConfigs.withAttributesMixin
withAttributesMixin(attributes)
"attributes defines SNS message attributes as key-value pairs.\nThese provide additional metadata that can be used for message filtering and routing."
Note: This function appends passed data to existing values
fn spec.receivers.snsConfigs.withMessage
withMessage(message)
"message defines the message content of the SNS notification.\nThis is the actual notification text that will be sent to subscribers."
fn spec.receivers.snsConfigs.withPhoneNumber
withPhoneNumber(phoneNumber)
"phoneNumber defines the phone number if message is delivered via SMS in E.164 format.\nIf you don't specify this value, you must specify a value for the TopicARN or TargetARN."
fn spec.receivers.snsConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.snsConfigs.withSubject
withSubject(subject)
"subject defines the subject line when the message is delivered to email endpoints.\nThis field is only used when sending to email subscribers of an SNS topic."
fn spec.receivers.snsConfigs.withTargetARN
withTargetARN(targetARN)
"targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications.\nIf you don't specify this value, you must specify a value for the TopicARN or PhoneNumber."
fn spec.receivers.snsConfigs.withTopicARN
withTopicARN(topicARN)
"topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic.\nIf you don't specify this value, you must specify a value for the PhoneNumber or TargetARN."
obj spec.receivers.snsConfigs.httpConfig
"httpConfig defines the HTTP client configuration for SNS API requests."
fn spec.receivers.snsConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.snsConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.snsConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.snsConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.snsConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.snsConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.snsConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.snsConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.snsConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.snsConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.snsConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.snsConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"username defines a key of a Secret containing the username for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.snsConfigs.httpConfig.bearerTokenSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.snsConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.snsConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.snsConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.snsConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.snsConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.snsConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.snsConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.snsConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.snsConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.snsConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.snsConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"clientSecret defines a key of a Secret containing the OAuth2\nclient's 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.snsConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.snsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.snsConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.snsConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.snsConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"sigv4 configures AWS's Signature Verification 4 signing process to sign requests.\nThis includes AWS credentials and region configuration for authentication."
fn spec.receivers.snsConfigs.sigv4.withProfile
withProfile(profile)
"profile defines the named AWS profile used to authenticate."
fn spec.receivers.snsConfigs.sigv4.withRegion
withRegion(region)
"region defines the AWS region. If blank, the region from the default credentials chain used."
fn spec.receivers.snsConfigs.sigv4.withRoleArn
withRoleArn(roleArn)
"roleArn defines the named AWS profile used to authenticate."
fn spec.receivers.snsConfigs.sigv4.withUseFIPSSTSEndpoint
withUseFIPSSTSEndpoint(useFIPSSTSEndpoint)
"useFIPSSTSEndpoint defines FIPS mode for AWS STS endpoint.\nIt requires Prometheus >= v2.54.0."
obj spec.receivers.snsConfigs.sigv4.accessKey
"accessKey defines the AWS API key. If not specified, the environment variable\nAWS_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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the AWS API secret. If not specified, the environment\nvariable 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.snsConfigs.sigv4.secretKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs
"telegramConfigs defines the list of Telegram configurations."
fn spec.receivers.telegramConfigs.withApiURL
withApiURL(apiURL)
"apiURL defines the Telegram API URL, e.g. https://api.telegram.org.\nIf not specified, the default Telegram API URL will be used."
fn spec.receivers.telegramConfigs.withBotTokenFile
withBotTokenFile(botTokenFile)
"botTokenFile defines the file to read the Telegram bot token from.\nIt is mutually exclusive with botToken.\nEither botToken or botTokenFile is required.\nIt requires Alertmanager >= v0.26.0."
fn spec.receivers.telegramConfigs.withChatID
withChatID(chatID)
"chatID defines the Telegram chat ID where messages will be sent.\nThis can be a user ID, group ID, or channel ID (with @ prefix for public channels)."
fn spec.receivers.telegramConfigs.withDisableNotifications
withDisableNotifications(disableNotifications)
"disableNotifications controls whether Telegram notifications are sent silently.\nWhen true, users will receive the message without notification sounds."
fn spec.receivers.telegramConfigs.withMessage
withMessage(message)
"message defines the message template for the Telegram notification.\nThis is the content that will be sent to the specified chat."
fn spec.receivers.telegramConfigs.withMessageThreadID
withMessageThreadID(messageThreadID)
"messageThreadID defines the Telegram Group Topic ID for threaded messages.\nThis allows sending messages to specific topics within Telegram groups.\nIt requires Alertmanager >= 0.26.0."
fn spec.receivers.telegramConfigs.withParseMode
withParseMode(parseMode)
"parseMode defines the parse mode for telegram message formatting.\nValid values are \"MarkdownV2\", \"Markdown\", and \"HTML\".\nThis determines how text formatting is interpreted in the message."
fn spec.receivers.telegramConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
obj spec.receivers.telegramConfigs.botToken
"botToken defines the Telegram bot token. It is mutually exclusive with botTokenFile.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither botToken or botTokenFile is required."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.telegramConfigs.botToken.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig
"httpConfig defines the HTTP client configuration for Telegram API requests."
fn spec.receivers.telegramConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.telegramConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.telegramConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.telegramConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.telegramConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.telegramConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.telegramConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.telegramConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.telegramConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.telegramConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.telegramConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.telegramConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"username defines a key of a Secret containing the username for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.telegramConfigs.httpConfig.bearerTokenSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.telegramConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.telegramConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"clientSecret defines a key of a Secret containing the OAuth2\nclient's 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.telegramConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.telegramConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.telegramConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs
"victoropsConfigs defines the list of VictorOps configurations."
fn spec.receivers.victoropsConfigs.withApiUrl
withApiUrl(apiUrl)
"apiUrl defines the VictorOps API URL.\nWhen not specified, defaults to the standard VictorOps API endpoint."
fn spec.receivers.victoropsConfigs.withCustomFields
withCustomFields(customFields)
"customFields defines additional custom fields for notification.\nThese provide extra metadata that will be included with the VictorOps incident."
fn spec.receivers.victoropsConfigs.withCustomFieldsMixin
withCustomFieldsMixin(customFields)
"customFields defines additional custom fields for notification.\nThese provide extra metadata that will be included with the VictorOps incident."
Note: This function appends passed data to existing values
fn spec.receivers.victoropsConfigs.withEntityDisplayName
withEntityDisplayName(entityDisplayName)
"entityDisplayName contains a summary of the alerted problem.\nThis appears as the main title or identifier for the incident."
fn spec.receivers.victoropsConfigs.withMessageType
withMessageType(messageType)
"messageType describes the behavior of the alert.\nValid values are \"CRITICAL\", \"WARNING\", and \"INFO\"."
fn spec.receivers.victoropsConfigs.withMonitoringTool
withMonitoringTool(monitoringTool)
"monitoringTool defines the monitoring tool the state message is from.\nThis helps identify the source system that generated the alert."
fn spec.receivers.victoropsConfigs.withRoutingKey
withRoutingKey(routingKey)
"routingKey defines a key used to map the alert to a team.\nThis determines which VictorOps team will receive the alert notification."
fn spec.receivers.victoropsConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.victoropsConfigs.withStateMessage
withStateMessage(stateMessage)
"stateMessage contains a long explanation of the alerted problem.\nThis provides detailed context about the incident."
obj spec.receivers.victoropsConfigs.apiKey
"apiKey defines the secret's key that contains the API key to use when talking to the VictorOps API.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.victoropsConfigs.apiKey.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.victoropsConfigs.apiKey.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.customFields
"customFields defines additional custom fields for notification.\nThese provide extra metadata that will be included with the VictorOps incident."
fn spec.receivers.victoropsConfigs.customFields.withKey
withKey(key)
"key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair."
fn spec.receivers.victoropsConfigs.customFields.withValue
withValue(value)
"value defines the value of the tuple.\nThis is the data or content associated with the key."
obj spec.receivers.victoropsConfigs.httpConfig
"httpConfig defines the HTTP client's configuration for VictorOps API requests."
fn spec.receivers.victoropsConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.victoropsConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.victoropsConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.victoropsConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.victoropsConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.victoropsConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.victoropsConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.victoropsConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.victoropsConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.victoropsConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.victoropsConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.victoropsConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"username defines a key of a Secret containing the username for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.victoropsConfigs.httpConfig.bearerTokenSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"clientSecret defines a key of a Secret containing the OAuth2\nclient's 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.victoropsConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.victoropsConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.victoropsConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs
"webexConfigs defines the list of Webex configurations."
fn spec.receivers.webexConfigs.withApiURL
withApiURL(apiURL)
"apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages"
fn spec.receivers.webexConfigs.withMessage
withMessage(message)
"message defines the message template"
fn spec.receivers.webexConfigs.withRoomID
withRoomID(roomID)
"roomID defines the ID of the Webex Teams room where to send the messages."
fn spec.receivers.webexConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
obj spec.receivers.webexConfigs.httpConfig
"httpConfig defines the HTTP client's configuration."
fn spec.receivers.webexConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.webexConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.webexConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webexConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webexConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.webexConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webexConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.webexConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.webexConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.webexConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.webexConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
fn spec.receivers.webexConfigs.httpConfig.authorization.credentials.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.authorization.credentials.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.authorization.credentials.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.basicAuth
"basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.webexConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
fn spec.receivers.webexConfigs.httpConfig.basicAuth.password.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.basicAuth.password.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.basicAuth.password.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.basicAuth.username
"username defines a key of a Secret containing the username for\nauthentication."
fn spec.receivers.webexConfigs.httpConfig.basicAuth.username.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.basicAuth.username.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.basicAuth.username.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.bearerTokenSecret
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.webexConfigs.httpConfig.bearerTokenSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.bearerTokenSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.bearerTokenSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.oauth2
"oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.webexConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.webexConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.webexConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webexConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webexConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.webexConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webexConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.webexConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.webexConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.webexConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.webexConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.oauth2.clientId.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret
"clientSecret defines a key of a Secret containing the OAuth2\nclient's secret."
fn spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.oauth2.clientSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.webexConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webexConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs
"webhookConfigs defines the List of webhook configurations."
fn spec.receivers.webhookConfigs.withMaxAlerts
withMaxAlerts(maxAlerts)
"maxAlerts defines the maximum number of alerts to be sent per webhook message.\nWhen 0, all alerts are included in the webhook payload."
fn spec.receivers.webhookConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.webhookConfigs.withTimeout
withTimeout(timeout)
"timeout defines the maximum time to wait for a webhook request to complete,\nbefore failing the request and allowing it to be retried.\nIt requires Alertmanager >= v0.28.0."
fn spec.receivers.webhookConfigs.withUrl
withUrl(url)
"url defines the URL to send HTTP POST requests to.\nurlSecret takes precedence over url. One of urlSecret and url should be defined."
obj spec.receivers.webhookConfigs.httpConfig
"httpConfig defines the HTTP client configuration for webhook requests."
fn spec.receivers.webhookConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.webhookConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.webhookConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webhookConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webhookConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.webhookConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webhookConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.webhookConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.webhookConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.webhookConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.webhookConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.webhookConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"username defines a key of a Secret containing the username for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.webhookConfigs.httpConfig.bearerTokenSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.webhookConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.webhookConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"clientSecret defines a key of a Secret containing the OAuth2\nclient's 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webhookConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.webhookConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.webhookConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"urlSecret defines the secret's key that contains the webhook URL to send HTTP requests to.\nurlSecret takes precedence over url. One of urlSecret and url should be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.webhookConfigs.urlSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.webhookConfigs.urlSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs
"wechatConfigs defines the list of WeChat configurations."
fn spec.receivers.wechatConfigs.withAgentID
withAgentID(agentID)
"agentID defines the application agent ID within WeChat Work.\nThis identifies which WeChat Work application will send the notifications."
fn spec.receivers.wechatConfigs.withApiURL
withApiURL(apiURL)
"apiURL defines the WeChat API URL.\nWhen not specified, defaults to the standard WeChat Work API endpoint."
fn spec.receivers.wechatConfigs.withCorpID
withCorpID(corpID)
"corpID defines the corp id for authentication.\nThis is the unique identifier for your WeChat Work organization."
fn spec.receivers.wechatConfigs.withMessage
withMessage(message)
"message defines the API request data as defined by the WeChat API.\nThis contains the actual notification content to be sent."
fn spec.receivers.wechatConfigs.withMessageType
withMessageType(messageType)
"messageType defines the type of message to send.\nValid values include \"text\", \"markdown\", and other WeChat Work supported message types."
fn spec.receivers.wechatConfigs.withSendResolved
withSendResolved(sendResolved)
"sendResolved defines whether or not to notify about resolved alerts."
fn spec.receivers.wechatConfigs.withToParty
withToParty(toParty)
"toParty defines the target department(s) to receive the notification.\nCan be a single department ID or multiple department IDs separated by '|'."
fn spec.receivers.wechatConfigs.withToTag
withToTag(toTag)
"toTag defines the target tag(s) to receive the notification.\nCan be a single tag ID or multiple tag IDs separated by '|'."
fn spec.receivers.wechatConfigs.withToUser
withToUser(toUser)
"toUser defines the target user(s) to receive the notification.\nCan be a single user ID or multiple user IDs separated by '|'."
obj spec.receivers.wechatConfigs.apiSecret
"apiSecret defines the secret's key that contains the WeChat API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.wechatConfigs.apiSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.wechatConfigs.apiSecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig
"httpConfig defines the HTTP client configuration for WeChat API requests."
fn spec.receivers.wechatConfigs.httpConfig.withEnableHttp2
withEnableHttp2(enableHttp2)
"enableHttp2 can be used to disable HTTP2."
fn spec.receivers.wechatConfigs.httpConfig.withFollowRedirects
withFollowRedirects(followRedirects)
"followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses."
fn spec.receivers.wechatConfigs.httpConfig.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.wechatConfigs.httpConfig.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.wechatConfigs.httpConfig.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.wechatConfigs.httpConfig.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.wechatConfigs.httpConfig.withProxyURL
withProxyURL(proxyURL)
"proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over proxyUrl."
fn spec.receivers.wechatConfigs.httpConfig.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
obj spec.receivers.wechatConfigs.httpConfig.authorization
"authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+."
fn spec.receivers.wechatConfigs.httpConfig.authorization.withType
withType(type)
"type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\
obj spec.receivers.wechatConfigs.httpConfig.authorization.credentials
"credentials defines a key of a Secret in the namespace that contains the credentials for authentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence."
obj spec.receivers.wechatConfigs.httpConfig.basicAuth.password
"password defines a key of a Secret containing the password for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"username defines a key of a Secret containing the username for\nauthentication."
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator."
fn spec.receivers.wechatConfigs.httpConfig.bearerTokenSecret.withKey
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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withEndpointParams
withEndpointParams(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withEndpointParamsMixin
withEndpointParamsMixin(endpointParams)
"endpointParams configures the HTTP parameters to append to the token\nURL."
Note: This function appends passed data to existing values
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withNoProxy
withNoProxy(noProxy)
"noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withProxyConnectHeader
withProxyConnectHeader(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withProxyConnectHeaderMixin
withProxyConnectHeaderMixin(proxyConnectHeader)
"proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
Note: This function appends passed data to existing values
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withProxyFromEnvironment
withProxyFromEnvironment(proxyFromEnvironment)
"proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withProxyUrl
withProxyUrl(proxyUrl)
"proxyUrl defines the HTTP proxy server to use."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withScopes
withScopes(scopes)
"scopes defines the OAuth2 scopes used for the token request."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withScopesMixin
withScopesMixin(scopes)
"scopes defines the OAuth2 scopes used for the token request."
Note: This function appends passed data to existing values
fn spec.receivers.wechatConfigs.httpConfig.oauth2.withTokenUrl
withTokenUrl(tokenUrl)
"tokenUrl defines the URL to fetch the token from."
obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId
"clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID."
obj spec.receivers.wechatConfigs.httpConfig.oauth2.clientId.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"clientSecret defines a key of a Secret containing the OAuth2\nclient's 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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.oauth2.tlsConfig
"tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.ca.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.ca.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap
"configMap defines the ConfigMap containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withKey
withKey(key)
"The key to select."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.configMap.withOptional
withOptional(optional)
"Specify whether the ConfigMap or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.secret
"secret defines the Secret containing data to use for the targets."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.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.oauth2.tlsConfig.cert.secret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.cert.secret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret
"keySecret defines the Secret containing the client key file for the targets."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret.withKey
withKey(key)
"The key of the secret to select from. Must be a valid secret key."
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret.withName
withName(name)
"Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.wechatConfigs.httpConfig.oauth2.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig
"tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withInsecureSkipVerify
withInsecureSkipVerify(insecureSkipVerify)
"insecureSkipVerify defines how to disable target certificate validation."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withMaxVersion
withMaxVersion(maxVersion)
"maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withMinVersion
withMinVersion(minVersion)
"minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0."
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.withServerName
withServerName(serverName)
"serverName is used to verify the hostname for the targets."
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca
"ca defines the Certificate authority used when verifying server certificates."
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.ca.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"cert defines the Client certificate to present when doing client-authentication."
obj spec.receivers.wechatConfigs.httpConfig.tlsConfig.cert.configMap
"configMap defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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 defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
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
"keySecret defines the 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.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.receivers.wechatConfigs.httpConfig.tlsConfig.keySecret.withOptional
withOptional(optional)
"Specify whether the Secret or its key must be defined"
obj spec.route
"route defines the Alertmanager route definition for alerts matching the resource's\nnamespace. If present, it will be added to the generated Alertmanager\nconfiguration as a first-level route."
fn spec.route.withActiveTimeIntervals
withActiveTimeIntervals(activeTimeIntervals)
"activeTimeIntervals is a list of MuteTimeInterval names when this route should be active."
fn spec.route.withActiveTimeIntervalsMixin
withActiveTimeIntervalsMixin(activeTimeIntervals)
"activeTimeIntervals is a list of MuteTimeInterval names when this route should be active."
Note: This function appends passed data to existing values
fn spec.route.withContinue
withContinue(continue)
"continue defines the boolean indicating whether an alert should continue matching subsequent\nsibling nodes. It will always be overridden to true for the first-level\nroute by the Prometheus operator."
fn spec.route.withGroupBy
withGroupBy(groupBy)
"groupBy defines the list of labels to group by.\nLabels must not be repeated (unique list).\nSpecial label \"...\" (aggregate by all possible labels), if provided, must be the only element in the list."
fn spec.route.withGroupByMixin
withGroupByMixin(groupBy)
"groupBy defines the list of labels to group by.\nLabels must not be repeated (unique list).\nSpecial label \"...\" (aggregate by all possible labels), if provided, must be the only element in the list."
Note: This function appends passed data to existing values
fn spec.route.withGroupInterval
withGroupInterval(groupInterval)
"groupInterval defines how long to wait before sending an updated notification.\nMust match the regular expression^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$\nExample: \"5m\
fn spec.route.withGroupWait
withGroupWait(groupWait)
"groupWait defines how long to wait before sending the initial notification.\nMust match the regular expression^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$\nExample: \"30s\
fn spec.route.withMatchers
withMatchers(matchers)
"matchers defines the list of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the namespace label and adds a namespace: <object\nnamespace> matcher."
fn spec.route.withMatchersMixin
withMatchersMixin(matchers)
"matchers defines the list of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the namespace label and adds a namespace: <object\nnamespace> matcher."
Note: This function appends passed data to existing values
fn spec.route.withMuteTimeIntervals
withMuteTimeIntervals(muteTimeIntervals)
"muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,"
fn spec.route.withMuteTimeIntervalsMixin
withMuteTimeIntervalsMixin(muteTimeIntervals)
"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)
"receiver defines the name of the receiver for this route. If not empty, it should be listed in\nthe receivers field."
fn spec.route.withRepeatInterval
withRepeatInterval(repeatInterval)
"repeatInterval defines how long to wait before repeating the last notification.\nMust match the regular expression^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$\nExample: \"4h\
fn spec.route.withRoutes
withRoutes(routes)
"routes defines the child routes."
fn spec.route.withRoutesMixin
withRoutesMixin(routes)
"routes defines the child routes."
Note: This function appends passed data to existing values
obj spec.route.matchers
"matchers defines the list of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the namespace label and adds a namespace: <object\nnamespace> matcher."
fn spec.route.matchers.withMatchType
withMatchType(matchType)
"matchType defines the match operation available with AlertManager >= v0.22.0.\nTakes precedence over Regex (deprecated) if non-empty.\nValid values: \"=\" (equality), \"!=\" (inequality), \"=~\" (regex match), \"!~\" (regex non-match)."
fn spec.route.matchers.withName
withName(name)
"name defines the label to match.\nThis specifies which alert label should be evaluated."
fn spec.route.matchers.withRegex
withRegex(regex)
"regex defines whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, matchType should be used instead."
fn spec.route.matchers.withValue
withValue(value)
"value defines the label value to match.\nThis is the expected value for the specified label."