LATEST VERSION: 1.2 - RELEASE NOTES
PCF Healthwatch v1.1

Installing and Configuring PCF Healthwatch

This topic describes how to install and configure Pivotal Cloud Foundry (PCF) Healthwatch. For a list of compatible Ops Manager and Pivotal Application Service (PAS) versions, see Product Snapshot.

Install PCF Healthwatch

  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 Healthwatch. This adds the tile to your staging area.

Configure PCF Healthwatch

To start using PCF Healthwatch, you need to configure the PCF Healthwatch tile.

Create a Network

This section describes when and how to create a network for PCF Healthwatch.

Note: If you have previously installed PCF Healthwatch, you can skip this section.

About Service Networks

PCF Healthwatch has different network requirements depending on which Ops Manager version you are using:

  • Ops Manager v2.0: You must use a Service Network for PCF Healthwatch. This ensures that Ops Manager does not attempt to use the same IP address as the BOSH health check VM. If you do not have an existing Service Network with at least one free IP address, follow the procedure below.

  • Ops Manager v2.1: You do not need to create a separate network as a service network. You can use any of your networks because BOSH handles the IP allocation. For more information, see IP Address Management (IPAM) Removed in the PCF Ops Manager v2.1 Release Notes.

Procedure

If you read About Service Networks and determined you need to create a new network for PCF Healthwatch, do the following:

  1. Click the Ops Manager Director tile on the Ops Manager Installation Dashboard.

  2. Navigate to Create Networks and click Add Network.

  3. In the Name field, enter a name for the service network.

  4. If you are using Ops Manager v2.0, select the Service Network checkbox.

  5. Enter the network details.

  6. Click Save.

Configure the PCF Healthwatch Tile

To configure the PCF Healthwatch tile, do the following:

  1. Click the PCF Healthwatch tile on the Ops Manager Installation Dashboard.

  2. Navigate to Assign AZs and Networks and do the following:

    1. Select an Availability Zone (AZ) for placing singleton jobs.
    2. Select one or more AZs for balancing other jobs.

      Note: To create a highly available environment, Pivotal recommends selecting multiple AZs.

    3. Select Network for installing PCF Healthwatch.
    4. Select Service Network for running the BOSH Health Check VM.
    5. Click Save.
  3. Navigate to Healthwatch Component Config and do the following:

    1. (Optional) Enter a foundation name for this PCF. The entered name is emitted as a tag on all Firehose metrics generated by PCF Healthwatch. If no name is set, then PCF Healthwatch defaults to using the system domain as the foundation name label when publishing its metrics. Do not use any of the special characters !, @, #, ^, &, $, % , *, parentheses or quotes in the chosen name. Use of -, _ or space is allowed.
    2. Set Ingestor Count to the number of Doppler Server instances configured in the PAS tile.
    3. Set MySQL Loader Count to 4 for a small or medium PCF deployment or a number equivalent to the number of Dopplers for a larger PCF deployment.

      Note: Pivotal recommends starting with the configuration above and then evaluating performance using the Ingestor and Loader metrics.

      In the default highly available installation, PCF Healthwatch requires up to 12 GB of free RAM on Diego for steady-state operations and up to 23 GB of RAM during deployments. You can lower this footprint by reducing the instance counts in this section.
      Insufficient available RAM on Diego typically results in an Insufficient Resources error message when running the push-apps errand.

    4. Click Save.
  4. Navigate to Health Check and do the following:

    1. Enter Ops Manager URL. The URL should include the protocol. This URL must be reachable from a cf pushed application.
    2. In BOSH Health Check Availability Zone, select an AZ for the BOSH Health Check VM.

      Note: On Azure environments this dropdown is null because Azure does not currently support the concept of AZs.

    3. In BOSH Health Check VM Type, select a VM type for the BOSH Health Check VM. The recommended VM type is small.
    4. (Optional) Enter your UAA Client User and UAA Client Secret for BOSH Task Check. If you have two-factor authentication enabled on the BOSH Director, create a BOSH UAA client with the following steps on the BOSH UAA server:
      1. To target the BOSH UAA and log in with an admin credential, see Creating UAA Clients for BOSH Director. For SSO-enabled Directors, enter the following command: uaac token sso get DIRECTOR_UAA_LOGIN_USERNAME
      2. Create a UAA client for the BOSH Task Check by entering the following command: uaac client add CLIENT_NAME --authorized_grant_types client_credentials --authorities bosh.read --secret CLIENT_SECRET
    5. Click Save.
  5. Return to the Ops Manager Installation Dashboard and click Apply Changes.

(Optional) Disable Ops Manager Continuous Validation Testing

PCF Healthwatch continuously validates the health of Ops Manager. You may want to disable this test suite if, for example, you are using BOSH instead of Ops Manager to deploy PCF software. This can be accomplished either via the Ops Manager UI or BOSH manifest.

To disable the Ops Manager test suite via Ops Manager UI (an option available as of v1.1.4), do the following:

  1. Click the PCF Healthwatch tile on the Ops Manager Installation Dashboard.

  2. Navigate to Health Check section.

  3. Select the Disable radio button in the Ops Manager Validation Testing field.

To disable the Ops Manager test suite via BOSH manifest, do the following:

  1. In your BOSH manifest, set the healthchecker.opsman.disable property to true.

  2. Redeploy PCF Healthwatch and run the push-apps errand.

When you turn the test suite off, the following changes happen:

  • The opsmanager-health-check testing app is not deployed.
  • The Ops Manager Health panel is not displayed in the PCF Healthwatch UI.
  • The Ops Manager Health metric is not created and emitted.

Note: If this check was previously disabled via BOSH manifest prior to v1.1.4, you must explicitly disable it again via the Ops Manager UI.

(Optional) Allow Additional Users to Access the PCF Healthwatch UI

Any user with the healthwatch.read scope can access the PCF Healthwatch UI. The UAA admin user has this scope by default.

To allow other users access to the Healthwatch UI, perform the following steps. This procedure adds the healthwatch.read scope to the desired UAA users using the uaac client.

  1. Access the uaac client with uaac target UAA-URL.

  2. Enter uaac token client get UAA-ADMIN-CLIENT-USERNAME. When prompted, enter the secret.

  3. (Optional) Add new UAA users using uaac user add NEW-USER-USERNAME --emails NEW-USER-EMAIL-ADDRESS. When prompted, enter the password.

  4. Enter uaac member add healthwatch.read UAA-USERNAME to add the scope to the user.

Create a pull request or raise an issue on the source for this page in GitHub