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 VMR with the SolAdmin administration tool.

Managing with SolAdmin

This section describes how to manage the Message VPN associated with a service instance by connecting to the VMR with the SolAdmin administration tool.

Retrieve Information from a bound app

To retrieve the information required to connect to the VMR from a bound app, perform the following steps:

  1. Log in to your deployment and choose the org and space where your Solace Messaging 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 VMR from a Service Key, perform the following steps:

  1. Log in to your deployment and choose the org and space where your Solace Messaging 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-messaging-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 VMR’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 VMR 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 VMR

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 VMR recorded above.
  5. Under User Name and Password, enter the management username and password recorded above.
  6. Click Ok. The VMR 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.

Managing with the WebUI

The VMR contains an Alpha version of a WebUI tool that offers a limited but growing set of VMR management capabilities for the Solace Messaging services. This Alpha version is being released to provide customers with a view of our direction and to obtain early feedback on the look and feel of the WebUI. As it does not yet have full management feature support for this GA version of the message router, full support for the management of the router is available via SolAdmin and CLI. The WebUI is accessible when a service is created.

Retrieve WebUI information

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

    $ cf service solace-messaging-instance-IoT
    
    Service instance: solace-messaging-instance-IoT
    Service: solace-messaging
    Bound apps:
    Tags:
    Plan: shared
    Description: Solace Messaging for real-time, multi-protocol data distribution
    Documentation url: http://docs.solace.com
    Dashboard: https://shared-vmr-0.YOUR-SYSTEM-DOMAIN/#/msg-vpns/djAwMQ==?token=YWJj.jsalkdj01041024laqksdjalsdh8ayulaksfnaosfr0817u04ualknaglnzs0v8u0qusflasknrflknifQ%3D%3D.eHl6
    
    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 Web UI

Sample webui

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