LATEST VERSION: 1.1 - CHANGELOG
Redis for PCF v1.9

Troubleshooting Instances

Page last updated:

This topic provides basic instructions for app developers troubleshooting On-Demand Redis for Pivotal Cloud Foundry (PCF).

About the BOSH CLI

The BOSH CLI is available in two major versions, v1 and v2. Pivotal recommends that you use the BOSH CLI v2 when possible.

This topic provides examples of using each version of the BOSH CLI. While all versions of the BOSH CLI work with Redis 1.9, your PCF installation may affect which version of the BOSH CLI you can use. Consult the table below to determine which version of the CLI is supported for your installation.

PCF Version BOSH CLI Version
1.10 CLI v1
1.11 CLI v1 or CLI v2 (Pivotal recommends CLI v2)

Temporary Outages

Redis for PCF service instances can become temporarily inaccessible during upgrades and VM or network failures.

Errors

You may see an error when using the Cloud Foundry Command-Line Interface (cf CLI) to perform basic operations on a Redis for PCF service instance:

  • cf create
  • cf update
  • cf bind
  • cf unbind
  • cf delete

Parse a Cloud Foundry (CF) Error Message

Failed operations (create, update, bind, unbind, delete) result in an error message. You can retrieve the error message later by running the cf CLI command cf service INSTANCE-NAME.

$ cf service myservice

Service instance: myservice
Service: super-db
Bound apps:
Tags:
Plan: dedicated-vm
Description: Dedicated Instance
Documentation url:
Dashboard: 

Last Operation
Status: create failed
Message: Instance provisioning failed: There was a problem completing your request. 
     Please contact your operations team providing the following information: 
     service: redis-acceptance, 
     service-instance-guid: ae9e232c-0bd5-4684-af27-1b08b0c70089,
     broker-request-id: 63da3a35-24aa-4183-aec6-db8294506bac, 
     task-id: 442, 
     operation: create
Started: 2017-03-13T10:16:55Z
Updated: 2017-03-13T10:17:58Z

Use the information in the Message field to debug further. Provide this information to Pivotal Support when filing a ticket.

Troubleshooting failed BOSH tasks

The task-id field maps to the BOSH task id. For further information on a failed BOSH task, use the bosh task TASK-ID command in the BOSH CLI.

Note: This procedure is the same for v1 and v2 of the BOSH CLI.

Accessing logs

The broker-request-guid maps to the portion of the On-Demand Broker log containing the failed step. Access the logs to troubleshoot your instance. If you have more than one broker instance, repeat this process for each one.

BOSH CLI v2: Accessing logs

This procedure is for v2 of the BOSH CLI.

Access the broker log with the syslog aggregator, or access BOSH broker logs with bosh logs broker /0.

BOSH CLI v1: Accessing logs

This procedure is for v1 of the BOSH CLI.

Access the broker log with the syslog aggregator, or access BOSH broker logs with bosh logs broker 0.

Retrieve Service Instance Information

  1. Log into the space containing the instance or failed instance.

    $ cf login
    

  2. If you do not know the name of the service instance, run cf services to see a listing of all service instances in the space. The service instances are listed in the name column.

    $ cf services
    Getting services in org my-org / space my-space as user@example.com...
    OK
    name          service      plan        bound apps    last operation
    my-instance   p.Redis      db-small                  create succeeded
    

  3. Run cf service SERVICE-INSTANCE-NAME to retrieve more information about a specific instance.

  4. Run cf service SERVICE-INSTANCE-NAME --guid to retrieve the GUID of the instance, which is useful for debugging.

Select the BOSH Deployment for a Service Instance

BOSH CLI v2: Selecting a BOSH deployment

  1. Retrieve the GUID of your service instance with command cf service YOUR-SERVICE-INSTANCE --guid.

  2. To download your BOSH manifest for the service, run bosh manifest -d service-instance_SERVICE-INSTANCE-GUID > MY-SERVICE.yml GUID you just obtained and a filename you want to save the manifest as.

BOSH CLI v1: Selecting a BOSH deployment

  1. Retrieve the GUID of your service instance with command cf service YOUR-SERVICE-INSTANCE --guid.

  2. To download your BOSH manifest for the service, run bosh download manifest service-instance_SERVICE-INSTANCE-GUID myservice.yml GUID you just obtained and a filename you want to save the manifest as.

  3. Run bosh deployment MY-SERVICE.yml to select the deployment.

Knowledge Base (Community)

Find the answer to your question and browse product discussions and solutions by searching the Pivotal Knowledge Base.

File a Support Ticket

You can file a support ticket here. Be sure to provide the error message from cf service YOUR-SERVICE-INSTANCE.

To help expedite troubleshooting, if possible also provide your service broker logs, service instance logs, and BOSH task output. Your cloud operator should be able to obtain these from your error message.

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