Notification API reference
Packages:
notification.toolkit.fluxcd.io/v1beta1
Package v1beta1 contains API Schema definitions for the notification v1beta1 API group
Resource Types:Alert
Alert is the Schema for the alerts API
Field | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | notification.toolkit.fluxcd.io/v1beta1 | ||||||||||||
kind string | Alert | ||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
metadata field. | ||||||||||||
spec AlertSpec |
| ||||||||||||
status AlertStatus |
Provider
Provider is the Schema for the providers API
Field | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | notification.toolkit.fluxcd.io/v1beta1 | ||||||||||||||||
kind string | Provider | ||||||||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
metadata field. | ||||||||||||||||
spec ProviderSpec |
| ||||||||||||||||
status ProviderStatus |
Receiver
Receiver is the Schema for the receivers API
Field | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
apiVersion string | notification.toolkit.fluxcd.io/v1beta1 | ||||||||||
kind string | Receiver | ||||||||||
metadata Kubernetes meta/v1.ObjectMeta | Refer to the Kubernetes API documentation for the fields of the
metadata field. | ||||||||||
spec ReceiverSpec |
| ||||||||||
status ReceiverStatus |
AlertSpec
(Appears on: Alert)
AlertSpec defines an alerting rule for events involving a list of objects
Field | Description |
---|---|
providerRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference | Send events using this provider. |
eventSeverity string | (Optional) Filter events based on severity, defaults to (‘info’). If set to ‘info’ no events will be filtered. |
eventSources []CrossNamespaceObjectReference | Filter events based on the involved objects. |
exclusionList []string | (Optional) A list of Golang regular expressions to be used for excluding messages. |
summary string | (Optional) Short description of the impact and affected cluster. |
suspend bool | (Optional) This flag tells the controller to suspend subsequent events dispatching. Defaults to false. |
AlertStatus
(Appears on: Alert)
AlertStatus defines the observed state of Alert
Field | Description |
---|---|
conditions []Kubernetes meta/v1.Condition | (Optional) |
observedGeneration int64 | (Optional) ObservedGeneration is the last observed generation. |
CrossNamespaceObjectReference
(Appears on: AlertSpec, ReceiverSpec)
CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level
Field | Description |
---|---|
apiVersion string | (Optional) API version of the referent |
kind string | Kind of the referent |
name string | Name of the referent |
namespace string | (Optional) Namespace of the referent |
matchLabels map[string]string | (Optional) MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed. |
ProviderSpec
(Appears on: Provider)
ProviderSpec defines the desired state of Provider
Field | Description |
---|---|
type string | Type of provider |
channel string | (Optional) Alert channel for this provider |
username string | (Optional) Bot username for this provider |
address string | (Optional) HTTP/S webhook address of this provider |
proxy string | (Optional) HTTP/S address of the proxy |
secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference | (Optional) Secret reference containing the provider webhook URL using “address” as data key |
certSecretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference | (Optional) CertSecretRef can be given the name of a secret containing
a PEM-encoded CA certificate ( |
suspend bool | (Optional) This flag tells the controller to suspend subsequent events handling. Defaults to false. |
ProviderStatus
(Appears on: Provider)
ProviderStatus defines the observed state of Provider
Field | Description |
---|---|
observedGeneration int64 | (Optional) ObservedGeneration is the last reconciled generation. |
conditions []Kubernetes meta/v1.Condition | (Optional) |
ReceiverSpec
(Appears on: Receiver)
ReceiverSpec defines the desired state of Receiver
Field | Description |
---|---|
type string | Type of webhook sender, used to determine the validation procedure and payload deserialization. |
events []string | (Optional) A list of events to handle, e.g. ‘push’ for GitHub or ‘Push Hook’ for GitLab. |
resources []CrossNamespaceObjectReference | A list of resources to be notified about changes. |
secretRef github.com/fluxcd/pkg/apis/meta.LocalObjectReference | Secret reference containing the token used to validate the payload authenticity |
suspend bool | (Optional) This flag tells the controller to suspend subsequent events handling. Defaults to false. |
ReceiverStatus
(Appears on: Receiver)
ReceiverStatus defines the observed state of Receiver
Field | Description |
---|---|
conditions []Kubernetes meta/v1.Condition | (Optional) |
url string | (Optional) Generated webhook URL in the format of ‘/hook/sha256sum(token+name+namespace)’. |
observedGeneration int64 | (Optional) ObservedGeneration is the last observed generation. |
This page was automatically generated with gen-crd-api-reference-docs