Installing and Configuring Pivotal Event Alerts

Page last updated:

This topic describes how to install and configure Pivotal Event Alerts. For information about how to use this product, see Using Pivotal Event Alerts.

Prerequisites

You must have the following to install Event Alerts:

  • Pivotal Application Service v2.3.x or later
  • MySQL for Pivotal Platform or credentials for an existing external MySQL database v5.7 or later.
    • If you are using MySQL for Pivotal Platform, you must configure a single node service plan.
    • If binary logging is enabled, the user must have SUPER privileges or the global variable log_bin_trust_function_creators must be set to 1.
  • If you want notifications sent to Slack channels, a Slack account
  • If you want notifications sent to email addresses, Email Configuration must be enabled and configured on the Event Alerts tile

Download and Install the Event Alerts Tile

Follow the procedures below to download and install the Event Alerts tile:

  1. Download the product file from Pivotal Network.

  2. Navigate to the Pivotal Ops Manager Installation Dashboard and click Import a Product to upload the product file.

  3. Under the Import a Product button, click + next to the version number of Event Alerts. This adds the tile to your staging area.

  4. Click the newly added Event Alerts tile to open its configuration panes.

    Configuration Panes

Configure the Tile

Follow the stops below to configure the Event Alerts tile.

Configure AZs and Networks

Follow the steps below to choose an Availability Zone (AZ) to run Event Alerts and to select networks.

  1. Click the Assign AZs and Networks tab. AZ and Network Assignments Section

  2. Configure the fields as follows:

    Field Description
    Place singleton jobs in Select the AZ for executing the Event Alerts errands. Event Alerts components execute as apps and do not require VMs.
    Balance other jobs in Select any field. This selection has no effect but is required.
    Network Select a subnet for the Event Alerts errands. Use the subnet that includes the Pivotal Application Service component VMs.

    Note: The network selected is used only by errand VMs.

  3. Click Save.

(Optional) Configure Scaling Settings

You can scale Event Alerts by adding additional instances of the app. Follow the steps below to configure scaling settings.

  1. Click the Scale tab.

  2. In the Event Alerts Instance Count, set the number of event-alerts app instances. Environments with a very large number of alerts might need a large number of instances. Environments that do not require high availability can scale down to one instance.

  3. Click Save.

Configure MySQL Settings

Event Alerts can either use the MySQL for Pivotal Platform service or an external MySQL database. To use the MySQL for Pivotal Platform service, you must have MySQL for Pivotal Platform installed.

Follow the steps below to configure MySQL settings.

Use the MySQL for Pivotal Platform Service

If you have MySQL for Pivotal Platform installed and want to use the service:

  1. Click MySQL Settings.

  2. Select Pivotal MySQL Service.

  3. Enter the MySQL for Pivotal Platform service plan you want to use. The service plan you enter must be a single node plan. For example, db-small. MySQL Settings Service Option

  4. Click Save.

Use an External MySQL Database

Warning: If your external MySQL database has binary logging enabled, the user must have SUPER privileges or the global variable log_bin_trust_function_creators must be set to 1.

To use an external database for Event Alerts, follow the steps below.

  1. Click the MySQL Settings tab.

  2. Select External.

  3. Configure the fields as follows:

    Field Description
    MySQL Host Enter the external MySQL database hostname or IP address.
    MySQL Port Enter the external MySQL database port.
    MySQL Username Enter the external MySQL database username.
    The user must have the following privileges for the Event Alerts database: ALTER, CREATE, DELETE, DROP, INDEX, INSERT, LOCK TABLES, REFERENCES, SELECT, and UPDATE.

    Warning: Do not delete the user that connects to the database. You can change the username, but the original user cannot be deleted. If the user is deleted, MySQL errors out.

    MySQL Password Enter the external MySQL database password.
    MySQL Database Enter the external MySQL database name for Event Alerts to use. This database must already exist. Event Alerts does not create a new database.
    Enable MySQL TLS Select this option if the external MySQL database requires TLS or mutual TLS.
    MySQL Server CA Cert Enter the CA certificate for the external MySQL database.
    This field is required if the certificate used by the external MySQL database is self-signed. If you do not require TLS hostname validation, select Skip MySQL TLS Validation below.
    Skip MySQL TLS Validation Select this option if you do not require TLS hostname validation.

    Note: If you are using Google Cloud Platform SQL with mutual TLS, you must select this option. The certificate on the MySQL server does not contain any IP Subject Alternative Names (SANs) to validate the server IP address provided.

    MySQL Client Certificate Enter the external MySQL database client certificate.
    This field is required if the server requires mutual TLS.
    Private Keys Enter the external MySQL database private key.
    This field is required if the server requires mutual TLS.
  4. Click Save.

Configure Email Notifications

Follow the steps below to configure settings for Event Alerts email notifications.

  1. Click the Email Configuration tab.

  2. Under SMTP, select Enabled. Enable Email

  3. Configure the fields as follows:

    Field Description
    From Email The email address you want to use as the sender of email notifications.
    SMTP Server Address The SMTP server address for the outgoing email account.
    SMTP Server Port The SMTP server port for the outgoing email account.
    SMTP Server Credentials The Username and Password for the outgoing email account.

    Note: To connect to a SMTP server without authentication, leave the SMTP username and password fields empty.

  4. Click Save.

Verify Stemcell Version

To verify that you have the correct stemcell version for the Pivotal Event Alerts tile:

  1. Click the Stemcell tab.

  2. Verify the settings. If Event Alerts cannot detect a stemcell TGZ file, a message similar to the following appears: Stemcell Section If you need to upload a stemcell:

    1. Navigate to Pivotal Network and click Stemcells.
    2. Download the appropriate stemcell version targeted for your IaaS.
    3. Return to the Stemcell tab and click Import Stemcell to import the downloaded stemcell TGZ file.
  3. Click Save.

  4. Return to the Ops Manager Installation Dashboard.

  5. If you are using Ops Manager v2.3 or later, click Review Pending Changes. For more information about this Ops Manager page, see Reviewing Pending Product Changes.

  6. Click Apply Changes to install the Event Alerts tile.

Install the Event Alerts Plugin

You must install the Event Alerts plugin to configure notifications. You can use this cf CLI plugin to subscribe to topics published by Pivotal Healthwatch. For general information about Pivotal Healthwatch, see Pivotal Healthwatch.

Install the Plugin

The plugin is currently only available to admins.

To install the plugin:

  1. Download one of the following files from Pivotal Network, depending on your operating system (OS).

    • pcf-event-alerts-cli-plugin-OS-binary
    • pcf-event-alerts-cli-plugin-OS-exe
  2. Run the command cf install-plugin PATH-TO-BINARY-FILE.

Uninstall the Plugin

To uninstall the plugin, run the command cf uninstall-plugin event-alerts.