Installing and Configuring PCF Event Alerts

Page last updated:

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

Prerequisites

You must have the following in order to install PCF Event Alerts:

  • PAS v2.1.x or later
  • MySQL for PCF v2 or credentials for an existing external MySQL database v5.7 or later.
    • 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 PCF Event Alerts tile
  • Updated and properly configured any BOSH add-ons used in your PCF deployment to support Xenial stemcells. The following add-on versions support the Xenial stemcell:

Download and Install the PCF Event Alerts Tile

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

  1. Download the product file from Pivotal Network.

  2. Navigate to the 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 PCF Event Alerts. This adds the tile to your staging area.

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

    Configuration Panes

Configure the Tile

Follow the stops below to configure the PCF Event Alerts tile.

Configure AZs and Networks

Follow the steps below to choose an Availability Zone (AZ) to run PCF 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 PCF Event Alerts errands. PCF 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 PCF Event Alerts errands. Use the subnet that includes the Pivotal Application Service (PAS) component VMs.

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

  3. Click Save.

(Optional) Configure Scaling Settings

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

  1. Click the Scale tab.

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

  3. Click Save.

Configure MySQL Settings

PCF Event Alerts can either use the MySQL for PCF v2 service or an external MySQL database. To use the MySQL for PCF v2 service, you must have MySQL for PCF v2.0 or later installed.

Follow the steps below to configure MySQL settings.

Use the MySQL for PCF v2 Service

If you have MySQL for PCF v2.0 or later installed and want to use it for PCF Event Alerts, follow the steps below.

  1. Click the MySQL Settings tab.

  2. Select Pivotal MySQL Service and enter the service plan to use. For example, db-small. MySQL Settings Service Option

  3. 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.

If you want to use an external database for PCF 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 PCF 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 PCF Event Alerts to use. This database must already exist. PCF 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 Event Alerts tile, do the following:

  1. Click the Stemcell tab.

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

    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.

      Note: PCF Event Alerts v1.2.3 and later require a Xenial stemcell. To download a Xenial stemcell from Pivotal Network, see Stemcells for PCF (Ubuntu Xenial).

  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 PCF Event Alerts tile.

Install the PCF Event Alerts Plugin

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

Install the Plugin

The plugin is currently only available to admins.

To install the plugin, do the following:

  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.