Add docs for alertmanager email + generic webhook config (#121)

Signed-off-by: sami <sami@appscode.com>

Author: samiulsami

docs/platform/selfhost-setup/images/monitoring-alertmanager.png

@@ -277,19 +277,42 @@ If using private or authenticated registries, provide:
 * **Certs:** Upload CA Cert, Client Cert, and Client Key if required for mutual TLS.
 * **Image Pull Secrets:** Define the secrets used by the cluster to authenticate with the registries. You can enable create namespace during helm install, allow nondistributable artifacts and insecure option for insecure registry
 
+### 5. Monitoring
+
+Use the **Monitoring** section to configure Alertmanager notifications for platform alerts for the site admin.
+
+* **Alert Manager Email:** Enable email notifications for Alertmanager alerts.
+  * **Enable Email:** Turns email notifications on or off.
+  * **To:** The recipient email address. For Gmail, you can also use plus addressing such as `user+alerts@example.com`.
+  * **From:** The sender email address shown in the message. For Gmail, use the same address as **Auth Username** unless you have configured a verified alias.
+  * **Smarthost:** The SMTP server address. For Gmail, use `smtp.gmail.com:587`.
+  * **Auth Username:** The SMTP login username. For Gmail, this should be the real Gmail or Google Workspace mailbox used to authenticate.
+  * **Password:** The SMTP password. For Gmail, use an App Password generated from `https://myaccount.google.com/apppasswords`.
+  * **Require TLS:** Enables TLS for the SMTP connection. Leave this enabled for Gmail.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
+* **Alert Manager Webhook:** Send alerts to an endpoint that accepts Alertmanager's generic webhook payload.
+  * **Enable Webhook:** Turns webhook delivery on or off.
+  * **URL:** The destination webhook URL. Some systems embed the secret directly in the URL.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
 
-### 5. Settings
+<br/>
+<img width="50%" src="../images/monitoring-alertmanager.png">
+
+> **Tip:** For Google Chat, a supported workaround is to generate a space email address in Google Chat settings and use that address in the **To** field.
+
+
+### 6. Settings
 
 #### Domain White List
 
 * You must specify the end users domains, the system will only allow users with those specified domains. You can Add multiple domain whitelists at the same time.
 * Put Login and Logout URL
 
-### 6. Self Management
+### 7. Self Management
 In this section you can enable or disable features. You can also create an initial `CAPI Cluster` from this section. 
 
 
-### 7. Branding & UI Customization
+### 8. Branding & UI Customization
 Administrators can globally re-brand the Ace interface to match corporate identity.
 
 * **App Name:** Changes the browser tab title.
@@ -299,13 +322,13 @@ Administrators can globally re-brand the Ace interface to match corporate identi
     * **Favicon:** Upload a 20KB icon file.
 * **App Tag:** Toggle **"Show App Tag"** to display or hide the version/tagging info in the UI.
 
-### 8. Generate Installer and Documentation
+### 9. Generate Installer and Documentation
 
 Click the "Next" button to submit your information. AppsCode will generate the installer and provide the necessary documentation and further installation guideline in details.
 
 You will find an `Installer URL` for this installer. You have to give this URL in the AWS Marketplace application.  
 
-### 9. Deploy KubeDB Platform
+### 10. Deploy KubeDB Platform
 
 The expiry time for this installer is 2 hours. You will find in detail deployment guideline after creating the installer.
 
@@ -518,4 +541,4 @@ and subscribe to **AppsCode Cloud w/Usage Billing** product.
 
 ### 10. Explore the Deployed Platform
 
-Once deployed, access the **KubeDB Platform** using the specified domain. Log in with the admin account credentials provided during the creation process.
+Once deployed, access the **KubeDB Platform** using the specified domain. Log in with the admin account credentials provided during the creation process.

docs/platform/selfhost-setup/install/aws-marketplace.md

@@ -95,7 +95,30 @@ If using private or authenticated registries, provide:
 * **Certs:** Upload CA Cert, Client Cert, and Client Key if required for mutual TLS.
 * **Image Pull Secrets:** Define the secrets used by the cluster to authenticate with the registries. You can enable create namespace during helm install, allow nondistributable artifacts and insecure option for insecure registry
 
-### 6. Settings
+### 6. Monitoring
+
+Use the **Monitoring** section to configure Alertmanager notifications for platform alerts for the site admin.
+
+* **Alert Manager Email:** Enable email notifications for Alertmanager alerts.
+  * **Enable Email:** Turns email notifications on or off.
+  * **To:** The recipient email address. For Gmail, you can also use plus addressing such as `user+alerts@example.com`.
+  * **From:** The sender email address shown in the message. For Gmail, use the same address as **Auth Username** unless you have configured a verified alias.
+  * **Smarthost:** The SMTP server address. For Gmail, use `smtp.gmail.com:587`.
+  * **Auth Username:** The SMTP login username. For Gmail, this should be the real Gmail or Google Workspace mailbox used to authenticate.
+  * **Password:** The SMTP password. For Gmail, use an App Password generated from `https://myaccount.google.com/apppasswords`.
+  * **Require TLS:** Enables TLS for the SMTP connection. Leave this enabled for Gmail.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
+* **Alert Manager Webhook:** Send alerts to an endpoint that accepts Alertmanager's generic webhook payload.
+  * **Enable Webhook:** Turns webhook delivery on or off.
+  * **URL:** The destination webhook URL. Some systems embed the secret directly in the URL.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
+
+<br/>
+<img width="50%" src="../images/monitoring-alertmanager.png">
+
+> **Tip:** For Google Chat, a supported workaround is to generate a space email address in Google Chat settings and use that address in the **To** field.
+
+### 7. Settings
 
 #### Domain White List
 * Add domain one by one for whitelisting
@@ -104,11 +127,11 @@ If using private or authenticated registries, provide:
 <br/>
 <img width="50%" src="../images/domain-whitelisting.png">
 
-### 7. Self Management
+### 8. Self Management
 
 In this section you can enable or disable features.  You can also create an initial `CAPI Cluster` from this section. 
 
-### 8. Branding & UI Customization
+### 9. Branding & UI Customization
 
 Administrators can globally re-brand the Ace interface to match corporate identity.
 
@@ -122,11 +145,11 @@ Administrators can globally re-brand the Ace interface to match corporate identi
 <br/>
 <img width="50%" src="../images/branding.png">
 
-### 9. Generate Installer and Documentation
+### 10. Generate Installer and Documentation
 
 Click the "Deploy" button to submit your information. AppsCode will generate the installer and provide the necessary documentation.
 
-### 10. Deploy KubeDB Platform
+### 11. Deploy KubeDB Platform
 
 #### Step 1: Create Azure application
 Go to Azure Marketplace and select AppsCode Cloud w/ Usage Billing application. [AppsCode Cloud w/ Usage Billing from Marketplace](https://portal.azure.com/#create/appscode.ace_paygace-payg)
@@ -165,6 +188,6 @@ You can monitor the deployment progress through the **Managed Resource Group's**
   <img src="../images/managed-resources.png" style="width: 48%;">
 </div>
 
-### 11. Explore the Deployed Platform
+### 12. Explore the Deployed Platform
 
-Once deployed, access the **KubeDB Platform** using the specified domain. Log in with the admin account credentials provided during the creation process.
+Once deployed, access the **KubeDB Platform** using the specified domain. Log in with the admin account credentials provided during the creation process.

docs/platform/selfhost-setup/install/azure-marketplace.md

@@ -86,8 +86,31 @@ If using private or authenticated registries, provide:
 * **Certs:** Upload CA Cert, Client Cert, and Client Key if required for mutual TLS.
 * **Image Pull Secrets:** Define the secrets used by the cluster to authenticate with the registries. You can enable create namespace during helm install, allow nondistributable artifacts and insecure option for insecure registry
 
+### 5. Monitoring
+
+Use the **Monitoring** section to configure Alertmanager notifications for platform alerts for the site admin.
+
+* **Alert Manager Email:** Enable email notifications for Alertmanager alerts.
+  * **Enable Email:** Turns email notifications on or off.
+  * **To:** The recipient email address. For Gmail, you can also use plus addressing such as `user+alerts@example.com`.
+  * **From:** The sender email address shown in the message. For Gmail, use the same address as **Auth Username** unless you have configured a verified alias.
+  * **Smarthost:** The SMTP server address. For Gmail, use `smtp.gmail.com:587`.
+  * **Auth Username:** The SMTP login username. For Gmail, this should be the real Gmail or Google Workspace mailbox used to authenticate.
+  * **Password:** The SMTP password. For Gmail, use an App Password generated from `https://myaccount.google.com/apppasswords`.
+  * **Require TLS:** Enables TLS for the SMTP connection. Leave this enabled for Gmail.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
+* **Alert Manager Webhook:** Send alerts to an endpoint that accepts Alertmanager's generic webhook payload.
+  * **Enable Webhook:** Turns webhook delivery on or off.
+  * **URL:** The destination webhook URL. Some systems embed the secret directly in the URL.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
+
+<br/>
+<img width="50%" src="../images/monitoring-alertmanager.png">
+
+> **Tip:** For Google Chat, a supported workaround is to generate a space email address in Google Chat settings and use that address in the **To** field.
 
-### 5. Settings
+
+### 6. Settings
 
 #### Domain White List and Proxy Servers
 
@@ -98,7 +121,7 @@ If using private or authenticated registries, provide:
 <br/>
 <img width="50%" src="../images/domain-whitelisting.png">
 
-### 6. Ingress & Gateway
+### 7. Ingress & Gateway
 
 Configure how the application is exposed to the internet or your internal network.
 
@@ -107,14 +130,13 @@ Configure how the application is exposed to the internet or your internal networ
 <br/>
 <img width="50%" src="../images/ingress-gateway.png">
 
-
-### 7. Self Management
+### 8. Self Management
 In this section you can enable or disable features
 
 <br/>
 <img width="50%" src="../images/features.png">
 
-### 8. Branding & UI Customization
+### 9. Branding & UI Customization
 Administrators can globally re-brand the Ace interface to match corporate identity.
 
 * **App Name:** Changes the browser tab title.
@@ -127,15 +149,15 @@ Administrators can globally re-brand the Ace interface to match corporate identi
 <br/>
 <img width="50%" src="../images/branding.png">
 
-### 9. Generate Installer and Documentation
+### 10. Generate Installer and Documentation
 
 Click the "Deploy" button to submit your information. AppsCode will generate the installer and provide the necessary documentation.
 
-### 10. Deploy KubeDB Platform
+### 11. Deploy KubeDB Platform
 
 Follow the documentation provided by AppsCode to deploy the KubeDB Platform on your system.
 
-### 11. Explore the Deployed Platform
+### 12. Explore the Deployed Platform
 
 Once deployed, access the KubeDB Platform using the specified domain. Log in with the admin account credentials provided during the creation process.
 

docs/platform/selfhost-setup/install/cloud-demo.md

@@ -63,8 +63,31 @@ If using private or authenticated registries, provide:
 * **Certs:** Upload CA Cert, Client Cert, and Client Key if required for mutual TLS.
 * **Image Pull Secrets:** Define the secrets used by the cluster to authenticate with the registries. You can enable create namespace during helm install, allow nondistributable artifacts and insecure option for insecure registry
 
+### 5. Monitoring
+
+Use the **Monitoring** section to configure Alertmanager notifications for platform alerts for the site admin.
+
+* **Alert Manager Email:** Enable email notifications for Alertmanager alerts.
+  * **Enable Email:** Turns email notifications on or off.
+  * **To:** The recipient email address. For Gmail, you can also use plus addressing such as `user+alerts@example.com`.
+  * **From:** The sender email address shown in the message. For Gmail, use the same address as **Auth Username** unless you have configured a verified alias.
+  * **Smarthost:** The SMTP server address. For Gmail, use `smtp.gmail.com:587`.
+  * **Auth Username:** The SMTP login username. For Gmail, this should be the real Gmail or Google Workspace mailbox used to authenticate.
+  * **Password:** The SMTP password. For Gmail, use an App Password generated from `https://myaccount.google.com/apppasswords`.
+  * **Require TLS:** Enables TLS for the SMTP connection. Leave this enabled for Gmail.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
+* **Alert Manager Webhook:** Send alerts to an endpoint that accepts Alertmanager's generic webhook payload.
+  * **Enable Webhook:** Turns webhook delivery on or off.
+  * **URL:** The destination webhook URL. Some systems embed the secret directly in the URL.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
 
-### 5. Settings
+<br/>
+<img width="50%" src="../images/monitoring-alertmanager.png">
+
+> **Tip:** For Google Chat, a supported workaround is to generate a space email address in Google Chat settings and use that address in the **To** field.
+
+
+### 6. Settings
 
 #### Domain White List and Proxy Servers
 
@@ -75,13 +98,13 @@ If using private or authenticated registries, provide:
 <br/>
 <img width="50%" src="../images/domain-whitelisting.png">
 
-### 6. Self Management
+### 7. Self Management
 In this section you can enable or disable features
 
 <br/>
 <img width="50%" src="../images/features.png">
 
-### 7. Branding & UI Customization
+### 8. Branding & UI Customization
 Administrators can globally re-brand the Ace interface to match corporate identity.
 
 * **App Name:** Changes the browser tab title.
@@ -94,15 +117,15 @@ Administrators can globally re-brand the Ace interface to match corporate identi
 <br/>
 <img width="50%" src="../images/branding.png">
 
-### 8. Generate Installer and Documentation
+### 9. Generate Installer and Documentation
 
 Click the "Deploy" button to submit your information. AppsCode will generate the installer and provide the necessary documentation.
 
-### 9. Deploy KubeDB Platform
+### 10. Deploy KubeDB Platform
 
 Follow the documentation provided by AppsCode to deploy the KubeDB Platform on your system.
 
-### 10. Explore the Deployed Platform
+### 11. Explore the Deployed Platform
 
 Once deployed, access the KubeDB Platform using the specified domain. Log in with the admin account credentials provided during the creation process.
 
@@ -113,4 +136,4 @@ Once deployed, access the KubeDB Platform using the specified domain. Log in wit
 
 If you encounter any challenges during the deployment or have questions, reach out to AppsCode support for assistance.
 
-Congratulations! You have successfully deployed the KubeDB Platform in K8s App Demo mode. Explore the features and capabilities of the platform in your customized environment.
+Congratulations! You have successfully deployed the KubeDB Platform in K8s App Demo mode. Explore the features and capabilities of the platform in your customized environment.

docs/platform/selfhost-setup/install/k8s-app-demo.md

@@ -62,8 +62,31 @@ If using private or authenticated registries, provide:
 * **Certs:** Upload CA Cert, Client Cert, and Client Key if required for mutual TLS.
 * **Image Pull Secrets:** Define the secrets used by the cluster to authenticate with the registries. You can enable create namespace during helm install, allow nondistributable artifacts and insecure option for insecure registry
 
+### 5. Monitoring
+
+Use the **Monitoring** section to configure Alertmanager notifications for platform alerts for the site admin.
+
+* **Alert Manager Email:** Enable email notifications for Alertmanager alerts.
+  * **Enable Email:** Turns email notifications on or off.
+  * **To:** The recipient email address. For Gmail, you can also use plus addressing such as `user+alerts@example.com`.
+  * **From:** The sender email address shown in the message. For Gmail, use the same address as **Auth Username** unless you have configured a verified alias.
+  * **Smarthost:** The SMTP server address. For Gmail, use `smtp.gmail.com:587`.
+  * **Auth Username:** The SMTP login username. For Gmail, this should be the real Gmail or Google Workspace mailbox used to authenticate.
+  * **Password:** The SMTP password. For Gmail, use an App Password generated from `https://myaccount.google.com/apppasswords`.
+  * **Require TLS:** Enables TLS for the SMTP connection. Leave this enabled for Gmail.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
+* **Alert Manager Webhook:** Send alerts to an endpoint that accepts Alertmanager's generic webhook payload.
+  * **Enable Webhook:** Turns webhook delivery on or off.
+  * **URL:** The destination webhook URL. Some systems embed the secret directly in the URL.
+  * **Send Resolved:** Sends a follow-up notification when an alert returns to a healthy state.
 
-### 5. Settings
+<br/>
+<img width="50%" src="../images/monitoring-alertmanager.png">
+
+> **Tip:** For Google Chat, a supported workaround is to generate a space email address in Google Chat settings and use that address in the **To** field.
+
+
+### 6. Settings
 
 #### Domain White List and Proxy Servers
 
@@ -74,7 +97,7 @@ If using private or authenticated registries, provide:
 <br/>
 <img width="50%" src="../images/domain-whitelisting.png">
 
-### 6. TLS
+### 7. TLS
 Configure TLS certificates for secure communication. You can choose the Issuer type from the following list.
   * **External**: Use this if you already have certificates from an external provider.
       * CA CERT: Paste the Certificate Authority certificate.
@@ -85,7 +108,7 @@ Configure TLS certificates for secure communication. You can choose the Issuer t
       * CA CERT: Paste the internal CA certificate.
       * CA Key: Paste the internal CA key.
 
-### 7. Ingress & Gateway
+### 8. Ingress & Gateway
 
 Configure how the application is exposed to the internet or your internal network.
 
@@ -94,7 +117,7 @@ Configure how the application is exposed to the internet or your internal networ
 <br/>
 <img width="50%" src="../images/ingress-gateway.png">
 
-### 8. NATS
+### 9. NATS
 
 Configure NATS, which is used as the internal messaging system for the platform.
 
@@ -111,13 +134,13 @@ Configure NATS, which is used as the internal messaging system for the platform.
 <br/>
 <img width="50%" src="../images/nats.png">
 
-### 9. Self Management
+### 10. Self Management
 In this section you can enable or disable features
 
 <br/>
 <img width="50%" src="../images/features.png">
 
-### 10. Branding & UI Customization
+### 11. Branding & UI Customization
 Administrators can globally re-brand the Ace interface to match corporate identity.
 
 * **App Name:** Changes the browser tab title.
@@ -130,15 +153,15 @@ Administrators can globally re-brand the Ace interface to match corporate identi
 <br/>
 <img width="50%" src="../images/branding.png">
 
-### 11. Generate Installer and Documentation
+### 12. Generate Installer and Documentation
 
 Click the "Deploy" button to submit your information. AppsCode will generate the installer and provide the necessary documentation.
 
-### 12. Deploy KubeDB Platform
+### 13. Deploy KubeDB Platform
 
 Follow the documentation provided by AppsCode to deploy the KubeDB Platform on your system.
 
-### 13. Explore the Deployed Platform
+### 14. Explore the Deployed Platform
 
 Once deployed, access the KubeDB Platform using the specified domain. Log in with the admin account credentials provided during the creation process.