Managing Service Instances

Creating an Instance

You can create a Circuit Breaker Dashboard service instance using either the Cloud Foundry Command Line Interface tool (cf CLI) or PWS Apps Manager.

Using the cf CLI

Begin by targeting the correct org and space.

$ cf target -o myorg -s development

API endpoint:   https://api.cf.wise.com (API version: 2.43.0)
User:           user
Org:            myorg
Space:          development

If desired, view plan details for the Circuit Breaker Dashboard product using cf marketplace -s.

$ cf marketplace
Getting services from marketplace in org myorg / space development as user...
OK

service                       plans          description
p-circuit-breaker-dashboard   standard       Circuit Breaker Dashboard for Spring Cloud Applications
p-config-server               standard       Config Server for Spring Cloud Applications
p-mysql                       100mb-dev      MySQL service for application development and testing
p-rabbitmq                    standard       RabbitMQ is a robust and scalable high-performance multi-protocol messaging broker.
p-service-registry            standard       Service Registry for Spring Cloud Applications

TIP:  Use 'cf marketplace -s SERVICE' to view descriptions of individual plans of a given service.

$ cf marketplace -s p-circuit-breaker-dashboard
Getting service plan information for service p-circuit-breaker-dashboard as ...
OK

service plan   description     free or paid
standard       Standard Plan   free

Run cf create-service, specifying the service, plan name, and instance name.

$ cf create-service p-circuit-breaker-dashboard standard circuit-breaker-dashboard
Creating service instance circuit-breaker-dashboard in org myorg / space development as admin...
OK

Create in progress. Use 'cf services' or 'cf service circuit-breaker-dashboard' to check operation status.

As the command output suggests, you can use the cf services or cf service commands to check the status of the service instance. When the service instance is ready, the cf service command will give a status of create succeeded:

$ cf service circuit-breaker-dashboard

Service instance: circuit-breaker-dashboard
Service: p-circuit-breaker-dashboard
Bound apps:
Tags:
Plan: standard
Description: Circuit Breaker Dashboard for Spring Cloud® Applications
Documentation url: http://docs.pivotal.io/spring-cloud-services/
Dashboard: https://spring-cloud-broker.apps.wise.com/dashboard/p-circuit-breaker-dashboard/97869d78-5d4e-410b-9c71-bb622ca49f7d

Last Operation
Status: create succeeded
Message:
Started: 2016-06-29T19:13:13Z
Updated: 2016-06-29T19:16:19Z

Using Apps Manager

Log into Apps Manager as a Space Developer. In the Marketplace, select Circuit Breaker.

Marketplace pws

Select the desired plan for the new service instance.

Select plan pws

Provide a name for the service instance (for example, “circuit-breaker-dashboard”). Click the Add button.

Instance name pws

In the Services list, click the listing for the new service instance.

Service successfully added pws

Click the Manage link.

Manage link pws

It may take a few minutes to provision the service instance; while it is being provisioned, you will see a “The service instance is initializing” message. Once the instance is ready, its dashboard will load automatically.

The Circuit Breaker Dashboard instance is now ready to be used. For an example of using a circuit breaker in an application, see the Writing Client Applications topic.

Updating an Instance

You can update settings on a Circuit Breaker Dashboard service instance using the Cloud Foundry Command Line Interface tool (cf CLI). The cf update-service command can be given a -c flag with a JSON object containing parameters used to configure the service instance.

To update a Circuit Breaker Dashboard service instance’s settings, target the org and space of the service instance:

$ cf target -o myorg -s development

API endpoint:   https://api.cf.wise.com (API version: 2.43.0)
User:           user
Org:            myorg
Space:          development

Then run cf update-service SERVICE_NAME -c '{ "PARAMETER": "VALUE" }', where SERVICE_NAME is the name of the service instance, PARAMETER is a supported parameter, and VALUE is the value for the parameter. For information about supported parameters, see the next section.

Configuration Parameters

General parameters accepted for the Circuit Breaker Dashboard are listed below.

Parameter Function Example
upgrade Whether to upgrade the instance '{"upgrade": true}'
force When upgrade is set to true, whether to force an upgrade of the instance, even if the instance is already at the latest available service version '{"force": true}'

To update a service instance so that it is upgraded to the latest available service version, run:

$ cf update-service circuit-breaker-dashboard -c '{"upgrade": true}'
Updating service instance circuit-breaker-dashboard as user...
OK

Update in progress. Use 'cf services' or 'cf service circuit-breaker-dashboard' to check operation status.

As the command output suggests, you can use the cf services or cf service commands to check the status of the service instance. When the update is complete, the cf service command will give a status of update succeeded:

$ cf service circuit-breaker-dashboard

Service instance: circuit-breaker-dashboard
Service: p-circuit-breaker-dashboard
Bound apps: agency
Tags:
Plan: standard
Description: Circuit Breaker Dashboard for Spring Cloud Applications
Documentation url: http://docs.pivotal.io/spring-cloud-services/
Dashboard: https://spring-cloud-broker.apps.wise.com/dashboard/p-circuit-breaker-dashboard/9397f120-484d-45ef-a7bd-20661e98b643

Last Operation
Status: update succeeded
Message:
Started: 2017-06-16T18:18:14Z
Updated: 2017-06-16T18:20:17Z

The service instance is now updated and ready to be used. For an example of using a circuit breaker in an application, see the Writing Client Applications topic.

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