Help us shape the future of Go! Take the 2026 Go Developer Survey

notifier

package
v1.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 24, 2026 License: Apache-2.0 Imports: 72 Imported by: 0

Documentation

Index

Constants

View Source 
const NotificationHeader = "gotk-component"

NotificationHeader is a header sent to identify requests from the notification controller.

View Source 
const OperationPost = "post"

OperationPost is the operation name used in cache event metrics

Variables

This section is empty.

Functions

func EventKey added in v1.10.0 

func EventKey(event *eventv1.Event) string

EventKey generates a unique key identifying an event. The key is calculated by concatenating specific event attributes and hashing them using SHA-256, and is returned as a hex-encoded string. It is the identity of an event across the controller: the event server uses it to rate limit duplicate events and notifiers may use it as an idempotency token.

The event attributes are prefixed with an identifier to avoid collisions between different event attributes.

func GetAlertMetadata added in v1.7.0 

func GetAlertMetadata(ctx context.Context) (metav1.ObjectMeta, bool)

func NewJWTProvider added in v0.14.0 

func NewJWTProvider(jwt string) azcore.TokenCredential

NewJWTProvider create a pureJWT method

func SetRetryBackoff added in v1.10.0 

func SetRetryBackoff(minWait, maxWait time.Duration) (restore func())

SetRetryBackoff overrides retry waits for newly created clients, for tests only. Call it from a non-parallel parent test before starting parallel subtests, and register the returned restore function with the parent's Cleanup.

func WithAlertMetadata added in v1.7.0 

func WithAlertMetadata(ctx context.Context, metadata metav1.ObjectMeta) context.Context

Types

type AlertManagerAlert added in v0.18.0 

type AlertManagerAlert struct {
	Status      string            `json:"status"`
	Labels      map[string]string `json:"labels"`
	Annotations map[string]string `json:"annotations"`

	StartsAt AlertManagerTime `json:"startsAt"`
	EndsAt   AlertManagerTime `json:"endsAt,omitempty"`
}

type AlertManagerTime added in v1.3.0 

type AlertManagerTime time.Time

AlertManagerTime takes care of representing time.Time as RFC3339. See https://prometheus.io/docs/alerting/0.27/clients/

func (AlertManagerTime) MarshalJSON added in v1.3.0 

func (a AlertManagerTime) MarshalJSON() ([]byte, error)

func (AlertManagerTime) String added in v1.3.0 

func (a AlertManagerTime) String() string

func (*AlertManagerTime) UnmarshalJSON added in v1.3.0 

func (a *AlertManagerTime) UnmarshalJSON(jsonRepr []byte) error

type Alertmanager added in v0.18.0 

type Alertmanager struct {
	URL       string
	ProxyURL  *url.URL
	TLSConfig *tls.Config
	Token     string
	Username  string
	Password  string
}

func NewAlertmanager added in v0.18.0 

func NewAlertmanager(hookURL string, proxyURL *url.URL, tlsConfig *tls.Config, token, user, pass string) (*Alertmanager, error)

func (*Alertmanager) Post added in v0.18.0 

func (s *Alertmanager) Post(ctx context.Context, event eventv1.Event) error

type AzureDevOps added in v0.4.0 

type AzureDevOps struct {
	Project      string
	Repo         string
	CommitStatus string
	Client       azureDevOpsClient
}

AzureDevOps is an Azure DevOps notifier.

func NewAzureDevOps added in v0.4.0 

func NewAzureDevOps(ctx context.Context, commitStatus string, addr string, token string,
	tlsConfig *tls.Config, proxy *url.URL, serviceAccountName, providerName, providerNamespace string,
	tokenClient client.Client, tokenCache *cache.TokenCache, spiffeBroker fluxbroker.Interface,
	defaultServiceAccount string) (*AzureDevOps, error)

NewAzureDevOps creates and returns a new AzureDevOps notifier.

func (AzureDevOps) Post added in v0.4.0 

func (a AzureDevOps) Post(ctx context.Context, event eventv1.Event) error

Post Azure DevOps commit status

type AzureEventHub added in v0.14.0 

type AzureEventHub struct {
	ProducerClient *eventhub.ProducerClient
}

AzureEventHub holds the eventhub client

func NewAzureEventHub added in v0.14.0 

func NewAzureEventHub(ctx context.Context, endpointURL, token, eventHubNamespace string, proxy *url.URL,
	serviceAccountName, providerName, providerNamespace string, tokenClient client.Client,
	tokenCache *cache.TokenCache, spiffeBroker fluxbroker.Interface, defaultServiceAccount string) (*AzureEventHub, error)

NewAzureEventHub creates a eventhub client

func (*AzureEventHub) Post added in v0.14.0 

func (e *AzureEventHub) Post(ctx context.Context, event eventv1.Event) error

Post all notification-controller messages to EventHub

type Bitbucket added in v0.2.1 

type Bitbucket struct {
	Owner        string
	Repo         string
	CommitStatus string
	Client       *bitbucket.Client
}

Bitbucket is a Bitbucket Cloud notifier.

