Managing Service Instances

See below for information about managing Circuit Breaker Dashboard service instances using the Cloud Foundry Command Line Interface tool (cf CLI). You can also manage Circuit Breaker Dashboard service instances using Pivotal Web Services Apps Manager.

Creating an Instance

Begin by targeting the correct org and space.

$ cf target -o myorg -s development

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

$ cf marketplace -s p-circuit-breaker-dashboard
Getting service plan information for service p-circuit-breaker-dashboard as user...
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

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:

[...]

Last Operation
Status: create succeeded

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

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}'

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:

[...]

Last Operation
Status: update succeeded

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

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