Managing the Message VPN

Developers can manage the Message VPN associated with a service instance by using the Dashboard URL of the service and by connecting to the Solace PubSub+ message broker via the PubSub+ Manager web browser based interface.

Solace PubSub+ Service Dashboard

The Solace PubSub+ Service Dashboard offers a link to the Solace PubSub+ Manager and the ability to capture a backup of basic service configuration and restore it.

Retrieve Dashboard Information

  1. Look for the ‘Dashboard’ by getting details about the created service.

    $ cf service solace-pubsub-instance-IoT

    Service instance: solace-pubsub-instance-IoT Service: solace-pubsub Bound apps: Tags: Plan: enterprise-shared Description: Solace PubSub+ message broker for real-time, multi-protocol data distribution Documentation url: http://docs.solace.com Dashboard: https://solace-service-dashboard.YOUR-SYSTEM-DOMAIN/service-dashboard/ALKSJDLAKSJDLKAJSLDKJA/auth/YLLKJJ)(UASJldKAJSD*ALSKFALSGHLAKSJDlAJSLDJASLKJDALSKJDL.eHl6S

    Last Operation Status: create succeeded Message: Started: 2020-01-01T00:00:00Z Started: 2020-01-01T00:00:00Z

  2. Use the provided URL in a browser.

    Sample service dashboard2

Solace PubSub+ Manager

The Solace PubSub+ message broker includes a browser based management interface for the Solace PubSub+ services. The Solace PubSub+ Manager is accessible when a service is created from a link in the Solace PubSub+ Service Dashboard.

Sample PubSub+ Manager

Sample pubsub manager new

Restrictions on the Use of the PubSub+ Manager

There are some actions that you must not perform in the PubSub+ Manager:

  1. Do not change anything on the Message VPN/Connectivity page. Settings such as TLS configuration must be managed through the tile.
  2. On the Message VPN/Replication page, do not change the Replication Role. This causes the deployment to fail.
  3. Do not change anything on the Access Control/Authentication page. Settings such as Authentication type must be managed through the tile. Likewise, client usernames should be created by binding services through PCF.

Solace PubSub+ Configuration Backup and Restore

Configuration Backup and Restore is a Beta feature.

It provides the ability to capture a backup of service configuration only and to restore to a newly created service.

At this point it is not intended to do a full backup and restore on the same service. It should only be used to transfer limited configuration to a new service when data retention is not needed.

Note that performing a restore will delete all persisted messages and will leave the VPN with only the objects that existed when the backup was performed.

Managing with SolAdmin

This section describes how to connect to the Solace PubSub+ message broker with the SolAdmin legacy administration tool to manage the Message VPN associated with a service instance.

Retrieve Information From a Bound App

To retrieve the information required to connect to the Solace PubSub+ message broker from a bound app, do the following:

  1. Log in to your deployment and choose the org and space where your Solace PubSub+ service instance and bound app exists.

    $ cf login
    API endpoint: https://api.YOUR-SYSTEM-DOMAIN
    Email> user@example.com
    Password>
    

  2. View the VCAP_SERVICES environment variable by retrieving the environment variables associated with your bound app:

    $ cf env YOUR-APP
    

Retrieve Information from a Service Key

To retrieve the information required to connect to the Solace PubSub+ message broker from a service key, do the following:

  1. Log in to your deployment and choose the org and space where your Solace PubSub+ service instance and service key exists.

    $ cf login
    API endpoint: https://api.YOUR-SYSTEM-DOMAIN
    Email> user@example.com
    Password>
    

  2. View the service key:

    $ cf service-key solace-pubsub-instance my-service-key
    

Locate the Management Host and Credentials

  1. Both the VCAP_SERVICES and service key contain the same information, look for and record the following fields:
    • managementHostnames: The Solace PubSub+ message broker’s management hostnames. There will be multiple entries for Services on HA Plans.
    • activeManagementHostname: A single entry that is dynamically routed to the active node for an HA service. Will always be the same as managementHostnames for non-HA plans.
    • When Management Access is set to Message Broker Internal:
      • managementUsername: The service instance’s management username
      • managementPassword: The service instance’s management password
    • When Management Access is set to LDAP Server:
      • The management username and password are to be provided by the LDAP Administrator.

        For more information about the VCAP_SERVICES fields, see the Understanding Credentials topic.

Connect to the Solace PubSub+ Message Broker

The managementHostnames and activeManagementHostname are externally accessible FQDNs and can be used directly from within SolAdmin using standard ports for HTTP (80) and HTTPS (443). The procedure is as follows:

  1. Download and install the SolAdmin administration tool from the Solace Developers Portal Download Page.

  2. Start SolAdmin.

  3. Click Manage to open the Manage Appliance window.

    Soladmin manage

  4. Under Management Host, enter the active management hostname of the Solace PubSub+ message broker recorded above.

  5. Under User Name and Password, enter the management username and password recorded above.

  6. Click Ok. The Solace PubSub+ message broker should now appear in the Managed Appliances list.

    Soladmin router list

  7. To learn how to use SolAdmin to manage your Message VPN, see the included context specific tool help within the SolAdmin tool itself.

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