func NewBitbucket added in v0.2.1 

func NewBitbucket(commitStatus string, addr string, proxyURL *url.URL, token string, tlsConfig *tls.Config) (*Bitbucket, error)

NewBitbucket creates and returns a new Bitbucket notifier.

func (Bitbucket) Post added in v0.2.1 

func (b Bitbucket) Post(ctx context.Context, event eventv1.Event) error

Post Bitbucket commit status

type BitbucketServer added in v1.2.0 

type BitbucketServer struct {
	CommitStatus    string
	Url             *url.URL
	ProviderAddress string
	Username        string
	Password        string
	Token           string
	Client          *retryablehttp.Client
}

BitbucketServer is a notifier for BitBucket Server and Data Center.

func NewBitbucketServer added in v1.2.0 

func NewBitbucketServer(commitStatus string, addr string, proxyURL *url.URL, token string, tlsConfig *tls.Config, username string, password string) (*BitbucketServer, error)

NewBitbucketServer creates and returns a new BitbucketServer notifier.

func (BitbucketServer) Post added in v1.2.0 

func (b BitbucketServer) Post(ctx context.Context, event eventv1.Event) error

Post Bitbucket Server build status

type DataDog added in v1.1.0 

type DataDog struct {
	// contains filtered or unexported fields
}

func NewDataDog added in v1.1.0 

func NewDataDog(address string, proxyUrl *url.URL, tlsConfig *tls.Config, token string) (*DataDog, error)

NewDataDog creates a new DataDog provider by mapping the notification provider API to sensible values for the DataDog API. url: The DataDog API endpoint to use. Examples: https://api.datadoghq.com, https://api.datadoghq.eu, etc. token: The DataDog API key (not the application key). headers: A map of extra tags to add to the event

func (*DataDog) Post added in v1.1.0 

func (d *DataDog) Post(ctx context.Context, event eventv1.Event) error

type Discord 

type Discord struct {
	URL       string
	ProxyURL  *url.URL
	Username  string
	Channel   string
	TLSConfig *tls.Config
}

Discord holds the hook URL

func NewDiscord 

func NewDiscord(hookURL string, proxyURL *url.URL, tlsConfig *tls.Config, username string, channel string) (*Discord, error)

NewDiscord validates the URL and returns a Discord object

func (*Discord) Post 

func (s *Discord) Post(ctx context.Context, event eventv1.Event) error

Post Discord message

type Factory 

type Factory struct {
	// contains filtered or unexported fields
}

func NewFactory 

func NewFactory(ctx context.Context, opts ...Option) *Factory

NewFactory creates a new notifier factory with optional configurations.

func (*Factory) GitHubClientOptions added in v1.8.0 

func (o *Factory) GitHubClientOptions() []GitHubClientOption

GitHubClientOptions returns the GitHub client options derived from notifierOptions. This handles the token/password fallback logic and converts factory options to GitHub client options.

func (*Factory) GiteaClientOptions added in v1.8.0 

func (o *Factory) GiteaClientOptions() []GiteaClientOption

GiteaClientOptions returns the Gitea client options derived from notifierOptions. This handles the token/password fallback logic and converts factory options to Gitea client options.

func (Factory) Notifier 

func (f Factory) Notifier(provider string) (Interface, error)

type Forwarder 

type Forwarder struct {
	URL       string
	ProxyURL  *url.URL
	Headers   map[string]string
	TLSConfig *tls.Config
	HMACKey   []byte
}

Forwarder is an implementation of the notification Interface that posts the body as an HTTP request using an optional proxy.

func NewForwarder 

func NewForwarder(hookURL string, proxyURL *url.URL, headers map[string]string, tlsConfig *tls.Config, hmacKey []byte) (*Forwarder, error)

func (*Forwarder) Post 

func (f *Forwarder) Post(ctx context.Context, event eventv1.Event) error

type GitHub added in v0.0.8 

type GitHub struct {
	Owner        string
	Repo         string
	CommitStatus string
	Client       *github.Client
}

func NewGitHub added in v0.0.8 

func NewGitHub(ctx context.Context, commitStatus string, opts ...GitHubClientOption) (*GitHub, error)

func (*GitHub) Post added in v0.0.8 

func (g *GitHub) Post(ctx context.Context, event eventv1.Event) error

Post Github commit status

type GitHubClient added in v1.8.0 

type GitHubClient struct {
	UserLogin string
	AppSlug   string
	Owner     string
	Repo      string
	Client    *gogithub.Client
}

GitHubClient holds the GitHub client and repository information.

func NewGitHubClient added in v1.8.0 

func NewGitHubClient(ctx context.Context, opts ...GitHubClientOption) (*GitHubClient, error)

NewGitHubClient creates a new GitHubClientInfo with the provided options.

type GitHubClientOption added in v1.8.0 

type GitHubClientOption func(*gitHubClientOptions)

GitHubClientOption is a functional option for configuring GitHub client creation.

func WithGitHubAddress added in v1.8.0 

func WithGitHubAddress(addr string) GitHubClientOption

