notification-controller/docs/api/notification.md

Kustomize API reference

Packages:

• notification.fluxcd.io/v1alpha1

notification.fluxcd.io/v1alpha1

Package v1alpha1 contains API Schema definitions for the notification v1alpha1 API group

Resource Types:

• Alert
• Provider
• Receiver

Alert

Alert is the Schema for the alerts API

Field	Description
apiVersion string	notification.fluxcd.io/v1alpha1
kind string	Alert
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec AlertSpec	providerRef Kubernetes core/v1.LocalObjectReference Send events using this provider eventSeverity string (Optional) Filter events based on severity, defaults to (‘info’). eventSources []CrossNamespaceObjectReference Filter events based on the involved objects suspend bool (Optional) This flag tells the controller to suspend subsequent events dispatching. Defaults to false.
status AlertStatus

Provider

Provider is the Schema for the providers API

Field	Description
apiVersion string	notification.fluxcd.io/v1alpha1
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 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 secretRef Kubernetes core/v1.LocalObjectReference (Optional) Secret reference containing the provider webhook URL
status ProviderStatus

Receiver

Receiver is the Schema for the receivers API

Field	Description
apiVersion string	notification.fluxcd.io/v1alpha1
kind string	Receiver
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec ReceiverSpec	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 Kubernetes core/v1.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.
status ReceiverStatus

AlertSpec

(Appears on: Alert)

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

Field	Description
providerRef Kubernetes core/v1.LocalObjectReference	Send events using this provider
eventSeverity string	(Optional) Filter events based on severity, defaults to (‘info’).
eventSources []CrossNamespaceObjectReference	Filter events based on the involved objects
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 []Condition	(Optional)

Condition

(Appears on: AlertStatus, ProviderStatus, ReceiverStatus)

Condition contains condition information for a notification object.

Field	Description
type string	Type of the condition, currently (‘Ready’).
status Kubernetes core/v1.ConditionStatus	Status of the condition, one of (‘True’, ‘False’, ‘Unknown’).
lastTransitionTime Kubernetes meta/v1.Time	LastTransitionTime is the timestamp corresponding to the last status change of this condition.
reason string	Reason is a brief machine readable explanation for the condition’s last transition.
message string	(Optional) Message is a human readable description of the details of the last transition, complementing reason.

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

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
secretRef Kubernetes core/v1.LocalObjectReference	(Optional) Secret reference containing the provider webhook URL

ProviderStatus

(Appears on: Provider)

ProviderStatus defines the observed state of Provider

Field	Description
conditions []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 Kubernetes core/v1.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 []Condition	(Optional)
url string	(Optional) Generated webhook URL in the format of ‘/hook/sha256sum(token+name+namespace)’.

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