fluxcd
/
notification-controller
mirror of https://github.com/fluxcd/notification-controller.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

API: Consolidate the documentation style for v1beta2 

Signed-off-by: Stefan Prodan <stefan.prodan@gmail.com>
This commit is contained in:
Stefan Prodan 2022-11-04 17:40:02 +02:00 committed by Hidde Beydals
parent 5fd17e6220
commit 2b35ef5845
10 changed files with 216 additions and 214 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
api/v1beta2/alert_types.go
View File

@ -25,42 +25,45 @@ const (
AlertKind string = "Alert"
)
// AlertSpec defines an alerting rule for events involving a list of objects
// AlertSpec defines an alerting rule for events involving a list of objects.
type AlertSpec struct {
// Send events using this provider.
// ProviderRef specifies which Provider this Alert should use.
// +required
ProviderRef meta.LocalObjectReference `json:"providerRef"`
// Filter events based on severity, defaults to ('info').
// EventSeverity specifies how to filter events based on severity.
// If set to 'info' no events will be filtered.
// +kubebuilder:validation:Enum=info;error
// +kubebuilder:default:=info
// +optional
EventSeverity string `json:"eventSeverity,omitempty"`
// Filter events based on the involved objects.
// EventSources specifies how to filter events based
// on the involved object kind, name and namespace.
// +required
EventSources []CrossNamespaceObjectReference `json:"eventSources"`
// A list of Golang regular expressions to be used for excluding messages.
// ExclusionList specifies a list of Golang regular expressions
// to be used for excluding messages.
// +optional
ExclusionList []string `json:"exclusionList,omitempty"`
// Short description of the impact and affected cluster.
// Summary holds a short description of the impact and affected cluster.
// +kubebuilder:validation:MaxLength:=255
// +optional
Summary string `json:"summary,omitempty"`
// This flag tells the controller to suspend subsequent events dispatching.
// Defaults to false.
// Suspend tells the controller to suspend subsequent
// events handling for this Alert.
// +optional
Suspend bool `json:"suspend,omitempty"`
}
// AlertStatus defines the observed state of Alert
// AlertStatus defines the observed state of the Alert.
type AlertStatus struct {
meta.ReconcileRequestStatus `json:",inline"`
// Conditions holds the conditions for the Alert.
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
@ -88,12 +91,6 @@ type Alert struct {
Status AlertStatus `json:"status,omitempty"`
}
// GetStatusConditions returns a pointer to the Status.Conditions slice
// Deprecated: use GetConditions instead.
func (in *Alert) GetStatusConditions() *[]metav1.Condition {
return &in.Status.Conditions
}
// GetConditions returns the status conditions of the object.
func (in *Alert) GetConditions() []metav1.Condition {
return in.Status.Conditions
@ -106,7 +103,7 @@ func (in *Alert) SetConditions(conditions []metav1.Condition) {
// +kubebuilder:object:root=true
// AlertList contains a list of Alert
// AlertList contains a list of Alerts.
type AlertList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`

2
api/v1beta2/doc.go
View File

@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
// Package v1beta2 contains API Schema definitions for the notification v1beta2 API group
// Package v1beta2 contains API Schema definitions for the notification v1beta2 API group.
// +kubebuilder:object:generate=true
// +groupName=notification.toolkit.fluxcd.io
package v1beta2

4
api/v1beta2/groupversion_info.go
View File

@ -22,10 +22,10 @@ import (
)
var (
// GroupVersion is group version used to register these objects
// GroupVersion is group version used to register these objects.
GroupVersion = schema.GroupVersion{Group: "notification.toolkit.fluxcd.io", Version: "v1beta2"}
// SchemeBuilder is used to add go types to the GroupVersionKind scheme
// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
// AddToScheme adds the types in this group-version to the given scheme.

125
api/v1beta2/provider_types.go
View File

@ -24,63 +24,7 @@ import (
)
const (
ProviderKind string = "Provider"
)
// ProviderSpec defines the desired state of Provider
type ProviderSpec struct {
// Type of provider
// +kubebuilder:validation:Enum=slack;discord;msteams;rocket;generic;generic-hmac;github;gitlab;bitbucket;azuredevops;googlechat;webex;sentry;azureeventhub;telegram;lark;matrix;opsgenie;alertmanager;grafana;githubdispatch;
// +required
Type string `json:"type"`
// Alert channel for this provider
// +kubebuilder:validation:MaxLength:=2048
// +optional
Channel string `json:"channel,omitempty"`
// Bot username for this provider
// +kubebuilder:validation:MaxLength:=2048
// +optional
Username string `json:"username,omitempty"`
// HTTP/S webhook address of this provider
// +kubebuilder:validation:Pattern="^(http|https)://"
// +kubebuilder:validation:MaxLength:=2048
// +kubebuilder:validation:Optional
// +optional
Address string `json:"address,omitempty"`
// Timeout for sending alerts to the provider.
// +kubebuilder:validation:Type=string
// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ms|s|m))+$"
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`
// HTTP/S address of the proxy
// +kubebuilder:validation:Pattern="^(http|https)://"
// +kubebuilder:validation:MaxLength:=2048
// +kubebuilder:validation:Optional
// +optional
Proxy string `json:"proxy,omitempty"`
// Secret reference containing the provider webhook URL
// using "address" as data key
// +optional
SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"`
// CertSecretRef can be given the name of a secret containing
// a PEM-encoded CA certificate (`caFile`)
// +optional
CertSecretRef *meta.LocalObjectReference `json:"certSecretRef,omitempty"`
// This flag tells the controller to suspend subsequent events handling.
// Defaults to false.
// +optional
Suspend bool `json:"suspend,omitempty"`
}
const (
ProviderKind string = "Provider"
GenericProvider string = "generic"
GenericHMACProvider string = "generic-hmac"
SlackProvider string = "slack"
@ -104,10 +48,64 @@ const (
AlertManagerProvider string = "alertmanager"
)
// ProviderStatus defines the observed state of Provider
// ProviderSpec defines the desired state of the Provider.
type ProviderSpec struct {
// Type specifies which Provider implementation to use.
// +kubebuilder:validation:Enum=slack;discord;msteams;rocket;generic;generic-hmac;github;gitlab;bitbucket;azuredevops;googlechat;webex;sentry;azureeventhub;telegram;lark;matrix;opsgenie;alertmanager;grafana;githubdispatch;
// +required
Type string `json:"type"`
// Channel specifies the destination channel where events should be posted.
// +kubebuilder:validation:MaxLength:=2048
// +optional
Channel string `json:"channel,omitempty"`
// Username specifies the name under which events are posted.
// +kubebuilder:validation:MaxLength:=2048
// +optional
Username string `json:"username,omitempty"`
// Address specifies the HTTP/S incoming webhook address of this Provider.
// +kubebuilder:validation:Pattern="^(http|https)://"
// +kubebuilder:validation:MaxLength:=2048
// +kubebuilder:validation:Optional
// +optional
Address string `json:"address,omitempty"`
// Timeout for sending alerts to the Provider.
// +kubebuilder:validation:Type=string
// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ms|s|m))+$"
// +optional
Timeout *metav1.Duration `json:"timeout,omitempty"`
// Proxy the HTTP/S address of the proxy server.
// +kubebuilder:validation:Pattern="^(http|https)://"
// +kubebuilder:validation:MaxLength:=2048
// +kubebuilder:validation:Optional
// +optional
Proxy string `json:"proxy,omitempty"`
// SecretRef specifies the Secret containing the authentication
// credentials for this Provider.
// +optional
SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"`
// CertSecretRef specifies the Secret containing
// a PEM-encoded CA certificate (`caFile`).
// +optional
CertSecretRef *meta.LocalObjectReference `json:"certSecretRef,omitempty"`
// Suspend tells the controller to suspend subsequent
// events handling for this Provider.
// +optional
Suspend bool `json:"suspend,omitempty"`
}
// ProviderStatus defines the observed state of the Provider.
type ProviderStatus struct {
meta.ReconcileRequestStatus `json:",inline"`
// Conditions holds the conditions for the Provider.
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
@ -125,7 +123,7 @@ type ProviderStatus struct {
// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].status",description=""
// +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].message",description=""
// Provider is the Schema for the providers API
// Provider is the Schema for the providers API.
type Provider struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
@ -135,12 +133,6 @@ type Provider struct {
Status ProviderStatus `json:"status,omitempty"`
}
// GetStatusConditions returns a pointer to the Status.Conditions slice
// Deprecated: use GetConditions instead.
func (in *Provider) GetStatusConditions() *[]metav1.Condition {
return &in.Status.Conditions
}
// GetConditions returns the status conditions of the object.
func (in *Provider) GetConditions() []metav1.Condition {
return in.Status.Conditions
@ -153,7 +145,7 @@ func (in *Provider) SetConditions(conditions []metav1.Condition) {
// +kubebuilder:object:root=true
// ProviderList contains a list of Provider
// ProviderList contains a list of Providers.
type ProviderList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
@ -164,6 +156,7 @@ func init() {
SchemeBuilder.Register(&Provider{}, &ProviderList{})
}
// GetTimeout returns the timeout value with a default of 15s for this Provider.
func (in *Provider) GetTimeout() time.Duration {
duration := 15 * time.Second
if in.Spec.Timeout != nil {

29
api/v1beta2/receiver_types.go
View File

@ -41,7 +41,7 @@ const (
ACRReceiver string = "acr"
)
// ReceiverSpec defines the desired state of Receiver
// ReceiverSpec defines the desired state of the Receiver.
type ReceiverSpec struct {
// Type of webhook sender, used to determine
// the validation procedure and payload deserialization.
@ -49,7 +49,7 @@ type ReceiverSpec struct {
// +required
Type string `json:"type"`
// A list of events to handle,
// Events specifies the list of event types to handle,
// e.g. 'push' for GitHub or 'Push Hook' for GitLab.
// +optional
Events []string `json:"events"`
@ -58,40 +58,35 @@ type ReceiverSpec struct {
// +required
Resources []CrossNamespaceObjectReference `json:"resources"`
// Secret reference containing the token used
// to validate the payload authenticity
// SecretRef specifies the Secret containing the token used
// to validate the payload authenticity.
// +required
SecretRef meta.LocalObjectReference `json:"secretRef,omitempty"`
// This flag tells the controller to suspend subsequent events handling.
// Defaults to false.
// Suspend tells the controller to suspend subsequent
// events handling for this receiver.
// +optional
Suspend bool `json:"suspend,omitempty"`
}
// ReceiverStatus defines the observed state of Receiver
// ReceiverStatus defines the observed state of the Receiver.
type ReceiverStatus struct {
meta.ReconcileRequestStatus `json:",inline"`
// Conditions holds the conditions for the Receiver.
// +optional
Conditions []metav1.Condition `json:"conditions,omitempty"`
// Generated webhook URL in the format
// URL is the generated incoming webhook address in the format
// of '/hook/sha256sum(token+name+namespace)'.
// +optional
URL string `json:"url,omitempty"`
// ObservedGeneration is the last observed generation.
// ObservedGeneration is the last observed generation of the Receiver object.
// +optional
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}
// GetStatusConditions returns a pointer to the Status.Conditions slice
// Deprecated: use GetConditions instead.
func (in *Receiver) GetStatusConditions() *[]metav1.Condition {
return &in.Status.Conditions
}
// GetConditions returns the status conditions of the object.
func (in *Receiver) GetConditions() []metav1.Condition {
return in.Status.Conditions
@ -117,7 +112,7 @@ func (in *Receiver) GetWebhookURL(token string) string {
// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].status",description=""
// +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].message",description=""
// Receiver is the Schema for the receivers API
// Receiver is the Schema for the receivers API.
type Receiver struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
@ -129,7 +124,7 @@ type Receiver struct {
// +kubebuilder:object:root=true
// ReceiverList contains a list of Receiver
// ReceiverList contains a list of Receivers.
type ReceiverList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`

8
api/v1beta2/reference_types.go
View File

@ -19,22 +19,22 @@ package v1beta2
// CrossNamespaceObjectReference contains enough information to let you locate the
// typed referenced object at cluster level
type CrossNamespaceObjectReference struct {
// API version of the referent
// API version of the referent.
// +optional
APIVersion string `json:"apiVersion,omitempty"`
// Kind of the referent
// Kind of the referent.
// +kubebuilder:validation:Enum=Bucket;GitRepository;Kustomization;HelmRelease;HelmChart;HelmRepository;ImageRepository;ImagePolicy;ImageUpdateAutomation;OCIRepository
// +required
Kind string `json:"kind,omitempty"`
// Name of the referent
// Name of the referent.
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=53
// +required
Name string `json:"name"`
// Namespace of the referent
// Namespace of the referent.
// +kubebuilder:validation:MinLength=1
// +kubebuilder:validation:MaxLength=53
// +kubebuilder:validation:Optional

34
config/crd/bases/notification.toolkit.fluxcd.io_alerts.yaml
View File

@ -238,27 +238,28 @@ spec:
type: object
spec:
description: AlertSpec defines an alerting rule for events involving a
list of objects
list of objects.
properties:
eventSeverity:
default: info
description: Filter events based on severity, defaults to ('info').
If set to 'info' no events will be filtered.
description: EventSeverity specifies how to filter events based on
severity. If set to 'info' no events will be filtered.
enum:
- info
- error
type: string
eventSources:
description: Filter events based on the involved objects.
description: EventSources specifies how to filter events based on
the involved object kind, name and namespace.
items:
description: CrossNamespaceObjectReference contains enough information
to let you locate the typed referenced object at cluster level
properties:
apiVersion:
description: API version of the referent
description: API version of the referent.
type: string
kind:
description: Kind of the referent
description: Kind of the referent.
enum:
- Bucket
- GitRepository
@ -281,12 +282,12 @@ spec:
are ANDed.
type: object
name:
description: Name of the referent
description: Name of the referent.
maxLength: 53
minLength: 1
type: string
namespace:
description: Namespace of the referent
description: Namespace of the referent.
maxLength: 53
minLength: 1
type: string
@ -295,13 +296,14 @@ spec:
type: object
type: array
exclusionList:
description: A list of Golang regular expressions to be used for excluding
messages.
description: ExclusionList specifies a list of Golang regular expressions
to be used for excluding messages.
items:
type: string
type: array
providerRef:
description: Send events using this provider.
description: ProviderRef specifies which Provider this Alert should
use.
properties:
name:
description: Name of the referent.
@ -310,12 +312,13 @@ spec:
- name
type: object
summary:
description: Short description of the impact and affected cluster.
description: Summary holds a short description of the impact and affected
cluster.
maxLength: 255
type: string
suspend:
description: This flag tells the controller to suspend subsequent
events dispatching. Defaults to false.
description: Suspend tells the controller to suspend subsequent events
handling for this Alert.
type: boolean
required:
- eventSources
@ -324,9 +327,10 @@ spec:
status:
default:
observedGeneration: -1
description: AlertStatus defines the observed state of Alert
description: AlertStatus defines the observed state of the Alert.
properties:
conditions:
description: Conditions holds the conditions for the Alert.
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct

33
config/crd/bases/notification.toolkit.fluxcd.io_providers.yaml
View File

@ -211,7 +211,7 @@ spec:
name: v1beta2
schema:
openAPIV3Schema:
description: Provider is the Schema for the providers API
description: Provider is the Schema for the providers API.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
@ -226,16 +226,17 @@ spec:
metadata:
type: object
spec:
description: ProviderSpec defines the desired state of Provider
description: ProviderSpec defines the desired state of the Provider.
properties:
address:
description: HTTP/S webhook address of this provider
description: Address specifies the HTTP/S incoming webhook address
of this Provider.
maxLength: 2048
pattern: ^(http|https)://
type: string
certSecretRef:
description: CertSecretRef can be given the name of a secret containing
a PEM-encoded CA certificate (`caFile`)
description: CertSecretRef specifies the Secret containing a PEM-encoded
CA certificate (`caFile`).
properties:
name:
description: Name of the referent.
@ -244,17 +245,18 @@ spec:
- name
type: object
channel:
description: Alert channel for this provider
description: Channel specifies the destination channel where events
should be posted.
maxLength: 2048
type: string
proxy:
description: HTTP/S address of the proxy
description: Proxy the HTTP/S address of the proxy server.
maxLength: 2048
pattern: ^(http|https)://
type: string
secretRef:
description: Secret reference containing the provider webhook URL
using "address" as data key
description: SecretRef specifies the Secret containing the authentication
credentials for this Provider.
properties:
name:
description: Name of the referent.
@ -263,15 +265,15 @@ spec:
- name
type: object
suspend:
description: This flag tells the controller to suspend subsequent
events handling. Defaults to false.
description: Suspend tells the controller to suspend subsequent events
handling for this Provider.
type: boolean
timeout:
description: Timeout for sending alerts to the provider.
description: Timeout for sending alerts to the Provider.
pattern: ^([0-9]+(\.[0-9]+)?(ms|s|m))+$
type: string
type:
description: Type of provider
description: Type specifies which Provider implementation to use.
enum:
- slack
- discord
@ -296,7 +298,7 @@ spec:
- githubdispatch
type: string
username:
description: Bot username for this provider
description: Username specifies the name under which events are posted.
maxLength: 2048
type: string
required:
@ -305,9 +307,10 @@ spec:
status:
default:
observedGeneration: -1
description: ProviderStatus defines the observed state of Provider
description: ProviderStatus defines the observed state of the Provider.
properties:
conditions:
description: Conditions holds the conditions for the Provider.
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct

33
config/crd/bases/notification.toolkit.fluxcd.io_receivers.yaml
View File

@ -230,7 +230,7 @@ spec:
name: v1beta2
schema:
openAPIV3Schema:
description: Receiver is the Schema for the receivers API
description: Receiver is the Schema for the receivers API.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
@ -245,11 +245,11 @@ spec:
metadata:
type: object
spec:
description: ReceiverSpec defines the desired state of Receiver
description: ReceiverSpec defines the desired state of the Receiver.
properties:
events:
description: A list of events to handle, e.g. 'push' for GitHub or
'Push Hook' for GitLab.
description: Events specifies the list of event types to handle, e.g.
'push' for GitHub or 'Push Hook' for GitLab.
items:
type: string
type: array
@ -260,10 +260,10 @@ spec:
to let you locate the typed referenced object at cluster level
properties:
apiVersion:
description: API version of the referent
description: API version of the referent.
type: string
kind:
description: Kind of the referent
description: Kind of the referent.
enum:
- Bucket
- GitRepository
@ -286,12 +286,12 @@ spec:
are ANDed.
type: object
name:
description: Name of the referent
description: Name of the referent.
maxLength: 53
minLength: 1
type: string
namespace:
description: Namespace of the referent
description: Namespace of the referent.
maxLength: 53
minLength: 1
type: string
@ -300,8 +300,8 @@ spec:
type: object
type: array
secretRef:
description: Secret reference containing the token used to validate
the payload authenticity
description: SecretRef specifies the Secret containing the token used
to validate the payload authenticity.
properties:
name:
description: Name of the referent.
@ -310,8 +310,8 @@ spec:
- name
type: object
suspend:
description: This flag tells the controller to suspend subsequent
events handling. Defaults to false.
description: Suspend tells the controller to suspend subsequent events
handling for this receiver.
type: boolean
type:
description: Type of webhook sender, used to determine the validation
@ -336,9 +336,10 @@ spec:
status:
default:
observedGeneration: -1
description: ReceiverStatus defines the observed state of Receiver
description: ReceiverStatus defines the observed state of the Receiver.
properties:
conditions:
description: Conditions holds the conditions for the Receiver.
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct
@ -412,11 +413,13 @@ spec:
be detected.
type: string
observedGeneration:
description: ObservedGeneration is the last observed generation.
description: ObservedGeneration is the last observed generation of
the Receiver object.
format: int64
type: integer
url:
description: Generated webhook URL in the format of '/hook/sha256sum(token+name+namespace)'.
description: URL is the generated incoming webhook address in the
format of '/hook/sha256sum(token+name+namespace)'.
type: string
type: object
type: object

133
docs/api/notification.md
View File

@ -6,7 +6,7 @@
</li>
</ul>
<h2 id="notification.toolkit.fluxcd.io/v1beta2">notification.toolkit.fluxcd.io/v1beta2</h2>
<p>Package v1beta2 contains API Schema definitions for the notification v1beta2 API group</p>
<p>Package v1beta2 contains API Schema definitions for the notification v1beta2 API group.</p>
Resource Types:
<ul class="simple"><li>
<a href="#notification.toolkit.fluxcd.io/v1beta2.Alert">Alert</a>
@ -82,7 +82,7 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
</em>
</td>
<td>
<p>Send events using this provider.</p>
<p>ProviderRef specifies which Provider this Alert should use.</p>
</td>
</tr>
<tr>
@ -94,7 +94,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Filter events based on severity, defaults to (&lsquo;info&rsquo;).
<p>EventSeverity specifies how to filter events based on severity.
If set to &lsquo;info&rsquo; no events will be filtered.</p>
</td>
</tr>
@ -108,7 +108,8 @@ If set to &lsquo;info&rsquo; no events will be filtered.</p>
</em>
</td>
<td>
<p>Filter events based on the involved objects.</p>
<p>EventSources specifies how to filter events based
on the involved object kind, name and namespace.</p>
</td>
</tr>
<tr>
@ -120,7 +121,8 @@ If set to &lsquo;info&rsquo; no events will be filtered.</p>
</td>
<td>
<em>(Optional)</em>
<p>A list of Golang regular expressions to be used for excluding messages.</p>
<p>ExclusionList specifies a list of Golang regular expressions
to be used for excluding messages.</p>
</td>
</tr>
<tr>
@ -132,7 +134,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Short description of the impact and affected cluster.</p>
<p>Summary holds a short description of the impact and affected cluster.</p>
</td>
</tr>
<tr>
@ -144,8 +146,8 @@ bool
</td>
<td>
<em>(Optional)</em>
<p>This flag tells the controller to suspend subsequent events dispatching.
Defaults to false.</p>
<p>Suspend tells the controller to suspend subsequent
events handling for this Alert.</p>
</td>
</tr>
</table>
@ -169,7 +171,7 @@ AlertStatus
</div>
<h3 id="notification.toolkit.fluxcd.io/v1beta2.Provider">Provider
</h3>
<p>Provider is the Schema for the providers API</p>
<p>Provider is the Schema for the providers API.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
@ -232,7 +234,7 @@ string
</em>
</td>
<td>
<p>Type of provider</p>
<p>Type specifies which Provider implementation to use.</p>
</td>
</tr>
<tr>
@ -244,7 +246,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Alert channel for this provider</p>
<p>Channel specifies the destination channel where events should be posted.</p>
</td>
</tr>
<tr>
@ -256,7 +258,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Bot username for this provider</p>
<p>Username specifies the name under which events are posted.</p>
</td>
</tr>
<tr>
@ -268,7 +270,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>HTTP/S webhook address of this provider</p>
<p>Address specifies the HTTP/S incoming webhook address of this Provider.</p>
</td>
</tr>
<tr>
@ -282,7 +284,7 @@ Kubernetes meta/v1.Duration
</td>
<td>
<em>(Optional)</em>
<p>Timeout for sending alerts to the provider.</p>
<p>Timeout for sending alerts to the Provider.</p>
</td>
</tr>
<tr>
@ -294,7 +296,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>HTTP/S address of the proxy</p>
<p>Proxy the HTTP/S address of the proxy server.</p>
</td>
</tr>
<tr>
@ -308,8 +310,8 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
</td>
<td>
<em>(Optional)</em>
<p>Secret reference containing the provider webhook URL
using &ldquo;address&rdquo; as data key</p>
<p>SecretRef specifies the Secret containing the authentication
credentials for this Provider.</p>
</td>
</tr>
<tr>
@ -323,8 +325,8 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
</td>
<td>
<em>(Optional)</em>
<p>CertSecretRef can be given the name of a secret containing
a PEM-encoded CA certificate (<code>caFile</code>)</p>
<p>CertSecretRef specifies the Secret containing
a PEM-encoded CA certificate (<code>caFile</code>).</p>
</td>
</tr>
<tr>
@ -336,8 +338,8 @@ bool
</td>
<td>
<em>(Optional)</em>
<p>This flag tells the controller to suspend subsequent events handling.
Defaults to false.</p>
<p>Suspend tells the controller to suspend subsequent
events handling for this Provider.</p>
</td>
</tr>
</table>
@ -361,7 +363,7 @@ ProviderStatus
</div>
<h3 id="notification.toolkit.fluxcd.io/v1beta2.Receiver">Receiver
</h3>
<p>Receiver is the Schema for the receivers API</p>
<p>Receiver is the Schema for the receivers API.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
@ -437,7 +439,7 @@ the validation procedure and payload deserialization.</p>
</td>
<td>
<em>(Optional)</em>
<p>A list of events to handle,
<p>Events specifies the list of event types to handle,
e.g. &lsquo;push&rsquo; for GitHub or &lsquo;Push Hook&rsquo; for GitLab.</p>
</td>
</tr>
@ -464,8 +466,8 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
</em>
</td>
<td>
<p>Secret reference containing the token used
to validate the payload authenticity</p>
<p>SecretRef specifies the Secret containing the token used
to validate the payload authenticity.</p>
</td>
</tr>
<tr>
@ -477,8 +479,8 @@ bool
</td>
<td>
<em>(Optional)</em>
<p>This flag tells the controller to suspend subsequent events handling.
Defaults to false.</p>
<p>Suspend tells the controller to suspend subsequent
events handling for this receiver.</p>
</td>
</tr>
</table>
@ -506,7 +508,7 @@ ReceiverStatus
(<em>Appears on:</em>
<a href="#notification.toolkit.fluxcd.io/v1beta2.Alert">Alert</a>)
</p>
<p>AlertSpec defines an alerting rule for events involving a list of objects</p>
<p>AlertSpec defines an alerting rule for events involving a list of objects.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
@ -527,7 +529,7 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
</em>
</td>
<td>
<p>Send events using this provider.</p>
<p>ProviderRef specifies which Provider this Alert should use.</p>
</td>
</tr>
<tr>
@ -539,7 +541,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Filter events based on severity, defaults to (&lsquo;info&rsquo;).
<p>EventSeverity specifies how to filter events based on severity.
If set to &lsquo;info&rsquo; no events will be filtered.</p>
</td>
</tr>
@ -553,7 +555,8 @@ If set to &lsquo;info&rsquo; no events will be filtered.</p>
</em>
</td>
<td>
<p>Filter events based on the involved objects.</p>
<p>EventSources specifies how to filter events based
on the involved object kind, name and namespace.</p>
</td>
</tr>
<tr>
@ -565,7 +568,8 @@ If set to &lsquo;info&rsquo; no events will be filtered.</p>
</td>
<td>
<em>(Optional)</em>
<p>A list of Golang regular expressions to be used for excluding messages.</p>
<p>ExclusionList specifies a list of Golang regular expressions
to be used for excluding messages.</p>
</td>
</tr>
<tr>
@ -577,7 +581,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Short description of the impact and affected cluster.</p>
<p>Summary holds a short description of the impact and affected cluster.</p>
</td>
</tr>
<tr>
@ -589,8 +593,8 @@ bool
</td>
<td>
<em>(Optional)</em>
<p>This flag tells the controller to suspend subsequent events dispatching.
Defaults to false.</p>
<p>Suspend tells the controller to suspend subsequent
events handling for this Alert.</p>
</td>
</tr>
</tbody>
@ -603,7 +607,7 @@ Defaults to false.</p>
(<em>Appears on:</em>
<a href="#notification.toolkit.fluxcd.io/v1beta2.Alert">Alert</a>)
</p>
<p>AlertStatus defines the observed state of Alert</p>
<p>AlertStatus defines the observed state of the Alert.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
@ -640,6 +644,7 @@ github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
</td>
<td>
<em>(Optional)</em>
<p>Conditions holds the conditions for the Alert.</p>
</td>
</tr>
<tr>
@ -686,7 +691,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>API version of the referent</p>
<p>API version of the referent.</p>
</td>
</tr>
<tr>
@ -697,7 +702,7 @@ string
</em>
</td>
<td>
<p>Kind of the referent</p>
<p>Kind of the referent.</p>
</td>
</tr>
<tr>
@ -708,7 +713,7 @@ string
</em>
</td>
<td>
<p>Name of the referent</p>
<p>Name of the referent.</p>
</td>
</tr>
<tr>
@ -720,7 +725,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Namespace of the referent</p>
<p>Namespace of the referent.</p>
</td>
</tr>
<tr>
@ -747,7 +752,7 @@ operator is &ldquo;In&rdquo;, and the values array contains only &ldquo;value&rd
(<em>Appears on:</em>
<a href="#notification.toolkit.fluxcd.io/v1beta2.Provider">Provider</a>)
</p>
<p>ProviderSpec defines the desired state of Provider</p>
<p>ProviderSpec defines the desired state of the Provider.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
@ -766,7 +771,7 @@ string
</em>
</td>
<td>
<p>Type of provider</p>
<p>Type specifies which Provider implementation to use.</p>
</td>
</tr>
<tr>
@ -778,7 +783,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Alert channel for this provider</p>
<p>Channel specifies the destination channel where events should be posted.</p>
</td>
</tr>
<tr>
@ -790,7 +795,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Bot username for this provider</p>
<p>Username specifies the name under which events are posted.</p>
</td>
</tr>
<tr>
@ -802,7 +807,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>HTTP/S webhook address of this provider</p>
<p>Address specifies the HTTP/S incoming webhook address of this Provider.</p>
</td>
</tr>
<tr>
@ -816,7 +821,7 @@ Kubernetes meta/v1.Duration
</td>
<td>
<em>(Optional)</em>
<p>Timeout for sending alerts to the provider.</p>
<p>Timeout for sending alerts to the Provider.</p>
</td>
</tr>
<tr>
@ -828,7 +833,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>HTTP/S address of the proxy</p>
<p>Proxy the HTTP/S address of the proxy server.</p>
</td>
</tr>
<tr>
@ -842,8 +847,8 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
</td>
<td>
<em>(Optional)</em>
<p>Secret reference containing the provider webhook URL
using &ldquo;address&rdquo; as data key</p>
<p>SecretRef specifies the Secret containing the authentication
credentials for this Provider.</p>
</td>
</tr>
<tr>
@ -857,8 +862,8 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
</td>
<td>
<em>(Optional)</em>
<p>CertSecretRef can be given the name of a secret containing
a PEM-encoded CA certificate (<code>caFile</code>)</p>
<p>CertSecretRef specifies the Secret containing
a PEM-encoded CA certificate (<code>caFile</code>).</p>
</td>
</tr>
<tr>
@ -870,8 +875,8 @@ bool
</td>
<td>
<em>(Optional)</em>
<p>This flag tells the controller to suspend subsequent events handling.
Defaults to false.</p>
<p>Suspend tells the controller to suspend subsequent
events handling for this Provider.</p>
</td>
</tr>
</tbody>
@ -884,7 +889,7 @@ Defaults to false.</p>
(<em>Appears on:</em>
<a href="#notification.toolkit.fluxcd.io/v1beta2.Provider">Provider</a>)
</p>
<p>ProviderStatus defines the observed state of Provider</p>
<p>ProviderStatus defines the observed state of the Provider.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
@ -921,6 +926,7 @@ github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
</td>
<td>
<em>(Optional)</em>
<p>Conditions holds the conditions for the Provider.</p>
</td>
</tr>
<tr>
@ -945,7 +951,7 @@ int64
(<em>Appears on:</em>
<a href="#notification.toolkit.fluxcd.io/v1beta2.Receiver">Receiver</a>)
</p>
<p>ReceiverSpec defines the desired state of Receiver</p>
<p>ReceiverSpec defines the desired state of the Receiver.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
@ -977,7 +983,7 @@ the validation procedure and payload deserialization.</p>
</td>
<td>
<em>(Optional)</em>
<p>A list of events to handle,
<p>Events specifies the list of event types to handle,
e.g. &lsquo;push&rsquo; for GitHub or &lsquo;Push Hook&rsquo; for GitLab.</p>
</td>
</tr>
@ -1004,8 +1010,8 @@ github.com/fluxcd/pkg/apis/meta.LocalObjectReference
</em>
</td>
<td>
<p>Secret reference containing the token used
to validate the payload authenticity</p>
<p>SecretRef specifies the Secret containing the token used
to validate the payload authenticity.</p>
</td>
</tr>
<tr>
@ -1017,8 +1023,8 @@ bool
</td>
<td>
<em>(Optional)</em>
<p>This flag tells the controller to suspend subsequent events handling.
Defaults to false.</p>
<p>Suspend tells the controller to suspend subsequent
events handling for this receiver.</p>
</td>
</tr>
</tbody>
@ -1031,7 +1037,7 @@ Defaults to false.</p>
(<em>Appears on:</em>
<a href="#notification.toolkit.fluxcd.io/v1beta2.Receiver">Receiver</a>)
</p>
<p>ReceiverStatus defines the observed state of Receiver</p>
<p>ReceiverStatus defines the observed state of the Receiver.</p>
<div class="md-typeset__scrollwrap">
<div class="md-typeset__table">
<table>
@ -1068,6 +1074,7 @@ github.com/fluxcd/pkg/apis/meta.ReconcileRequestStatus
</td>
<td>
<em>(Optional)</em>
<p>Conditions holds the conditions for the Receiver.</p>
</td>
</tr>
<tr>
@ -1079,7 +1086,7 @@ string
</td>
<td>
<em>(Optional)</em>
<p>Generated webhook URL in the format
<p>URL is the generated incoming webhook address in the format
of &lsquo;/hook/sha256sum(token+name+namespace)&rsquo;.</p>
</td>
</tr>
@ -1092,7 +1099,7 @@ int64
</td>
<td>
<em>(Optional)</em>
<p>ObservedGeneration is the last observed generation.</p>
<p>ObservedGeneration is the last observed generation of the Receiver object.</p>
</td>
</tr>
</tbody>