WithGitHubAddress sets the GitHub repository address.

func WithGitHubFetchUserLogin added in v1.8.0 

func WithGitHubFetchUserLogin() GitHubClientOption

WithGitHubFetchUserLogin enables fetching the authenticated user's login. This is needed for providers that need to identify their own comments/actions.

func WithGitHubProvider added in v1.8.0 

func WithGitHubProvider(name, namespace string) GitHubClientOption

WithGitHubProvider sets the provider name and namespace for token caching.

func WithGitHubProxyURL added in v1.8.0 

func WithGitHubProxyURL(proxyURL *url.URL) GitHubClientOption

WithGitHubProxyURL sets the proxy URL.

func WithGitHubSecretData added in v1.8.0 

func WithGitHubSecretData(data map[string][]byte) GitHubClientOption

WithGitHubSecretData sets the secret data for GitHub App authentication.

func WithGitHubTLSConfig added in v1.8.0 

func WithGitHubTLSConfig(cfg *tls.Config) GitHubClientOption

WithGitHubTLSConfig sets the TLS configuration.

func WithGitHubToken added in v1.8.0 

func WithGitHubToken(token string) GitHubClientOption

WithGitHubToken sets the authentication token.

func WithGitHubTokenCache added in v1.8.0 

func WithGitHubTokenCache(tokenCache *cache.TokenCache) GitHubClientOption

WithGitHubTokenCache sets the token cache for GitHub App authentication.

type GitHubDispatch added in v0.24.0 

type GitHubDispatch struct {
	Owner  string
	Repo   string
	Client *github.Client
}

func NewGitHubDispatch added in v0.24.0 

func NewGitHubDispatch(ctx context.Context, opts ...GitHubClientOption) (*GitHubDispatch, error)

func (*GitHubDispatch) Post added in v0.24.0 

func (g *GitHubDispatch) Post(ctx context.Context, event eventv1.Event) error

Post GitHub Repository Dispatch webhook

type GitHubPullRequestComment added in v1.8.0 

type GitHubPullRequestComment struct {
	Owner     string
	Repo      string
	UserLogin string
	AppSlug   string
	Client    *github.Client
	// contains filtered or unexported fields
}

func NewGitHubPullRequestComment added in v1.8.0 

func NewGitHubPullRequestComment(ctx context.Context, providerUID string, opts ...GitHubClientOption) (*GitHubPullRequestComment, error)

func (*GitHubPullRequestComment) Post added in v1.8.0 

func (g *GitHubPullRequestComment) Post(ctx context.Context, event eventv1.Event) error

Post posts a comment on the pull request specified in the event metadata. If the comment already exists (based on the comment key), it updates the existing comment instead of creating a new one.

type GitLab added in v0.0.11 

type GitLab struct {
	Id           string
	CommitStatus string
	Client       *gitlab.Client
}

func NewGitLab added in v0.0.11 

func NewGitLab(commitStatus string, addr string, proxyURL *url.URL, token string, tlsConfig *tls.Config) (*GitLab, error)

func (*GitLab) Post added in v0.0.11 

func (g *GitLab) Post(ctx context.Context, event eventv1.Event) error

Post GitLab commit status

type GitLabMergeRequestComment added in v1.8.0 

type GitLabMergeRequestComment struct {
	ProjectID string
	Username  string
	Client    *gitlab.Client
	// contains filtered or unexported fields
}

func NewGitLabMergeRequestComment added in v1.8.0 

func NewGitLabMergeRequestComment(providerUID string, addr string, proxyURL *url.URL, token string, tlsConfig *tls.Config) (*GitLabMergeRequestComment, error)

func (*GitLabMergeRequestComment) Post added in v1.8.0 

func (g *GitLabMergeRequestComment) Post(ctx context.Context, event eventv1.Event) error

Post posts a comment on the merge request specified in the event metadata. If the comment already exists (based on the comment key), it updates the existing comment instead of creating a new one.

type Gitea added in v0.30.0 

type Gitea struct {
	Owner        string
	Repo         string
	CommitStatus string
	Client       *gitea.Client
	Debug        bool
}

func NewGitea added in v0.30.0 

func NewGitea(commitStatus string, opts ...GiteaClientOption) (*Gitea, error)

func (*Gitea) Post added in v0.30.0 

func (g *Gitea) Post(ctx context.Context, event eventv1.Event) error

type GiteaClient added in v1.8.0 

type GiteaClient struct {
	Owner    string
	Repo     string
	Username string
	Client   *gitea.Client
}

GiteaClient holds the Gitea client and repository information.

func NewGiteaClient added in v1.8.0 

func NewGiteaClient(opts ...GiteaClientOption) (*GiteaClient, error)

NewGiteaClient creates a new GiteaClient with the provided options.

type GiteaClientOption added in v1.8.0 

type GiteaClientOption func(*giteaClientOptions)

GiteaClientOption is a functional option for configuring Gitea client creation.

func WithGiteaAddress added in v1.8.0 

func WithGiteaAddress(addr string) GiteaClientOption

