Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update alert provider types #321

Merged
merged 1 commit into from
Feb 4, 2022
Merged

docs: update alert provider types #321

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 24 additions & 20 deletions docs/spec/v1beta1/provider.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ type ProviderSpec struct {
// +optional
Proxy string `json:"proxy,omitempty"`

// Secret reference containing the provider webhook URL
// Secret reference containing the provider details, valid key names are: address, token, headers (YAML encoded)
// +optional
SecretRef *meta.LocalObjectReference `json:"secretRef,omitempty"`

Expand All @@ -42,30 +42,34 @@ type ProviderSpec struct {
}
```


Notification providers:

* Slack
* Discord
* Microsoft Teams
* Rocket
* Google Chat
* Webex
* Sentry
* Telegram
* Lark
* Matrix
* Azure Event Hub
* Generic webhook
* Opsgenie
* Alertmanager
| Provider | Type |
| --------------- | ------------- |
| Alertmanager | alertmanager |
| Azure Event Hub | azureeventhub |
| Discord | discord |
| Generic webhook | generic |
| Google Chat | googlechat |
| Lark | lark |
| Matrix | matrix |
| Microsoft Teams | msteams |
| Opsgenie | opsgenie |
| Rocket | rocket |
| Sentry | sentry |
| Slack | slack |
| Telegram | telegram |
| WebEx | webex |

Git commit status providers:

* GitHub
* GitLab
* Bitbucket
* Azure DevOps

| Provider | Type |
| ------------ | ----------- |
| Azure DevOps | azuredevops |
| Bitbucket | bitbucket |
| GitHub | github |
| GitLab | gitlab |
Status:

```go
Expand Down