docs: update alert provider types

fluxcd · Feb 2, 2022 · 9a1a560 · 9a1a560
1 parent 402e029
commit 9a1a560
Showing 1 changed file with 34 additions and 28 deletions.
diff --git a/docs/spec/v1beta1/provider.md b/docs/spec/v1beta1/provider.md
@@ -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"`
 
@@ -44,27 +44,33 @@ 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:
 
@@ -356,15 +362,15 @@ If a summary is provided in the alert resource an additional "summary" annotatio
 The provider will send the following labels for the event.
 
 
-| Label       | Description                                                                                        |
-| ----------- | -------------------------------------------------------------------------------------------------- |
-| alertname   | The string Flux followed by the Kind and the reason for the event e.g FluxKustomizationProgressing |
-| severity    | The severity of the event (error|info)                                                             |
-| timestamp   | The timestamp of the event                                                                         |
-| reason      | The machine readable reason for the objects transition into the current status                     |
-| kind        | The kind of the involved object associated with the event                                          |
-| name        | The name of the involved object associated with the event                                          |
-| namespace   | The namespace of the involved object associated with the event                                     |
+| Label     | Description                                                  |
+| --------- | ------------------------------------------------------------ |
+| alertname | The string Flux followed by the Kind and the reason for the event e.g FluxKustomizationProgressing |
+| severity  | The severity of the event (error                             |
+| timestamp | The timestamp of the event                                   |
+| reason    | The machine readable reason for the objects transition into the current status |
+| kind      | The kind of the involved object associated with the event    |
+| name      | The name of the involved object associated with the event    |
+| namespace | The namespace of the involved object associated with the event |
 
 
 ### Slack App