WithGiteaAddress sets the Gitea repository address.

func WithGiteaContext added in v1.10.0 

func WithGiteaContext(ctx context.Context) GiteaClientOption

WithGiteaContext sets the context for construction and subsequent API calls.

func WithGiteaFetchUserLogin added in v1.8.0 

func WithGiteaFetchUserLogin() GiteaClientOption

WithGiteaFetchUserLogin enables fetching the authenticated user's login. This is needed for providers that need to identify their own comments.

func WithGiteaProxyURL added in v1.8.0 

func WithGiteaProxyURL(proxyURL *url.URL) GiteaClientOption

WithGiteaProxyURL sets the proxy URL.

func WithGiteaTLSConfig added in v1.8.0 

func WithGiteaTLSConfig(cfg *tls.Config) GiteaClientOption

WithGiteaTLSConfig sets the TLS configuration.

func WithGiteaToken added in v1.8.0 

func WithGiteaToken(token string) GiteaClientOption

WithGiteaToken sets the authentication token.

type GiteaPullRequestComment added in v1.8.0 

type GiteaPullRequestComment struct {
	Owner    string
	Repo     string
	Username string
	Client   *gitea.Client
	// contains filtered or unexported fields
}

func NewGiteaPullRequestComment added in v1.8.0 

func NewGiteaPullRequestComment(providerUID string, opts ...GiteaClientOption) (*GiteaPullRequestComment, error)

func (*GiteaPullRequestComment) Post added in v1.8.0 

func (g *GiteaPullRequestComment) Post(ctx context.Context, event eventv1.Event) error

Post posts a comment on the pull request specified in the event metadata. If the comment already exists (based on the comment key), it updates the existing comment instead of creating a new one.

type GoogleChat added in v0.10.0 

type GoogleChat struct {
	URL       string
	ProxyURL  *url.URL
	Username  string
	Channel   string
	TLSConfig *tls.Config
}

Slack holds the hook URL

func NewGoogleChat added in v0.10.0 

func NewGoogleChat(hookURL string, proxyURL *url.URL, tlsConfig *tls.Config) (*GoogleChat, error)

NewGoogleChat validates the Google Chat URL and returns a GoogleChat object

func (*GoogleChat) Post added in v0.10.0 

func (s *GoogleChat) Post(ctx context.Context, event eventv1.Event) error

Post Google Chat message

type GoogleChatCard added in v0.10.0 

type GoogleChatCard struct {
	Header   GoogleChatCardHeader    `json:"header"`
	Sections []GoogleChatCardSection `json:"sections"`
}

type GoogleChatCardHeader added in v0.10.0 

type GoogleChatCardHeader struct {
	Title      string  `json:"title"`
	SubTitle   string  `json:"subtitle"`
	ImageUrl   *string `json:"imageUrl"`
	ImageStyle *string `json:"imageStyle"`
}

type GoogleChatCardSection added in v0.10.0 

type GoogleChatCardSection struct {
	Header  string                 `json:"header"`
	Widgets []GoogleChatCardWidget `json:"widgets"`
}

type GoogleChatCardWidget added in v0.10.0 

type GoogleChatCardWidget struct {
	TextParagraph *GoogleChatCardWidgetTextParagraph `json:"textParagraph"`
	KeyValue      *GoogleChatCardWidgetKeyValue      `json:"keyValue"`
}

type GoogleChatCardWidgetKeyValue added in v0.10.0 

type GoogleChatCardWidgetKeyValue struct {
	TopLabel         string  `json:"topLabel"`
	Content          string  `json:"content"`
	ContentMultiLine bool    `json:"contentMultiline"`
	BottomLabel      *string `json:"bottomLabel"`
	Icon             *string `json:"icon"`
}

type GoogleChatCardWidgetTextParagraph added in v0.10.0 

type GoogleChatCardWidgetTextParagraph struct {
	Text string `json:"text"`
}

type GoogleChatPayload added in v0.10.0 

type GoogleChatPayload struct {
	Cards []GoogleChatCard `json:"cards"`
}

GoogleChatPayload holds the channel and attachments

type GooglePubSub added in v1.0.0 

type GooglePubSub struct {
	// contains filtered or unexported fields
}

GooglePubSub holds a Google Pub/Sub client and target topic.

func NewGooglePubSub added in v1.0.0 

func NewGooglePubSub(opts *notifierOptions) (*GooglePubSub, error)

NewGooglePubSub creates a Google Pub/Sub client tied to a specific project and topic using the provided client options.

func (*GooglePubSub) Post added in v1.0.0 

func (g *GooglePubSub) Post(ctx context.Context, event eventv1.Event) error

Post posts Flux events to a Google Pub/Sub topic.

type Grafana added in v0.22.0 

type Grafana struct {
	URL       string
	Token     string
	ProxyURL  *url.URL
	TLSConfig *tls.Config
	Username  string
	Password  string
}

func NewGrafana added in v0.22.0 

func NewGrafana(URL string, proxyURL *url.URL, token string, tlsConfig *tls.Config, username string, password string) (*Grafana, error)

