Flux – API Reference

Flux: Notification API reference v1

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

notification.toolkit.fluxcd.io/v1

notification.toolkit.fluxcd.io/v1

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

Resource Types:

Receiver

Receiver

Receiver is the Schema for the receivers API.

Field Description

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.
`resourceFilter` string	(Optional) ResourceFilter is a CEL expression expected to return a boolean that is evaluated for each resource referenced in the Resources field when a webhook is received. If the expression returns false then the controller will not request a reconciliation for the resource. When the expression is specified the controller will parse it and mark the object as terminally failed if the expression is invalid or does not return a boolean.
`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

Field	Description
`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.

Field	Description
`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.
`resourceFilter` string	(Optional) ResourceFilter is a CEL expression expected to return a boolean that is evaluated for each resource referenced in the Resources field when a webhook is received. If the expression returns false then the controller will not request a reconciliation for the resource. When the expression is specified the controller will parse it and mark the object as terminally failed if the expression is invalid or does not return a boolean.
`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.

Field	Description
`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

Flux: Notification API reference v1beta3

Mon, 01 Jan 0001 00:00:00 +0000

Packages:

notification.toolkit.fluxcd.io/v1beta3

notification.toolkit.fluxcd.io/v1beta3

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

Resource Types:

Alert
Provider

Alert

Alert is the Schema for the alerts API

Field Description

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. Deprecated: Use EventMetadata instead.
`suspend` bool	(Optional) Suspend tells the controller to suspend subsequent events handling for this Alert.

Provider

Provider is the Schema for the providers API

Field Description

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. Deprecated: Use ProxySecretRef instead. Will be removed in v1.
`proxySecretRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) ProxySecretRef specifies the Secret containing the proxy configuration for this Provider. The Secret should contain an ‘address’ key with the HTTP/S address of the proxy server. Optional ‘username’ and ‘password’ keys can be provided for proxy authentication.
`secretRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) SecretRef specifies the Secret containing the authentication credentials for this Provider.
`serviceAccountName` string	(Optional) ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate with cloud provider services through workload identity. This enables multi-tenant authentication without storing static credentials. Supported provider types: azureeventhub, azuredevops, googlepubsub When specified, the controller will: 1. Create an OIDC token for the specified ServiceAccount 2. Exchange it for cloud provider credentials via STS 3. Use the obtained credentials for API authentication When unspecified, controller-level authentication is used (single-tenant). An error is thrown if static credentials are also defined in SecretRef. This field requires the ObjectLevelWorkloadIdentity feature gate to be enabled.
`certSecretRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) CertSecretRef specifies the Secret containing TLS certificates for secure communication. Supported configurations: - CA-only: Server authentication (provide ca.crt only) - mTLS: Mutual authentication (provide ca.crt + tls.crt + tls.key) - Client-only: Client authentication with system CA (provide tls.crt + tls.key only) Legacy keys “caFile”, “certFile”, “keyFile” are supported but deprecated. Use “ca.crt”, “tls.crt”, “tls.key” instead.
`suspend` bool	(Optional) Suspend tells the controller to suspend subsequent events handling for this Provider.
`commitStatusExpr` string	(Optional) CommitStatusExpr is a CEL expression that evaluates to a string value that can be used to generate a custom commit status message for use with eligible Provider types (github, gitlab, gitea, bitbucketserver, bitbucket, azuredevops). Supported variables are: event, provider, and alert.

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	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. Deprecated: Use EventMetadata instead.
`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.

Field	Description
`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. Deprecated: Use ProxySecretRef instead. Will be removed in v1.
`proxySecretRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) ProxySecretRef specifies the Secret containing the proxy configuration for this Provider. The Secret should contain an ‘address’ key with the HTTP/S address of the proxy server. Optional ‘username’ and ‘password’ keys can be provided for proxy authentication.
`secretRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) SecretRef specifies the Secret containing the authentication credentials for this Provider.
`serviceAccountName` string	(Optional) ServiceAccountName is the name of the Kubernetes ServiceAccount used to authenticate with cloud provider services through workload identity. This enables multi-tenant authentication without storing static credentials. Supported provider types: azureeventhub, azuredevops, googlepubsub When specified, the controller will: 1. Create an OIDC token for the specified ServiceAccount 2. Exchange it for cloud provider credentials via STS 3. Use the obtained credentials for API authentication When unspecified, controller-level authentication is used (single-tenant). An error is thrown if static credentials are also defined in SecretRef. This field requires the ObjectLevelWorkloadIdentity feature gate to be enabled.
`certSecretRef` github.com/fluxcd/pkg/apis/meta.LocalObjectReference	(Optional) CertSecretRef specifies the Secret containing TLS certificates for secure communication. Supported configurations: - CA-only: Server authentication (provide ca.crt only) - mTLS: Mutual authentication (provide ca.crt + tls.crt + tls.key) - Client-only: Client authentication with system CA (provide tls.crt + tls.key only) Legacy keys “caFile”, “certFile”, “keyFile” are supported but deprecated. Use “ca.crt”, “tls.crt”, “tls.key” instead.
`suspend` bool	(Optional) Suspend tells the controller to suspend subsequent events handling for this Provider.
`commitStatusExpr` string	(Optional) CommitStatusExpr is a CEL expression that evaluates to a string value that can be used to generate a custom commit status message for use with eligible Provider types (github, gitlab, gitea, bitbucketserver, bitbucket, azuredevops). Supported variables are: event, provider, and alert.

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