service-broker-creation-ee1189a.md

Service Broker Creation

Service brokers are applications that advertise a catalog of service offerings and service plans, as well as interpreting calls for creation, binding, unbinding, and deletion. The deploy service supports automatic creation (and update) of service brokers as part of an application deployment process.

Аn application can declare that a service broker should be created as part of its deployment process, by using the following parameters in its corresponding module in the MTA deployment (or extension) descriptor:

Tip:

You can use placeholders ${} in the service-URL declaration.

Sample Code:

- name: jobscheduler-broker
  properties: 
    user: ${generated-user}
    password: ${generated-password}  
  parameters:
    create-service-broker: true 
    service-broker-name: jobscheduler 
    service-broker-user: ${generated-user} 
    service-broker-password: ${generated-password} 
    service-broker-url: ${default-url} 

The value of the “${generated-user}” and “${generated-password}” placeholders in the properties section is the same as in the parameters section. The service-broker application uses this mechanism to inject the user-password credentials.

The create-service-broker parameter should be set to true if a service broker must be created for the specified application module. You can specify the name of the service broker with the service-broker-name parameter; the default value is ${app-name}The service-broker-user and service-broker-password are the credentials that will be used by the controller to authenticate itself to the service broker in order to make requests for creation, binding, unbinding and deletion of services. The service-broker-url parameter specifies the URL on which the controller will send these requests.

Note:

During the creation of the service broker, the XS advanced controller makes a call to the service-broker API to inquire about the services and plans the service broker provides. For this reason, an application that declares itself as a service broker must implement the service-broker application-programming interface (API). Failure to do so might cause the deployment process to fail.

Note:

Normally, the registration of а space-scoped broker is successful, because it requires SpaceDeveloper privileges of the user. However, for a global registration of the service broker, global admin privileges are needed, which the platform developer usually does not have. In such cases, the MTA deployment would fail. To solve this, do not use the --do-not-fail-on-missing-permissions option, which will result in skipping the step with a warning.