NewGrafana validates the Grafana URL and returns a Grafana object

func (*Grafana) Post added in v0.22.0 

func (g *Grafana) Post(ctx context.Context, event eventv1.Event) error

Post annotation

type GraphitePayload added in v0.22.0 

type GraphitePayload struct {
	When int64    `json:"when"` //optional unix timestamp (ms)
	Text string   `json:"text"`
	Tags []string `json:"tags,omitempty"`
}

GraphitePayload represents a Grafana API annotation in Graphite format

type Incidentio added in v1.10.0 

type Incidentio struct {
	URL       string
	ProxyURL  *url.URL
	Token     string
	TLSConfig *tls.Config
}

Incidentio holds the endpoint URL of an incident.io HTTP alert source and its API token.

func NewIncidentio added in v1.10.0 

func NewIncidentio(endpointURL string, proxyURL *url.URL, tlsConfig *tls.Config, token string) (*Incidentio, error)

NewIncidentio validates the alert source endpoint URL and token and returns an Incidentio object.

func (*Incidentio) Post added in v1.10.0 

func (i *Incidentio) Post(ctx context.Context, event eventv1.Event) error

Post event to the incident.io HTTP alert source. Error events fire an alert, any other severity resolves it. The involved object UID is used as the deduplication key so that a recovery event resolves the alert previously fired for the same object, and objects with the same kind/namespace/name on different clusters never share a key.

type IncidentioPayload added in v1.10.0 

type IncidentioPayload struct {
	Title            string            `json:"title"`
	Status           string            `json:"status"`
	DeduplicationKey string            `json:"deduplication_key"`
	Description      string            `json:"description,omitempty"`
	SourceURL        string            `json:"source_url,omitempty"`
	Metadata         map[string]string `json:"metadata,omitempty"`
}

IncidentioPayload is the alert event format accepted by the incident.io HTTP alert source endpoint (POST /v2/alert_events/http/{alert_source_config_id}).

type Interface 

type Interface interface {
	Post(ctx context.Context, event eventv1.Event) error
}

type Lark added in v0.16.0 

type Lark struct {
	URL       string
	ProxyURL  *url.URL
	TLSConfig *tls.Config
}

func NewLark added in v0.16.0 

func NewLark(address string, proxyURL *url.URL, tlsConfig *tls.Config) (*Lark, error)

func (*Lark) Post added in v0.16.0 

func (l *Lark) Post(ctx context.Context, event eventv1.Event) error

type LarkCard added in v0.16.0 

type LarkCard struct {
	Config LarkConfig `json:"config"`

	Header LarkHeader `json:"header"`

	Elements []LarkElement `json:"elements"`
}

type LarkConfig added in v0.16.0 

type LarkConfig struct {
	WideScreenMode bool `json:"wide_screen_mode"`
}

type LarkElement added in v0.16.0 

type LarkElement struct {
	Tag  string   `json:"tag"`
	Text LarkText `json:"text"`
}

type LarkHeader added in v0.16.0 

type LarkHeader struct {
	Title    LarkTitle `json:"title"`
	Template string    `json:"template"`
}

type LarkPayload added in v0.16.0 

type LarkPayload struct {
	MsgType string   `json:"msg_type"`
	Card    LarkCard `json:"card"`
}

type LarkText added in v0.16.0 

type LarkText struct {
	Tag     string `json:"tag"`
	Content string `json:"content"`
}

type LarkTitle added in v0.16.0 

type LarkTitle struct {
	Tag     string `json:"tag"`
	Content string `json:"content"`
}

type MSTeams 

type MSTeams struct {
	URL       string
	ProxyURL  *url.URL
	Schema    int
	TLSConfig *tls.Config
}

MS Teams holds the incoming webhook URL

func NewMSTeams 

func NewMSTeams(hookURL string, proxyURL *url.URL, tlsConfig *tls.Config) (*MSTeams, error)

NewMSTeams validates the MS Teams URL and returns a MSTeams object

func (*MSTeams) Post 

func (s *MSTeams) Post(ctx context.Context, event eventv1.Event) error

Post MS Teams message

type MSTeamsField 

type MSTeamsField struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type MSTeamsPayload 

type MSTeamsPayload struct {
	Type       string           `json:"@type"`
	Context    string           `json:"@context"`
	ThemeColor string           `json:"themeColor"`
	Summary    string           `json:"summary"`
	Sections   []MSTeamsSection `json:"sections"`
}

MSTeamsPayload holds the message card data

type MSTeamsSection 

type MSTeamsSection struct {
	ActivityTitle    string         `json:"activityTitle"`
	ActivitySubtitle string         `json:"activitySubtitle"`
	Facts            []MSTeamsField `json:"facts"`
}

MSTeamsSection holds the canary analysis result

type Mastodon added in v1.10.0 

type Mastodon struct {
	// URL is the fully resolved statuses endpoint of the server.
	URL       string
	ProxyURL  *url.URL
	Token     string
	TLSConfig *tls.Config
	// EventKey is sent as the Idempotency-Key header when set.
	EventKey string
}

