flux v2.9.5

Receiver.spec

ReceiverSpec defines the desired state of the Receiver.

8 fields
Receiver.spec fields and descriptions
Field / TypeDescription
string[]

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

interval
string

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

  • default: "10m"
  • pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m|h))+$
object[]

OIDCProviders specifies the OIDC providers used to authenticate incoming requests when Type is 'generic-oidc'. The provider whose IssuerURL matches the token's 'iss' claim is used to verify the token signature, expiration and audience, and to evaluate the configured CEL validations against the token claims.

  • x-kubernetes-list-map-keys: ["issuerURL"]
  • x-kubernetes-list-type: "map"
resourceFilter
string

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. The expression can read the resource metadata via 'res' and the webhook request body via 'req'. For generic-oidc receivers, the verified OIDC token claims are also available via 'claims'. 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.

object[] required

A list of resources to be notified about changes.

object

SecretRef specifies the Secret containing the token used to validate the payload authenticity. The Secret must contain a 'token' key. For GCR receivers, the Secret must also contain an 'email' key with the IAM service account email configured on the Pub/Sub push subscription, and an 'audience' key with the expected OIDC token audience. Required for all receiver types except 'generic-oidc', which authenticates requests using the OIDC token instead and must not set this field.

suspend
boolean

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

type
string required

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

  • enum: ["generic","generic-hmac","generic-oidc","github","gitlab","bitbucket","harbor","dockerhub","quay","gcr","nexus","acr","cdevents"]