Notification API reference v1beta3

The GitOps Toolkit Custom Resource Definitions documentation.

Packages:

notification.toolkit.fluxcd.io/v1beta3

Package v1beta3 contains API Schema definitions for the notification v1beta3 API group.

Resource Types:

Alert

Alert is the Schema for the alerts API

FieldDescription
apiVersion
string
notification.toolkit.fluxcd.io/v1beta3
kind
string
Alert
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
AlertSpec


providerRef
github.com/fluxcd/pkg/apis/meta.LocalObjectReference

ProviderRef specifies which Provider this Alert should use.

eventSeverity
string
(Optional)

EventSeverity specifies how to filter events based on severity. If set to ‘info’ no events will be filtered.

eventSources
[]github.com/fluxcd/notification-controller/api/v1.CrossNamespaceObjectReference

EventSources specifies how to filter events based on the involved object kind, name and namespace.

inclusionList
[]string
(Optional)

InclusionList specifies a list of Golang regular expressions to be used for including messages.

eventMetadata
map[string]string
(Optional)

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.

exclusionList
[]string
(Optional)

ExclusionList specifies a list of Golang regular expressions to be used for excluding messages.

summary
string
(Optional)

Summary holds a short description of the impact and affected cluster.

suspend
bool
(Optional)

Suspend tells the controller to suspend subsequent events handling for this Alert.

Provider

Provider is the Schema for the providers API

FieldDescription
apiVersion
string
notification.toolkit.fluxcd.io/v1beta3
kind
string
Provider
metadata
Kubernetes meta/v1.ObjectMeta
Refer to the Kubernetes API documentation for the fields of the metadata field.
spec
ProviderSpec


type
string

Type specifies which Provider implementation to use.

interval
Kubernetes meta/v1.Duration
(Optional)

Interval at which to reconcile the Provider with its Secret references. Deprecated and not used in v1beta3.

channel
string
(Optional)

Channel specifies the destination channel where events should be posted.

username
string
(Optional)

Username specifies the name under which events are posted.

address
string
(Optional)

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.

timeout
Kubernetes meta/v1.Duration
(Optional)

Timeout for sending alerts to the Provider.

proxy
string
(Optional)

Proxy the HTTP/S address of the proxy server.

secretRef
github.com/fluxcd/pkg/apis/meta.LocalObjectReference
(Optional)

SecretRef specifies the Secret containing the authentication credentials for this Provider.

certSecretRef
github.com/fluxcd/pkg/apis/meta.LocalObjectReference
(Optional)

CertSecretRef specifies the Secret containing a PEM-encoded CA certificate (in the ca.crt key).

Note: Support for the caFile key has been deprecated.

suspend
bool
(Optional)

Suspend tells the controller to suspend subsequent events handling for this Provider.

AlertSpec

(Appears on: Alert)

AlertSpec defines an alerting rule for events involving a list of objects.

FieldDescription
providerRef
github.com/fluxcd/pkg/apis/meta.LocalObjectReference

ProviderRef specifies which Provider this Alert should use.

eventSeverity
string
(Optional)

EventSeverity specifies how to filter events based on severity. If set to ‘info’ no events will be filtered.

eventSources
[]github.com/fluxcd/notification-controller/api/v1.CrossNamespaceObjectReference

EventSources specifies how to filter events based on the involved object kind, name and namespace.

inclusionList
[]string
(Optional)

InclusionList specifies a list of Golang regular expressions to be used for including messages.

eventMetadata
map[string]string
(Optional)

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.

exclusionList
[]string
(Optional)

ExclusionList specifies a list of Golang regular expressions to be used for excluding messages.

summary
string
(Optional)

Summary holds a short description of the impact and affected cluster.

suspend
bool
(Optional)

Suspend tells the controller to suspend subsequent events handling for this Alert.

ProviderSpec

(Appears on: Provider)

ProviderSpec defines the desired state of the Provider.

FieldDescription
type
string

Type specifies which Provider implementation to use.

interval
Kubernetes meta/v1.Duration
(Optional)

Interval at which to reconcile the Provider with its Secret references. Deprecated and not used in v1beta3.

channel
string
(Optional)

Channel specifies the destination channel where events should be posted.

username
string
(Optional)

Username specifies the name under which events are posted.

address
string
(Optional)

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.

timeout
Kubernetes meta/v1.Duration
(Optional)

Timeout for sending alerts to the Provider.

proxy
string
(Optional)

Proxy the HTTP/S address of the proxy server.

secretRef
github.com/fluxcd/pkg/apis/meta.LocalObjectReference
(Optional)

SecretRef specifies the Secret containing the authentication credentials for this Provider.

certSecretRef
github.com/fluxcd/pkg/apis/meta.LocalObjectReference
(Optional)

CertSecretRef specifies the Secret containing a PEM-encoded CA certificate (in the ca.crt key).

Note: Support for the caFile key has been deprecated.

suspend
bool
(Optional)

Suspend tells the controller to suspend subsequent events handling for this Provider.

This page was automatically generated with gen-crd-api-reference-docs