Mastodon holds the server URL and OAuth access token for posting statuses to a Mastodon account.

func NewMastodon added in v1.10.0 

func NewMastodon(serverURL string, proxyURL *url.URL, tlsConfig *tls.Config, token string, eventKey string) (*Mastodon, error)

NewMastodon validates the Mastodon server URL and returns a Mastodon object. The address may be the server root URL, in which case the statuses API path is appended. The event key is the identity of the event computed by the event server and is sent as the Idempotency-Key.

func (*Mastodon) Post added in v1.10.0 

func (m *Mastodon) Post(ctx context.Context, event eventv1.Event) error

Post the event as a status on the Mastodon account owning the token.

type MastodonPayload added in v1.10.0 

type MastodonPayload struct {
	Status string `json:"status"`
}

MastodonPayload is the JSON form accepted by the statuses endpoint. Visibility is intentionally not set so that statuses are posted with the default posting privacy configured on the account.

type Matrix added in v0.16.0 

type Matrix struct {
	Token     string
	URL       string
	RoomId    string
	TLSConfig *tls.Config
	ProxyURL  *url.URL
}

func NewMatrix added in v0.16.0 

func NewMatrix(serverURL string, proxyURL *url.URL, token, roomId string, tlsConfig *tls.Config) (*Matrix, error)

func (*Matrix) Post added in v0.16.0 

func (m *Matrix) Post(ctx context.Context, event eventv1.Event) error

type MatrixPayload added in v0.16.0 

type MatrixPayload struct {
	Body    string `json:"body"`
	MsgType string `json:"msgtype"`
}

type NATS added in v1.2.0 

type NATS struct {
	// contains filtered or unexported fields
}

NATS holds a NATS client and target subject.

func NewNATS added in v1.2.0 

func NewNATS(server string, subject string, username string, password string, secretData map[string][]byte) (*NATS, error)

NewNATS creates a new NATS notifier with support for multiple authentication methods.

Authentication methods (in priority order):

  1. User Credentials (JWT + NKey): Pass the .creds file content via credsData parameter
  2. NKey: Pass the NKey seed via nkeySeed parameter
  3. Username/Password: Pass via username and password parameters

Parameters:

  • server: NATS server URL (e.g., "nats://localhost:4222")
  • subject: NATS subject to publish events to
  • username: Username for basic authentication (optional)
  • password: Password for basic authentication (optional)
  • credsData: User credentials file content (JWT + NKey) for NATS 2.0+ authentication (optional)
  • nkeySeed: NKey seed for NKey-based authentication (optional)

Returns an error if server or subject is empty.

func (*NATS) Post added in v1.2.0 

func (n *NATS) Post(ctx context.Context, event eventv1.Event) error

Post posts Flux events to a NATS subject.

type OTLPTracer added in v1.7.0 

type OTLPTracer struct {
	// contains filtered or unexported fields
}

func NewOTLPTracer added in v1.7.0 

func NewOTLPTracer(ctx context.Context, urlStr string, proxyURL *url.URL, headers map[string]string, tlsConfig *tls.Config, username string, password string) (*OTLPTracer, error)

func (*OTLPTracer) Post added in v1.7.0 

func (t *OTLPTracer) Post(ctx context.Context, event eventv1.Event) error

Post implements the notifier.Interface

type Opsgenie added in v0.17.0 

type Opsgenie struct {
	URL         string
	ProxyURL    *url.URL
	TLSConfig   *tls.Config
	ApiKey      string
	ProviderUID string
}

func NewOpsgenie added in v0.17.0 

func NewOpsgenie(hookURL string, proxyURL *url.URL, tlsConfig *tls.Config, token string, providerUID string) (*Opsgenie, error)

func (*Opsgenie) Post added in v0.17.0 

func (s *Opsgenie) Post(ctx context.Context, event eventv1.Event) error

Post opsgenie alert message

type OpsgenieAlert added in v0.17.0 

type OpsgenieAlert struct {
	Message     string            `json:"message"`
	Alias       string            `json:"alias,omitempty"`
	Description string            `json:"description"`
	Details     map[string]string `json:"details"`
}

type Option added in v1.6.0 

type Option func(*notifierOptions)

Option represents a functional option for configuring a notifier.

func WithCertPool added in v1.6.0 

func WithCertPool(certPool *x509.CertPool) Option

WithCertPool sets the certificate pool for the notifier.

func WithChannel added in v1.6.0 

func WithChannel(channel string) Option

WithChannel sets the channel for the notifier.

func WithCommitStatus added in v1.6.0 

func WithCommitStatus(commitStatus string) Option

WithCommitStatus sets the custom commit status for the notifier.

func WithDefaultServiceAccount added in v1.10.0 

func WithDefaultServiceAccount(serviceAccountName string) Option

WithDefaultServiceAccount sets the default service account for the notifier, used when .spec.serviceAccountName is not specified.

func WithEventKey added in v1.10.0 

func WithEventKey(key string) Option

WithEventKey sets the key identifying the event being dispatched.

