-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Rafael da Fonseca <rafael.fonseca@wildlifestudios.com>
- Loading branch information
1 parent
bd242e0
commit a2d662f
Showing
26 changed files
with
1,670 additions
and
109 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
/* | ||
Copyright 2023 The Flux authors | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package v1beta4 | ||
|
||
import ( | ||
"github.com/fluxcd/pkg/apis/meta" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
|
||
v1 "github.com/fluxcd/notification-controller/api/v1" | ||
) | ||
|
||
const ( | ||
AlertKind string = "Alert" | ||
) | ||
|
||
// AlertSpec defines an alerting rule for events involving a list of objects. | ||
type AlertSpec struct { | ||
// ProviderRef specifies which Provider this Alert should use. | ||
// +required | ||
ProviderRef meta.NamespacedObjectReference `json:"providerRef"` | ||
|
||
// 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"` | ||
|
||
// EventSources specifies how to filter events based | ||
// on the involved object kind, name and namespace. | ||
// +required | ||
EventSources []v1.CrossNamespaceObjectReference `json:"eventSources"` | ||
|
||
// InclusionList specifies a list of Golang regular expressions | ||
// to be used for including messages. | ||
// +optional | ||
InclusionList []string `json:"inclusionList,omitempty"` | ||
|
||
// 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. | ||
// +optional | ||
EventMetadata map[string]string `json:"eventMetadata,omitempty"` | ||
|
||
// ExclusionList specifies a list of Golang regular expressions | ||
// to be used for excluding messages. | ||
// +optional | ||
ExclusionList []string `json:"exclusionList,omitempty"` | ||
|
||
// Summary holds a short description of the impact and affected cluster. | ||
// +kubebuilder:validation:MaxLength:=255 | ||
// +optional | ||
Summary string `json:"summary,omitempty"` | ||
|
||
// Suspend tells the controller to suspend subsequent | ||
// events handling for this Alert. | ||
// +optional | ||
Suspend bool `json:"suspend,omitempty"` | ||
|
||
// Channel specifies the destination channel where events should be posted. | ||
// This will override any default channel that might be set in the provider | ||
// +kubebuilder:validation:MaxLength:=2048 | ||
// +optional | ||
Channel string `json:"channel,omitempty"` | ||
} | ||
|
||
// +genclient | ||
// +genclient:Namespaced | ||
// +kubebuilder:storageversion | ||
// +kubebuilder:object:root=true | ||
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="" | ||
|
||
// Alert is the Schema for the alerts API | ||
type Alert struct { | ||
metav1.TypeMeta `json:",inline"` | ||
metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
||
Spec AlertSpec `json:"spec,omitempty"` | ||
} | ||
|
||
//+kubebuilder:object:root=true | ||
|
||
// AlertList contains a list of Alert | ||
type AlertList struct { | ||
metav1.TypeMeta `json:",inline"` | ||
metav1.ListMeta `json:"metadata,omitempty"` | ||
Items []Alert `json:"items"` | ||
} | ||
|
||
func init() { | ||
SchemeBuilder.Register(&Alert{}, &AlertList{}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
/* | ||
Copyright 2023 The Flux authors | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
// Package v1beta4 contains API Schema definitions for the notification v1beta4 API group. | ||
// +kubebuilder:object:generate=true | ||
// +groupName=notification.toolkit.fluxcd.io | ||
package v1beta4 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
/* | ||
Copyright 2023 The Flux authors | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package v1beta4 | ||
|
||
import ( | ||
"k8s.io/apimachinery/pkg/runtime/schema" | ||
"sigs.k8s.io/controller-runtime/pkg/scheme" | ||
) | ||
|
||
var ( | ||
// GroupVersion is group version used to register these objects | ||
GroupVersion = schema.GroupVersion{Group: "notification.toolkit.fluxcd.io", Version: "v1beta4"} | ||
|
||
// 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. | ||
AddToScheme = SchemeBuilder.AddToScheme | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,163 @@ | ||
/* | ||
Copyright 2023 The Flux authors | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package v1beta4 | ||
|
||
import ( | ||
"time" | ||
|
||
"github.com/fluxcd/pkg/apis/meta" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
) | ||
|
||
const ( | ||
ProviderKind string = "Provider" | ||
GenericProvider string = "generic" | ||
GenericHMACProvider string = "generic-hmac" | ||
SlackProvider string = "slack" | ||
GrafanaProvider string = "grafana" | ||
DiscordProvider string = "discord" | ||
MSTeamsProvider string = "msteams" | ||
RocketProvider string = "rocket" | ||
GitHubDispatchProvider string = "githubdispatch" | ||
GitHubProvider string = "github" | ||
GitLabProvider string = "gitlab" | ||
GiteaProvider string = "gitea" | ||
BitbucketServerProvider string = "bitbucketserver" | ||
BitbucketProvider string = "bitbucket" | ||
AzureDevOpsProvider string = "azuredevops" | ||
GoogleChatProvider string = "googlechat" | ||
GooglePubSubProvider string = "googlepubsub" | ||
WebexProvider string = "webex" | ||
SentryProvider string = "sentry" | ||
AzureEventHubProvider string = "azureeventhub" | ||
TelegramProvider string = "telegram" | ||
LarkProvider string = "lark" | ||
Matrix string = "matrix" | ||
OpsgenieProvider string = "opsgenie" | ||
AlertManagerProvider string = "alertmanager" | ||
PagerDutyProvider string = "pagerduty" | ||
DataDogProvider string = "datadog" | ||
NATSProvider string = "nats" | ||
) | ||
|
||
// 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;gitea;bitbucketserver;bitbucket;azuredevops;googlechat;googlepubsub;webex;sentry;azureeventhub;telegram;lark;matrix;opsgenie;alertmanager;grafana;githubdispatch;pagerduty;datadog;nats | ||
// +required | ||
Type string `json:"type"` | ||
|
||
// Interval at which to reconcile the Provider with its Secret references. | ||
// Deprecated and not used in v1beta4. | ||
// | ||
// +kubebuilder:validation:Type=string | ||
// +kubebuilder:validation:Pattern="^([0-9]+(\\.[0-9]+)?(ms|s|m|h))+$" | ||
// +optional | ||
// +deprecated | ||
Interval *metav1.Duration `json:"interval,omitempty"` | ||
|
||
// 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 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. | ||
// +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 (in the `ca.crt` key). | ||
// +optional | ||
// | ||
// Note: Support for the `caFile` key has | ||
// been deprecated. | ||
CertSecretRef *meta.LocalObjectReference `json:"certSecretRef,omitempty"` | ||
|
||
// Suspend tells the controller to suspend subsequent | ||
// events handling for this Provider. | ||
// +optional | ||
Suspend bool `json:"suspend,omitempty"` | ||
|
||
//CrossNamespace allows this provider to be made available to Alerts in other namespaces | ||
// +optional | ||
CrossNamespace bool `json:"crossNamespace,omitempty"` | ||
} | ||
|
||
// +genclient | ||
// +genclient:Namespaced | ||
// +kubebuilder:storageversion | ||
// +kubebuilder:object:root=true | ||
// +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp",description="" | ||
|
||
// Provider is the Schema for the providers API | ||
type Provider struct { | ||
metav1.TypeMeta `json:",inline"` | ||
metav1.ObjectMeta `json:"metadata,omitempty"` | ||
|
||
Spec ProviderSpec `json:"spec,omitempty"` | ||
} | ||
|
||
//+kubebuilder:object:root=true | ||
|
||
// ProviderList contains a list of Provider | ||
type ProviderList struct { | ||
metav1.TypeMeta `json:",inline"` | ||
metav1.ListMeta `json:"metadata,omitempty"` | ||
Items []Provider `json:"items"` | ||
} | ||
|
||
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 { | ||
duration = in.Spec.Timeout.Duration | ||
} | ||
|
||
return duration | ||
} |
Oops, something went wrong.