You are viewing documentation for Flux version: 2.1

Version 2.1 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 v1

The GitOps Toolkit Custom Resource Definitions documentation.

Packages:

notification.toolkit.fluxcd.io/v1

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

Resource Types:

Receiver

Receiver is the Schema for the receivers API.

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

CrossNamespaceObjectReference

(Appears on: ReceiverSpec)

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 If multiple resources are targeted * may be set.

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. MatchLabels requires the name to be set to *.

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
[]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.

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