func WithHeaders added in v1.6.0 

func WithHeaders(headers map[string]string) Option

WithHeaders sets the headers for the notifier.

func WithPassword added in v1.6.0 

func WithPassword(password string) Option

WithPassword sets the password for the notifier.

func WithProviderName added in v1.6.0 

func WithProviderName(name string) Option

WithProviderName sets the provider name for the notifier.

func WithProviderNamespace added in v1.6.0 

func WithProviderNamespace(namespace string) Option

WithProviderNamespace sets the provider namespace for the notifier.

func WithProviderUID added in v1.8.0 

func WithProviderUID(uid string) Option

WithProviderUID sets the provider UID for the notifier.

func WithProxyURL added in v1.6.0 

func WithProxyURL(proxyURL *url.URL) Option

WithProxyURL sets the proxy URL for the notifier.

func WithSPIFFEBroker added in v1.10.0 

func WithSPIFFEBroker(client fluxbroker.Interface) Option

WithSPIFFEBroker sets the client used to fetch JWT-SVIDs for the `spiffe` credential provider.

func WithSecretData added in v1.6.0 

func WithSecretData(data map[string][]byte) Option

WithSecretData sets the secret data for the notifier.

func WithServiceAccount added in v1.6.0 

func WithServiceAccount(serviceAccountName string) Option

WithServiceAccount sets the service account for the notifier.

func WithTLSConfig added in v1.7.0 

func WithTLSConfig(tlsConfig *tls.Config) Option

WithTLSConfig sets the TLS configuration for the notifier.

func WithTimeout added in v1.10.0 

func WithTimeout(timeout time.Duration) Option

WithTimeout sets the provider timeout for clients without context support.

func WithToken added in v1.6.0 

func WithToken(token string) Option

WithToken sets the token for the notifier.

func WithTokenCache added in v1.6.0 

func WithTokenCache(cache *cache.TokenCache) Option

WithTokenCache sets the token cache for the notifier.

func WithTokenClient added in v1.6.0 

func WithTokenClient(kubeClient client.Client) Option

WithTokenClient sets the token client for the notifier.

func WithURL added in v1.7.0 

func WithURL(url string) Option

WithURL sets the webhook URL for the notifier.

func WithUsername added in v1.6.0 

func WithUsername(username string) Option

WithUsername sets the username for the notifier.

type PagerDuty added in v1.0.0 

type PagerDuty struct {
	Endpoint   string
	RoutingKey string
	ProxyURL   *url.URL
	TLSConfig  *tls.Config
}

func NewPagerDuty added in v1.0.0 

func NewPagerDuty(endpoint string, proxyURL *url.URL, tlsConfig *tls.Config, routingKey string) (*PagerDuty, error)

func (*PagerDuty) Post added in v1.0.0 

func (p *PagerDuty) Post(ctx context.Context, event eventv1.Event) error

type PureJWT added in v0.14.0 

type PureJWT struct {
	// contains filtered or unexported fields
}

PureJWT just contains the jwt

func (*PureJWT) GetToken added in v0.14.0 

func (j *PureJWT) GetToken(ctx context.Context, options policy.TokenRequestOptions) (azcore.AccessToken, error)

GetToken uses a JWT token, we assume that we will get new tokens when needed, thus no Expiry defined

type Rocket 

type Rocket struct {
	URL       string
	ProxyURL  *url.URL
	Username  string
	Channel   string
	TLSConfig *tls.Config
}

Rocket holds the hook URL

func NewRocket 

func NewRocket(hookURL string, proxyURL *url.URL, tlsConfig *tls.Config, username string, channel string) (*Rocket, error)

NewRocket validates the Rocket URL and returns a Rocket object

func (*Rocket) Post 

func (s *Rocket) Post(ctx context.Context, event eventv1.Event) error

Post Rocket message

type Sentry added in v0.12.0 

type Sentry struct {
	Client *sentry.Client
}

Sentry holds the client instance

func NewSentry added in v0.12.0 

func NewSentry(dsn string, proxyURL *url.URL, tlsConfig *tls.Config, environment string) (*Sentry, error)

NewSentry creates a Sentry client from the provided Data Source Name (DSN)

func (*Sentry) Post added in v0.12.0 

func (s *Sentry) Post(ctx context.Context, event eventv1.Event) error

Post event to Sentry

type Slack 

type Slack struct {
	URL       string
	ProxyURL  *url.URL
	Token     string
	Username  string
	Channel   string
	TLSConfig *tls.Config
}

Slack holds the hook URL

func NewSlack 

func NewSlack(hookURL string, proxyURL *url.URL, token string, tlsConfig *tls.Config, username string, channel string) (*Slack, error)

NewSlack validates the Slack URL and returns a Slack object

func (*Slack) Post 

func (s *Slack) Post(ctx context.Context, event eventv1.Event) error

Post Slack message

type SlackAttachment 

type SlackAttachment struct {
	Fallback   string       `json:"fallback"`
	Color      string       `json:"color"`
	AuthorName string       `json:"author_name"`
	Text       string       `json:"text"`
	MrkdwnIn   []string     `json:"mrkdwn_in"`
	Fields     []SlackField `json:"fields"`
}

