Installing and Configuring Solace Messaging for Pivotal Cloud Foundry

This topic describes how to install and configure Solace Messaging for Pivotal Cloud Foundry (PCF). Before installing Solace Messaging for PCF, you must complete the prerequisites.

Review Resource Requirements

Review the resource and IP requirements for installing the Solace Messaging for PCF tile.

Resource Instances CPU Ram (MB) Ephemeral (MB) Persistent (MB) Static IP Dynamic IP
Solace Service Broker 1 1 1024 1024 0 0 1
UpdateServiceBroker 1 1 1024 1024 0 0 1
Large-VMR 11 4 12288 10240 409601 1 0
Shared-VMR 11 2 4096 10240 204801 1 0
Community-VMR 11 2 4096 10240 204801 1 0
Medium-HA-VMR 3 1, 2 2 4096 10240 204801 1 0
Large-HA-VMR 3 1, 2 4 12288 10240 409601 1 0

1 Note: You can modify the number of Instances and Persistent disk size when configuring the Solace Messaging for PCF tile for the VMR jobs. Solace recommends not changing the other parameters for the VMR jobs or any parameters for the non-VMR jobs such as the UpdateServiceBroker job. For more information, see the Configure Solace Messaging for PCF tile below.

2 Note: A single high-availability Solace Messaging service instance requires three (3) HA VMR job instances to be used. As such the number of HA VMR job instances specified for the HA VMR instances should be multiple of 3. If it is not the remaining job instances will go unused.

Prerequisites

The Solace Messaging for PCF Service Broker requires the following:

  • Java buildpack v3.7.1 or higher.
  • The MySQL for PCF tile. When configuring the tile, set the maximum storage in the Service Plan section to 100 MB. For information on how to install and configure the tile, see the MySQL for PCF documentation.

Install Solace Messaging for PCF

To install Solace Messaging for PCF, perform the following steps:

  1. Download the product file from Pivotal Network.
  2. Upload the product file on the Ops Manager Installation Dashboard.
  3. Click Add next to the uploaded Solace Messaging tile in the Ops Manager Available Products view to add it to your staging area.
  4. Click the Solace Messaging tile.
  5. Follow the steps in the section below to configure the tile.

Configure Solace Messaging for PCF

To configure Solace Messaging for PCF, perform the following steps:

  1. From the Settings tab of the Solace Messaging tile, click Assign AZs and Networks. Network config form
  2. Under Network, choose the network where Solace Messaging should run.
  3. Click Save.
  4. Click Message Routing Config. Vmr config form
  5. Under Admin user password, pick a password for the Virtual Message Routers admin user.

    Admin password vmr config

  6. Under Support user password, pick a password for the Virtual Message Routers support user.

    Support password vmr config

  7. Under Starting Port, enter a port where the messaging services on the VMRs (e.g. MQTT, REST, or SMF) will start listening from, for example, 7000.
    The exact port numbers chosen for each service will be based on this starting port and specified in the VCAP_SERVICES environment variable passed to applications. For an example, see Example Environment Variable.

    Starting port vmr config

  8. Click Save.

  9. (Optional) Click TLS Config. By configuring TLS, you allow messaging between applications and the Solace VMRs to be encrypted. Applications requiring encryption would then need to use the TLS-specific URLs passed in the VCAP_SERVICES environment variable. For more information about the VCAP_SERVICES environment variable, see Example Environment Variable. If TLS is not configured, the TLS specific URLs continue to be passed in the VCAP_SERVICES environment variable but fail to connect to a VMR if used.

    Tls config form

  10. (Optional) Configure Message Router’s RSA certificate (Server Certificate) either by pasting in a certificate and private key in PEM format or asking one to be generated by clicking Generate RSA Certificate. Generated certificates are equivalent to self-signed certificates.

    Rsa certificate config form

    Note: The server certifcate configured will be used by all Solace VMRs deployed and as such all VMRs deployed in a PCF instances will have the same identification.

    Note: Communication between the Solace Messaging Service Broker and VMRs is also encrypted if a TLS certificate is configured. The Service Broker uses the Container Certificate Trust Store Framework to validate the server certificate returned by VMRs. So if the framework is not operational when the tile is deployed the Service Broker will be unable to validate server certificates sent by the VMRs and the tile will fail to deploy. In development environments it may be acceptable to not require server certificate validation in which case the Disable RSA Server Certificate validation on the Service Broker (For development only) checkbox can be selected. This checkbox should never be selected in production deployments, instead the framework should be made operational.

  11. (Optional) Click Save.

  12. (Optional) Click Service Access

    Serviceaccess config form

  13. (Optional) Enable the Enable global access to plans of service solace_messaging option.

    Note: To control access to Solace Messaging service plans on a case-by-case basis, do not enable this option.

  14. (Optional) Click Save.

  15. Click Resource Config.

  16. Use the drop-down menus to configure the number of VMR job instances that are available in each of the five service plans mentioned above. These job instances are statically created when the tile is deployed. Service instances are then dynamically allocated at service instance creation time, post-deployment, using these job instances.

    Five Shared-VMR service instances can be hosted on a single Shared-VMR job instance. As such the maximum number of Shared-VMR service instances that can concurrently exist for the Shared-VMR service plan is equal to five times the number of Shared-VMR job instances. Conversely three HA VMR job instances are required for a single HA VMR service instance. As such the maximum number of HA VMR service instances that can concurrently exist for the Large-HA-VMR and Medium-HA-VMR service plans is equal to one-third the number of their corresponding job instances.

    Note: The number of job instances can be increased after the tile is deployed without impacting already bound applications however reducing the number of instances can result in application failure and message loss.

    Note: The size of the persistent disk can be changed both before and after deployment. Increasing the size of the persistent disks will impact the service of already bound applications however messages will not be lost. Reducing the size of the persistent disk post-deployment is not recommended and can result in message loss, inoperable VMRs, and/or undefined behaviors.

    Note: Solace recommends keeping the default values for VM Type.

    Resource config

  17. Click Save.

  18. Click Installation Dashboard at the top left corner of the screen to leave the tile configuration and go back to dashboard.

  19. Click Apply Changes to deploy the tile.

  20. After the tile has deployed, see the Creating and Binding Solace Messaging Service Instances topic for information about creating instances of the Solace Messaging service and binding them to applications.

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