You are viewing documentation for Flux version: 2.0

Version 2.0 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

Notification API reference v1beta2

The GitOps Toolkit Custom Resource Definitions documentation.

Packages:

notification.toolkit.fluxcd.io/v1beta2

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

Resource Types:

Alert

Alert is the Schema for the alerts API

FieldDescription
apiVersion
string
notification.toolkit.fluxcd.io/v1beta2
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.

status
AlertStatus

Provider

Provider is the Schema for the providers API.

FieldDescription
apiVersion
string
notification.toolkit.fluxcd.io/v1beta2
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.

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 (caFile).

suspend
bool
(Optional)

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

status
ProviderStatus

Receiver

Receiver is the Schema for the receivers API.

FieldDescription
apiVersion
string
notification.toolkit.fluxcd.io/v1beta2
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.

interval
Kubernetes meta/v1.Duration
(Optional)

Interval at which to reconcile the Receiver with its Secret references.

events
[]string
(Optional)

Events specifies the list of event types to handle, e.g. ‘push’ for GitHub or ‘Push Hook’ for GitLab.

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

A list of resources to be notified about changes.

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

SecretRef specifies the Secret containing the token used to validate the payload authenticity.

suspend
bool
(Optional)

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

status
ReceiverStatus

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.

AlertStatus

(Appears on: Alert)

AlertStatus defines the observed state of the Alert.

FieldDescription
ReconcileRequestStatus
github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus

(Members of ReconcileRequestStatus are embedded into this type.)

conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions holds the conditions for the Alert.

observedGeneration
int64
(Optional)

ObservedGeneration is the last observed generation.

CrossNamespaceObjectReference

CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level

FieldDescription
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 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.

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 (caFile).

suspend
bool
(Optional)

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

ProviderStatus

(Appears on: Provider)

ProviderStatus defines the observed state of the Provider.

FieldDescription
ReconcileRequestStatus
github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus

(Members of ReconcileRequestStatus are embedded into this type.)

conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions holds the conditions for the Provider.

observedGeneration
int64
(Optional)

ObservedGeneration is the last reconciled generation.

ReceiverSpec

(Appears on: Receiver)

ReceiverSpec defines the desired state of the Receiver.

FieldDescription
type
string

Type of webhook sender, used to determine the validation procedure and payload deserialization.

interval
Kubernetes meta/v1.Duration
(Optional)

Interval at which to reconcile the Receiver with its Secret references.

events
[]string
(Optional)

Events specifies the list of event types to handle, e.g. ‘push’ for GitHub or ‘Push Hook’ for GitLab.

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

A list of resources to be notified about changes.

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

SecretRef specifies the Secret containing the token used to validate the payload authenticity.

suspend
bool
(Optional)

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

ReceiverStatus

(Appears on: Receiver)

ReceiverStatus defines the observed state of the Receiver.

FieldDescription
ReconcileRequestStatus
github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus

(Members of ReconcileRequestStatus are embedded into this type.)

conditions
[]Kubernetes meta/v1.Condition
(Optional)

Conditions holds the conditions for the Receiver.

url
string
(Optional)

URL is the generated incoming webhook address in the format of ‘/hook/sha256sum(token+name+namespace)’. Deprecated: Replaced by WebhookPath.

webhookPath
string
(Optional)

WebhookPath is the generated incoming webhook address in the format of ‘/hook/sha256sum(token+name+namespace)’.

observedGeneration
int64
(Optional)

ObservedGeneration is the last observed generation of the Receiver object.

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