Packages:
Package v1beta1 contains API Schema definitions for the notification v1beta1 API group
Resource Types:Alert is the Schema for the alerts API
| Field | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
notification.toolkit.fluxcd.io/v1beta1
|
||||||||||||
kindstring |
Alert
|
||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||
specAlertSpec |
|
||||||||||||
statusAlertStatus |
Provider is the Schema for the providers API
| Field | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
notification.toolkit.fluxcd.io/v1beta1
|
||||||||||||||
kindstring |
Provider
|
||||||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||||||
specProviderSpec |
|
||||||||||||||
statusProviderStatus |
Receiver is the Schema for the receivers API
| Field | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
apiVersionstring |
notification.toolkit.fluxcd.io/v1beta1
|
||||||||||
kindstring |
Receiver
|
||||||||||
metadataKubernetes meta/v1.ObjectMeta |
Refer to the Kubernetes API documentation for the fields of the
metadata field.
|
||||||||||
specReceiverSpec |
|
||||||||||
statusReceiverStatus |
(Appears on: Alert)
AlertSpec defines an alerting rule for events involving a list of objects
| Field | Description |
|---|---|
providerRefgithub.com/fluxcd/pkg/apis/meta.LocalObjectReference |
Send events using this provider. |
eventSeveritystring |
(Optional)
Filter events based on severity, defaults to (‘info’). If set to ‘info’ no events will be filtered. |
eventSources[]CrossNamespaceObjectReference |
Filter events based on the involved objects. |
exclusionList[]string |
(Optional)
A list of Golang regular expressions to be used for excluding messages. |
summarystring |
(Optional)
Short description of the impact and affected cluster. |
suspendbool |
(Optional)
This flag tells the controller to suspend subsequent events dispatching. Defaults to false. |
(Appears on: Alert)
AlertStatus defines the observed state of Alert
| Field | Description |
|---|---|
conditions[]Kubernetes meta/v1.Condition |
(Optional) |
observedGenerationint64 |
(Optional)
ObservedGeneration is the last observed generation. |
(Appears on: AlertSpec, ReceiverSpec)
CrossNamespaceObjectReference contains enough information to let you locate the typed referenced object at cluster level
| Field | Description |
|---|---|
apiVersionstring |
(Optional)
API version of the referent |
kindstring |
Kind of the referent |
namestring |
Name of the referent |
namespacestring |
(Optional)
Namespace of the referent |
(Appears on: Provider)
ProviderSpec defines the desired state of Provider
| Field | Description |
|---|---|
typestring |
Type of provider |
channelstring |
(Optional)
Alert channel for this provider |
usernamestring |
(Optional)
Bot username for this provider |
addressstring |
(Optional)
HTTP/S webhook address of this provider |
proxystring |
(Optional)
HTTP/S address of the proxy |
secretRefgithub.com/fluxcd/pkg/apis/meta.LocalObjectReference |
(Optional)
Secret reference containing the provider webhook URL using “address” as data key |
certSecretRefgithub.com/fluxcd/pkg/apis/meta.LocalObjectReference |
(Optional)
CertSecretRef can be given the name of a secret containing
a PEM-encoded CA certificate ( |
(Appears on: Provider)
ProviderStatus defines the observed state of Provider
| Field | Description |
|---|---|
conditions[]Kubernetes meta/v1.Condition |
(Optional) |
(Appears on: Receiver)
ReceiverSpec defines the desired state of Receiver
| Field | Description |
|---|---|
typestring |
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. |
secretRefgithub.com/fluxcd/pkg/apis/meta.LocalObjectReference |
Secret reference containing the token used to validate the payload authenticity |
suspendbool |
(Optional)
This flag tells the controller to suspend subsequent events handling. Defaults to false. |
(Appears on: Receiver)
ReceiverStatus defines the observed state of Receiver
| Field | Description |
|---|---|
conditions[]Kubernetes meta/v1.Condition |
(Optional) |
urlstring |
(Optional)
Generated webhook URL in the format of ‘/hook/sha256sum(token+name+namespace)’. |
observedGenerationint64 |
(Optional)
ObservedGeneration is the last observed generation. |
This page was automatically generated with gen-crd-api-reference-docs