SlackAttachment holds the markdown message body

type SlackField 

type SlackField struct {
	Title string `json:"title"`
	Value string `json:"value"`
	Short bool   `json:"short"`
}

type SlackPayload 

type SlackPayload struct {
	Channel     string            `json:"channel"`
	Username    string            `json:"username"`
	IconUrl     string            `json:"icon_url"`
	IconEmoji   string            `json:"icon_emoji"`
	Text        string            `json:"text,omitempty"`
	Attachments []SlackAttachment `json:"attachments,omitempty"`
}

SlackPayload holds the channel and attachments

type Telegram added in v0.16.0 

type Telegram struct {
	ProxyURL  *url.URL
	Channel   string
	Token     string
	TLSConfig *tls.Config
	// contains filtered or unexported fields
}

func NewTelegram added in v0.16.0 

func NewTelegram(proxyURL *url.URL, tlsConfig *tls.Config, channel, token string) (*Telegram, error)

func (*Telegram) Post added in v0.16.0 

func (t *Telegram) Post(ctx context.Context, event eventv1.Event) error

type TelegramPayload added in v1.7.0 

type TelegramPayload struct {
	ChatID          string `json:"chat_id"`                     // Unique identifier for the target chat
	MessageThreadID string `json:"message_thread_id,omitempty"` // Unique identifier for the target message thread (topic) of the forum; for forum supergroups only
	Text            string `json:"text"`                        // Text of the message to be sent
	ParseMode       string `json:"parse_mode"`                  // Mode for parsing entities in the message text
}

TelegramPayload represents the payload sent to Telegram Bot API Reference: https://core.telegram.org/bots/api#sendmessage

type Webex added in v0.11.0 

type Webex struct {
	// mandatory: this should be set to the universal webex API server https://webexapis.com/v1/messages
	URL string
	// mandatory: webex room ID, specifies on which webex space notifications must be sent
	RoomId string
	// mandatory: webex bot access token, this access token must be generated after creating a webex bot
	Token string

	// optional: use a proxy as needed
	ProxyURL  *url.URL
	TLSConfig *tls.Config
}

Webex holds the hook URL

func NewWebex added in v0.11.0 

func NewWebex(hookURL string, proxyURL *url.URL, tlsConfig *tls.Config, channel string, token string) (*Webex, error)

NewWebex validates the Webex URL and returns a Webex object

func (*Webex) CreateMarkdown added in v0.23.2 

func (s *Webex) CreateMarkdown(event *eventv1.Event) string

func (*Webex) Post added in v0.11.0 

func (s *Webex) Post(ctx context.Context, event eventv1.Event) error

Post Webex message

type WebexPayload added in v0.11.0 

type WebexPayload struct {
	RoomId   string `json:"roomId,omitempty"`
	Markdown string `json:"markdown,omitempty"`
}

WebexPayload holds the message text

type Zoom added in v1.10.0 

type Zoom struct {
	URL       string
	ProxyURL  *url.URL
	Token     string
	TLSConfig *tls.Config
}

Zoom holds the incoming webhook URL and verification token for a Zoom Team Chat Incoming Webhook chatbot connection.

func NewZoom added in v1.10.0 

func NewZoom(hookURL string, proxyURL *url.URL, tlsConfig *tls.Config, token string) (*Zoom, error)

NewZoom validates the Zoom incoming webhook URL and returns a Zoom object

func (*Zoom) Post added in v1.10.0 

func (s *Zoom) Post(ctx context.Context, event eventv1.Event) error

Post Zoom Team Chat message

type ZoomBodyItem added in v1.10.0 

type ZoomBodyItem struct {
	Type  string      `json:"type"`
	Text  string      `json:"text,omitempty"`
	Items []ZoomField `json:"items,omitempty"`
}

type ZoomContent added in v1.10.0 

type ZoomContent struct {
	Head ZoomHead       `json:"head"`
	Body []ZoomBodyItem `json:"body"`
}

type ZoomField added in v1.10.0 

type ZoomField struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type ZoomHead added in v1.10.0 

type ZoomHead struct {
	Text    string       `json:"text"`
	SubHead *ZoomSubHead `json:"sub_head,omitempty"`
}

type ZoomPayload added in v1.10.0 

type ZoomPayload struct {
	Content ZoomContent `json:"content"`
}

ZoomPayload is the rich message format accepted by the Incoming Webhook endpoint when called with `?format=full`.

type ZoomSubHead added in v1.10.0 

type ZoomSubHead struct {
	Text string `json:"text"`
}

type Zulip added in v1.7.0 

type Zulip struct {
	// contains filtered or unexported fields
}

func NewZulip added in v1.7.0 

func NewZulip(endpoint, channel string, proxyURL *url.URL, tlsConfig *tls.Config, username, password string) (*Zulip, error)

func (*Zulip) Post added in v1.7.0 

func (z *Zulip) Post(ctx context.Context, event eventv1.Event) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.