Creating and Binding Solace Messaging Service Instances

This topic describes how developers create and bind instances of the Solace Messaging service.

After deploying the Solace Messaging for Pivotal Cloud Foundry (PCF) tile, the Solace Messaging service appears in the Marketplace. Developers can use either the Cloud Foundry Command Line Interface (cf CLI) or Apps Manager to create an instance of the service and bind it to applications that need to exchange messages.

Each service instance represents a Message VPN on a Solace Virtual Message Router (VMR). By binding an application to the instance, developers give the application permission to access this Message VPN through a client username. For more information about how developers can use the credentials provided by the binding, see the Understanding Solace Messaging Credentials topic.

Creating a service instance also gives the developer permissions to manage the Message VPN through the SolAdmin administration tool. For more information, see the Managing the Message VPN topic.

The following tutorials will show you how to create a Solace Messaging service called solace-messaging-instance and bind this service instance to an application named sample-cloud-app.

Create and Bind a Service Instance with the cf CLI

To create and bind an instance of the Solace Messaging service with the cf CLI, perform the following steps:

  1. Set your API endpoint to the Cloud Controller of your deployment.
    $ cf api api.YOUR-SYSTEM-DOMAIN
    Setting api endpoint to api.YOUR-SYSTEM-DOMAIN...
    OK
    API endpoint:  https://api.YOUR-SYSTEM-DOMAIN (API version: 2.59.0)
    Not logged in. Use 'cf login' to log in.
    
  2. Log in to your deployment and select an org and a space.
    $ cf login
    API endpoint: https://api.YOUR-SYSTEM-DOMAIN
    Email> user@example.com
    Password>
    
  3. List the Marketplace services and locate the Solace Messaging service.

    $ cf marketplace
    Getting services from marketplace in org example / space development as user@example.com...
    OK

    service plans description solace-messaging shared, large, community Solace Messaging for real-time, multi-protocol data distribution

  4. Create an instance of the Solace Messaging service. Select either the shared, large, or community service plan. See PCF Marketplace Plans for how these service plans differ. The following example uses the shared service plan.

    $ cf create-service solace-messaging shared solace-messaging-instance
    Creating service instance solace-messaging-instance in org example / space development as user@example.com...
    OK
    
  5. Bind the instance to an application.

    $ cf bind-service sample-cloud-app solace-messaging-instance
    Binding service solace-messaging-instance to app YOUR-APP in org example / space development as user@example.com...
    OK
    TIP: Use 'cf restage sample-cloud-app' to ensure your env variable changes take effect
    

  6. Restage the application for the binding to take effect.

    $ cf restage sample-cloud-app
    

Create and Bind a Service Instance in Apps Manager

To create and bind an instance of the Solace Messaging service in Apps Manager, perform the following steps:

  1. Navigate to apps.YOUR-SYSTEM-DOMAIN in a browser and log in.
  2. Click Marketplace in the left navigation.
  3. Click Solace Messaging.
  4. Select either the shared, large, or community service plan. See PCF Marketplace Plans for how these service plans differ.
  5. Enter an Instance Name and select a space under Add to Space. To bind the service instance to an application, select an application under Bind to App. Then click Add. Config instance
  6. You can also bind an application to a service instance by navigating to the application page, clicking Services, then clicking Bind a Service. App page
  7. Select a service instance to bind to the application and click Bind. Add binding
Was this helpful?
What can we do to improve?
Create a pull request or raise an issue on the source for this page in GitHub