Documentation ¶
Overview ¶
Package v1beta3 contains API Schema definitions for the notification v1beta3 API group. +kubebuilder:object:generate=true +groupName=notification.toolkit.fluxcd.io
Index ¶
Constants ¶
const ( ProviderKind string = "Provider" GenericProvider string = "generic" GenericHMACProvider string = "generic-hmac" SlackProvider string = "slack" GrafanaProvider string = "grafana" DiscordProvider string = "discord" MSTeamsProvider string = "msteams" RocketProvider string = "rocket" GitHubDispatchProvider string = "githubdispatch" GitHubProvider string = "github" GitLabProvider string = "gitlab" GiteaProvider string = "gitea" BitbucketServerProvider string = "bitbucketserver" BitbucketProvider string = "bitbucket" AzureDevOpsProvider string = "azuredevops" GoogleChatProvider string = "googlechat" GooglePubSubProvider string = "googlepubsub" WebexProvider string = "webex" SentryProvider string = "sentry" AzureEventHubProvider string = "azureeventhub" TelegramProvider string = "telegram" LarkProvider string = "lark" Matrix string = "matrix" OpsgenieProvider string = "opsgenie" AlertManagerProvider string = "alertmanager" PagerDutyProvider string = "pagerduty" DataDogProvider string = "datadog" NATSProvider string = "nats" )
const (
AlertKind string = "Alert"
)
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "notification.toolkit.fluxcd.io", Version: "v1beta3"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type Alert ¶
type Alert struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec AlertSpec `json:"spec,omitempty"` }
Alert is the Schema for the alerts API
func (*Alert) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Alert.
func (*Alert) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Alert) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AlertList ¶
type AlertList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Alert `json:"items"` }
AlertList contains a list of Alert
func (*AlertList) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AlertList.
func (*AlertList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AlertList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AlertSpec ¶
type AlertSpec struct { // ProviderRef specifies which Provider this Alert should use. // +required ProviderRef meta.LocalObjectReference `json:"providerRef"` // EventSeverity specifies how to filter events based on severity. // If set to 'info' no events will be filtered. // +kubebuilder:validation:Enum=info;error // +kubebuilder:default:=info // +optional EventSeverity string `json:"eventSeverity,omitempty"` // EventSources specifies how to filter events based // on the involved object kind, name and namespace. // +required EventSources []v1.CrossNamespaceObjectReference `json:"eventSources"` // InclusionList specifies a list of Golang regular expressions // to be used for including messages. // +optional InclusionList []string `json:"inclusionList,omitempty"` // EventMetadata is an optional field for adding metadata to events dispatched by the // controller. This can be used for enhancing the context of the event. If a field // would override one already present on the original event as generated by the emitter, // then the override doesn't happen, i.e. the original value is preserved, and an info // log is printed. // +optional EventMetadata map[string]string `json:"eventMetadata,omitempty"` // ExclusionList specifies a list of Golang regular expressions // to be used for excluding messages. // +optional ExclusionList []string `json:"exclusionList,omitempty"` // Summary holds a short description of the impact and affected cluster. // +kubebuilder:validation:MaxLength:=255 // +optional Summary string `json:"summary,omitempty"` // Suspend tells the controller to suspend subsequent // events handling for this Alert. // +optional Suspend bool `json:"suspend,omitempty"` }
AlertSpec defines an alerting rule for events involving a list of objects.
func (*AlertSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AlertSpec.
func (*AlertSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Provider ¶
type Provider struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ProviderSpec `json:"spec,omitempty"` }
Provider is the Schema for the providers API
func (*Provider) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Provider.
func (*Provider) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Provider) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Provider) GetTimeout ¶
GetTimeout returns the timeout value with a default of 15s for this Provider.
type ProviderList ¶
type ProviderList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Provider `json:"items"` }
ProviderList contains a list of Provider
func (*ProviderList) DeepCopy ¶
func (in *ProviderList) DeepCopy() *ProviderList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderList.
func (*ProviderList) DeepCopyInto ¶
func (in *ProviderList) DeepCopyInto(out *ProviderList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ProviderList) DeepCopyObject ¶
func (in *ProviderList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ProviderSpec ¶
type ProviderSpec struct { // Type specifies which Provider implementation to use. // +kubebuilder:validation:Enum=slack;discord;msteams;rocket;generic;generic-hmac;github;gitlab;gitea;bitbucketserver;bitbucket;azuredevops;googlechat;googlepubsub;webex;sentry;azureeventhub;telegram;lark;matrix;opsgenie;alertmanager;grafana;githubdispatch;pagerduty;datadog;nats // +required Type string `json:"type"` // Interval at which to reconcile the Provider with its Secret references. // Deprecated and not used in v1beta3. // // +kubebuilder:validation:Type=string // +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$" // +optional // +deprecated Interval *metav1.Duration `json:"interval,omitempty"` // Channel specifies the destination channel where events should be posted. // +kubebuilder:validation:MaxLength:=2048 // +optional Channel string `json:"channel,omitempty"` // Username specifies the name under which events are posted. // +kubebuilder:validation:MaxLength:=2048 // +optional Username string `json:"username,omitempty"` // Address specifies the endpoint, in a generic sense, to where alerts are sent. // What kind of endpoint depends on the specific Provider type being used. // For the generic Provider, for example, this is an HTTP/S address. // For other Provider types this could be a project ID or a namespace. // +kubebuilder:validation:MaxLength:=2048 // +kubebuilder:validation:Optional // +optional Address string `json:"address,omitempty"` // Timeout for sending alerts to the Provider. // +kubebuilder:validation:Type=string // +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ms|s|m))+$" // +optional Timeout *metav1.Duration `json:"timeout,omitempty"` // Proxy the HTTP/S address of the proxy server. // +kubebuilder:validation:Pattern="^(http|https)://.*$" // +kubebuilder:validation:MaxLength:=2048 // +kubebuilder:validation:Optional // +optional Proxy string `json:"proxy,omitempty"` // SecretRef specifies the Secret containing the authentication // credentials for this Provider. // +optional SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"` // CertSecretRef specifies the Secret containing // a PEM-encoded CA certificate (in the `ca.crt` key). // +optional // // Note: Support for the `caFile` key has // been deprecated. CertSecretRef *meta.LocalObjectReference `json:"certSecretRef,omitempty"` // Suspend tells the controller to suspend subsequent // events handling for this Provider. // +optional Suspend bool `json:"suspend,omitempty"` }
ProviderSpec defines the desired state of the Provider.
func (*ProviderSpec) DeepCopy ¶
func (in *ProviderSpec) DeepCopy() *ProviderSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ProviderSpec.
func (*ProviderSpec) DeepCopyInto ¶
func (in *ProviderSpec) DeepCopyInto(out *ProviderSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.