LATEST VERSION: 1.12 - CHANGELOG

Troubleshooting Redis for PCF

Page last updated:

In this topic:

This topic lists troubleshooting information relevant to Redis for PCF.

Useful Debugging Information

If you encounter an issue, here is a list of useful information to gather, especially before you perform any destructive operations such as cf purge-service-offerings or bosh2 -d SERVICE-INSTANCE-DEPLOYMENT delete-deployment.

Before debugging, ensure you know the following about your PCF deployment:

  • The version of Redis for PCF

  • If upgrading, the previous of Redis for PCF

  • Ops Manager version, and, if upgrading, the previous version of Ops Manager

  • IaaS description

From OpsManager:

  • The installation logs
  • A copy of all files in /var/tempest/workspaces/default/deployments

For All VMs, Unless Specified Otherwise:

  • Copy of /var/vcap/sys/log (particularly the broker)
  • If unable to get logs from disk, logs from a forwarded endpoint
  • monit summary
  • Full ps aux: Has monit done its job?
  • ps aux | grep redis-serve[r]: Are Redis instances running?
  • df -h: disk usage
  • free -m: memory usage
  • cf m
  • tree /var/vcap/store/cf-redis-broker/redis-data (broker only)
  • Copy of /var/vcap/store/cf-redis-broker/statefile.json (broker only)

How to Retrieve a Service instance GUID

You need the GUID of your service instance to run some BOSH commands. To retrieve the GUID, run the command cf service SERVICE-INSTANCE-NAME --guid.

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.

Troubleshooting Errors

Start here if you are responding to a specific error or error messages.

Failed Install

  1. Certificate issues: The on-demand broker (ODB) requires valid certificates. Ensure that your certificates are valid and generate new ones if necessary.
  2. Deploy fails: Deploys can fail for a variety of reasons. View the logs using Ops Manager to determine why the deploy is failing.
  3. Networking problems:
    • Cloud Foundry cannot reach the Redis for PCF service broker
    • Cloud Foundry cannot reach the service instances
    • The service network cannot access the BOSH director
  4. Register broker errand fails.
  5. The smoke test errand fails.
  6. Resource sizing issues: These occur when the resource sizes selected for a given plan are less than the Redis for PCF service requires to function. Check your resource configuration in Ops Manager and ensure that the configuration matches that recommended by the service.
  7. Other service-specific issues.

Cannot Create or Delete Service Instances

If developers report errors such as the following:

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
  1. If the BOSH error shows a problem with the deployment manifest:

    1. Download the manifest for the on-demand service instance by running:
      bosh download manifest service-instance_SERVICE-INSTANCE-GUID MY-SERVICE.yml.

    2. Check the manifest for configuration errors.

    Note: This error does not apply if you are using BOSH CLI v2. In that case, to troubleshoot possible problems with the manifest, open it in a text editor and inspect the manifest there.

  2. To continue troubleshooting, Log in to BOSH and target the Redis for PCF service instance using the instructions on parsing a Cloud Foundry error message.

  3. Retrieve the BOSH task ID from the error message and run one of the following commands depending on your Ops Manager version:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh task TASK-ID
    1.11 bosh2 task TASK-ID
    1.12 and later bosh task TASK-ID
  4. If you need more information, access the broker logs and use the broker-request-id from the error message above to search the logs for more information. Check for:

Broker Request Timeouts

If developers report errors such as:

Server error, status code: 504, error code: 10001, message: The request to the service broker timed out: https://BROKER-URL/v2/service_instances/e34046d3-2379-40d0-a318-d54fc7a5b13f/service_bindings/aa635a3b-ef6d-41c3-a23f-55752f3f651b
  1. Confirm that Cloud Foundry (CF) is connected to the service broker.
  2. Check the BOSH queue size:
    1. Log into BOSH as an admin.
    2. Run one of these commands depending on your Ops Manager version:
      • 1.10 and earlier: bosh tasks
      • 1.11: bosh2 tasks
      • 1.12 and later: bosh tasks
  3. If there are a large number of queued tasks, the system may be under too much load. BOSH is configured with two workers and one status worker, which may not be sufficient resources for the level of load. Advise app developers to try again once the system is under less load.

Cannot Bind to or Unbind from Service Instances

Instance Does Not Exist

If developers report errors such as:

Server error, status code: 502, error code: 10001, message: Service broker error: instance does not exist`

Follow these steps:

  1. Type cf service MY-INSTANCE --guid. This confirms that the the Redis for PCF service instance exists in BOSH and CF, and returns a GUID.

  2. Using the GUID obtained above, run one of the following BOSH CLI commands depending on your Ops Manager version:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh vms service-instance_GUID
    1.11 bosh2 -d service-instance_GUID vms
    1.12 and later bosh -d service-instance_GUID vms

If the BOSH deployment is not found, it has been deleted from BOSH. Contact Pivotal support for further assistance.

Other Errors

If developers report errors such as:

Server error, status code: 502, error code: 10001, message: Service broker error: There was a problem completing your request. Please contact your operations team providing the following information: service: example-service, service-instance-guid: 8d69de6c-88c6-4283-b8bc-1c46103714e2, broker-request-id: 15f4f87e-200a-4b1a-b76c-1c4b6597c2e1, operation: bind

To find out the exact issue with the binding process:

  1. Access the service broker logs.

  2. Search the logs for the broker-request-id string listed in the error message above.

  3. Contact Pivotal support for further assistance if you are unable to resolve the problem.

  4. Check for:

Cannot Connect to a Service Instance

If developers report that their app cannot use service instances that they have successfully created and bound:

Ask the user to send application logs that show the connection error. If the error is originating from the service, then follow Redis for PCF-specific instructions. If the issue appears to be network-related, then:

  1. Check that application security groups are configured correctly. Access should be configured for the service network that the tile is deployed to.

  2. Ensure that the network the PCF Elastic Runtime tile is deployed to has network access to the service network. You can find the network definition for this service network in the Ops Manager Director tile.

  3. In Ops Manager go into the service tile and see the service network that is configured in the networks tab.

  4. In Ops Manager go into the ERT tile and see the network it is assigned to. Make sure that these networks can access each other.

Upgrade All Instances Fails

If the upgrade-all-service-instances errand fails, look at the errand output in the Ops Manager log.

If an instance fails to upgrade, debug and fix it before running the errand again to prevent any failure issues from spreading to other on-demand instances.

Once the Ops Manager log no longer lists the deployment as failing, re-run the errand to upgrade the rest of the instances.

Missing Logs and Metrics

If no logs are being emitted by the on-demand broker, check that your syslog forwarding address is correct in Ops Manager.

  1. Ensure you have configured syslog for the tile.
  2. Ensure that you have network connectivity between the networks that the tile is using and the syslog destination. If the destination is external, you need to use the public ip VM extension feature available in your Ops Manager tile configuration settings.
  3. Verify that the Firehose is emitting metrics:
    1. Install the cf nozzle plugin
    2. Run cf nozzle -f ValueMetric | grep --line-buffered "on-demand-broker/MY-SERVICE" to find logs from your service in the cf nozzle output.

If no metrics appear within five minutes, verify that the broker network has access to the Loggregator system on all required ports.

Contact Pivotal support if you are unable to resolve the issue.

Troubleshooting Components

Guidance on checking for and fixing issues in on-demand service components.

BOSH Problems

Missing BOSH Director UUID

Note: This error does not occur if you are using BOSH CLI v2

If using the BOSH CLI v1, re-add the director_uuid to the manifest:

  1. Run bosh status --uuid and record the director_uuid value from the output.

  2. Edit the manifest and add the director_uuid: DIRECTOR-UUID from the last step at the top of the manifest.

For more, see Deployment Identification in the BOSH docs.

Large BOSH Queue

On-demand service brokers add tasks to the BOSH request queue, which can back up and cause delay under heavy loads. An app developer who requests a new Redis for PCF instance sees create in progress in the Cloud Foundry Command Line Interface (cf CLI) until BOSH processes the queued request.

Ops Manager currently deploys two BOSH workers to process its queue. Future versions of Ops Manager will let users configure the number of BOSH workers.

Configuration

Service instances in failing state

You may have configured a VM / Disk type in tile plan page in Ops Manager that is insufficiently large for the Redis for PCF service instance to start. See tile-specific guidance on resource requirements.

Authentication

UAA Changes

If you have rotated any UAA user credentials then you may see authentication issues in the service broker logs.

To resolve this, redeploy the Redis for PCF tile in Ops Manager. This provides the broker with the latest configuration.

Note: You must ensure that any changes to UAA credentials are reflected in the Ops Manager credentials tab of the Elastic Runtime tile.

Networking

Common issues include:

  1. Network latency when connecting to the Redis for PCF service instance to create or delete a binding.
    • Solution: Try again or improve network performance
  2. Network firewall rules are blocking connections from the Redis for PCF service broker to the service instance.
    • Solution: Open the Redis for PCF tile in Ops Manager and check the two networks configured in the Networks pane. Ensure that these networks allow access to each other.
  3. Network firewall rules are blocking connections from the service network to the BOSH director network.
    • Solution: Ensure that service instances can access the Director so that the BOSH agents can report in.
  4. Apps cannot access the service network.
    • Solution: Configure Cloud Foundry application security groups to allow runtime access to the service network.
  5. Problems accessing BOSH’s UAA or the BOSH director.
    • Solution: Follow network troubleshooting and check that the BOSH director is online.

Validate Service Broker Connectivity to Service Instances

  1. To validate you can bosh2 ssh onto the Redis for PCF service broker:

    • With BOSH CLI v2: Target the deployment, and reach the service instance.
    • With BOSH CLI v1: Download the broker manifest and target the deployment, then try to reach the service instance.
  2. If no BOSH task-id appears in the error message, look in the broker log using the broker-request-id from the task.

Validate App Access to Service Instance

Use cf ssh to access to the app container, then try connecting to the Redis for PCF service instance using the binding included in the VCAP_SERVICES environment variable.

Quotas

Plan Quota issues

If developers report errors such as:

Message: Service broker error: The quota for this service plan has been exceeded. 
Please contact your Operator for help.
  1. Check your current plan quota.
  2. Increase the plan quota.
  3. Log into Ops Manager.
  4. Reconfigure the quota on the plan page.
  5. Deploy the tile.
  6. Find who is using the plan quota and take the appropriate action.

Global Quota Issues

If developers report errors such as:

Message: Service broker error: The quota for this service has been exceeded. 
Please contact your Operator for help.
  1. Check your current global quota.
  2. Increase the global quota.
  3. Log into Ops Manager.
  4. Reconfigure the quota on the on-demand settings page.
  5. Deploy the tile.
  6. Find out who is using the quota and take the appropriate action.

Failing jobs and unhealthy instances

To determine whether there is an issue with the Redis for PCF service deployment, inspect the VMs. To do so, run one of the following commands:

Ops Manager Version BOSH Command
1.10 or earlier bosh vms --vitals service-instance_GUID
1.11 bosh2 -d service-instance_GUID vms --vitals
1.12 and later bosh -d service-instance_GUID vms --vitals

For additional information, run one of the following commands:

Ops Manager Version BOSH Command
1.10 and earlier bosh instances --ps --vitals
1.11 bosh2 instances --ps --vitals
1.12 and later bosh instances --ps --vitals

If the VM is failing, follow the service-specific information. Any unadvised corrective actions (such as running BOSH restart on a VM) can cause issues in the service instance.

Techniques for Troubleshooting

This section contains instructions on interacting with the on-demand service broker and on-demand service instance BOSH deployments, and on performing general maintenance and housekeeping tasks.

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.

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 v1 of the BOSH CLI. For v2, use bosh2 task TASK-ID.

The broker-request-guid maps to the portion of the On-Demand Broker log containing the failed step. Access the broker log through your syslog aggregator, or access BOSH logs for the broker by typing bosh logs broker 0. If you have more than one broker instance, repeat this process for each instance.

Access Broker and Instance Logs and VMs

Before following the procedures below, log into the cf CLI and the BOSH CLI.

Access Broker Logs and VM(s)

You can access logs using Ops Manager by clicking on the Logs tab in the tile and downloading the broker logs.

To access logs using the BOSH CLI, do the following:

  1. Identify the on-demand broker (ODB) deployment by running one of the following commands, depending on your Ops Manager version:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh deployments
    1.11 bosh2 deployments
    1.12 and later
  2. For BOSH CLI v1 only:

    1. Run bosh download manifest ODB-DEPLOYMENT-NAME odb.yml to download the ODB manifest.
    2. Select the ODB deployment using bosh deployment odb.yml.
  3. View VMs in the deployment using one of the following commands:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh instances
    1.11 bosh2 -d DEPLOYMENT-NAME instances
    1.12 and later
  4. SSH onto the VM by running one of the following commands:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh ssh service-instance_GUID
    1.11 bosh2 -d service-instance_GUID ssh
    1.12 and later bosh -d service-instance_GUID ssh
  5. Download the broker logs by running one of the following commands:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh logs service-instance_GUID
    1.11 bosh2 -d service-instance_GUID logs
    1.12 and later bosh -d service-instance_GUID logs

The archive generated by BOSH or Ops Manager includes the following logs:

Log Name Description
broker.log Requests to the on-demand broker and the actions the broker performs while orchestrating the request (e.g. generating a manifest and calling BOSH). Start here when troubleshooting.
broker_ctl.log Control script logs for starting and stopping the on-demand broker.
post-start.stderr.log Errors that occur during post-start verification.
post-start.stdout.log Post-start verification.
drain.stderr.log Errors that occur while running the drain script.

Access Service Instance Logs and VMs

  1. To target an individual service instance deployment, retrieve the GUID of your service instance with the cf CLI command cf service MY-SERVICE --guid.

  2. For BOSH CLI v1 only:

    1. Run bosh status --uuid to retrieve the BOSH Director GUID.

      Note: “GUID” and “UUID” mean the same thing.

    2. To download your BOSH manifest for the service, run bosh download manifest service-instance_BOSH-DIRECTOR-GUID MANIFEST.yml using the GUID you just obtained and a filename you want to save the manifest as.

    3. Edit the following line in the service instance manifest that you just saved, to include the current BOSH Director GUID:
          director_uuid: BOSH-DIRECTOR-GUID
      
    4. Run bosh deployment MANIFEST.yml to select the deployment using the Director UUID.
  3. View VMs in the deployment using one of the following commands:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh instances
    1.11 bosh2 -d DEPLOYMENT-NAME instances
    1.12 and later bosh -d DEPLOYMENT-NAME instances
  4. SSH onto a VM by running one of the following commands:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh ssh service-instance_GUID
    1.11 bosh2 -d service-instance_GUID ssh
    1.12 and later bosh -d service-instance_GUID ssh
  5. Download the instance logs by running one of the following commands:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh logs service-instance_GUID
    1.11 bosh2 -d service-instance_GUID logs
    1.12 and later bosh -d service-instance_GUID logs

Run Service Broker Errands to Manage Brokers and Instances

From the BOSH CLI, you can run service broker errands that manage the service brokers and perform mass operations on the service instances that the brokers created. These service broker errands include:

To run errands:

  1. For BOSH CLI v1 only: Select the broker deployment by running this command:
    bosh deployment BOSH_MANIFEST.yml

  2. Run one of the following commands depending on your Ops Manager version:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh run errand ERRAND_NAME
    1.11 bosh2 -d DEPLOYMENT_NAME run-errand ERRAND_NAME
    1.12 and later bosh -d DEPLOYMENT_NAME run-errand ERRAND_NAME


    Examples:
    bosh run errand deregister-broker
    bosh2 -d DEPLOYMENT-NAME run-errand deregister-broker

Register Broker

The register-broker errand registers the broker with Cloud Foundry and enables access to plans in the service catalog. Run this errand whenever the broker is re-deployed with new catalog metadata to update the Cloud Foundry catalog.

Plans with disabled service access are not visible to non-admin Cloud Foundry users (including Org Managers and Space Managers). Admin Cloud Foundry users can see all plans including those with disabled service access.

The errand does the following:

  • Registers the service broker with Cloud Controller.
  • Enables service access for any plans that have the radio button set to enabled in the tile plan page.
  • Disables service access for any plans that have the radio button set to disabled in the tile plan page.
  • Does nothing for any for any plans that have the radio button set to manual.

To run the errand, do the following:

  1. For BOSH CLI v1 only: Select the broker deployment by running this command:
    bosh deployment BOSH_MANIFEST.yml

  2. Run one of the following commands depending on your Ops Manager version:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh run errand register-broker
    1.11 bosh2 -d DEPLOYMENT-NAME run-errand register-broker
    1.12 and later bosh -d DEPLOYMENT-NAME run-errand register-broker

Deregister Broker

This errand deregisters a broker from Cloud Foundry.

The errand does the following:

  • Deletes the service broker from Cloud Controller
  • Fails if there are any service instances, with or without bindings

Use the Delete All Service Instances errand to delete any existing service instances.

To run the errand, do the following:

  1. For BOSH CLI v1 only: Select the broker deployment by running the command:
    bosh deployment BROKER_MANIFEST.yml.

  2. Run one of the following commands depending on your Ops Manager version:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh run errand deregister-broker
    1.11 bosh2 -d DEPLOYMENT-NAME run-errand deregister-broker
    1.12 and later bosh -d DEPLOYMENT-NAME run-errand deregister-broker

Upgrade All Service Instances

If you have made changes to the plan definition or uploaded a new tile into Ops Manager, you may want to upgrade all the Redis for PCF service instances to the latest software/plan definition.

The upgrade-all-service-instances errand does the following:

  • Collects all of the service instances the on-demand broker has registered.
  • For each instance the errand serially:
    • Issues an upgrade command to the on-demand broker.
    • Re-generates the service instance manifest based on its latest configuration from the tile.
    • Deploys the new manifest for the service instance.
    • Waits for this operation to complete, then proceeds to the next instance.
  • Adds to a retry list any instances that have ongoing BOSH tasks at the time of upgrade.
  • Retries any instances in the retry list until all are upgraded.

If any instance fails to upgrade, the errand fails immediately. This prevents systemic problems from spreading to the rest of your service instances. Run the errand by following either of the procedures below.

To run the errand, you can either select the errand through the Ops Manager UI and have it run when you click Apply Changes, or do the following:

  1. For BOSH CLI v1 only: Select the broker deployment by running this command:
    bosh deployment BOSH_MANIFEST.yml

  2. Run one of the following commands depending on your Ops Manager version:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh run errand upgrade-all-service-instances
    1.11 bosh2 -d DEPLOYMENT-NAME run-errand upgrade-all-service-instances
    1.12 and later bosh -d DEPLOYMENT-NAME run-errand upgrade-all-service-instances

Delete All Service Instances

This errand deletes all service instances of your broker’s service offering in every org and space of Cloud Foundry. It uses the Cloud Controller API to do this, and therefore only deletes instances the Cloud Controller knows about. It will not delete orphan BOSH deployments.

Orphan BOSH deployments don’t correspond to a known service instance. While rare, orphan deployments can occur. Use the orphan-deployments errand to identify them.

The errand does the following:

  • Unbinds all applications from the service instances.
  • Deletes all service instances sequentially.
  • Checks if any instances have been created while the errand was running.
  • If newly-created instances are detected, the errand fails.

WARNING: Use extreme caution when running this errand. You should only use it when you want to totally destroy all of the on-demand service instances in an environment.

To run the errand, do the following:

  1. For BOSH CLI v1 only: Select the broker deployment by running the command:
    bosh deployment BROKER_MANIFEST.yml.

  2. Run one of the following commands depending on your Ops Manager version:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh run errand delete-all-service-instances
    1.11 bosh2 -d service-instance_GUID delete-deployment
    1.12 and later bosh -d service-instance_GUID delete-deployment

Detect Orphaned Instances Service Instances

A service instance is defined as ‘orphaned’ when the BOSH deployment for the instance is still running, but the service is no longer registered in Cloud Foundry.

The orphan-deployments errand collates a list of service deployments that have no matching service instances in Cloud Foundry and return the list to the operator. It is then up to the operator to remove the orphaned BOSH deployments.

To run the errand, do the following:

  1. For BOSH CLI v1 only: Select the broker deployment by running the command:

    bosh deployment BROKER_MANIFEST.yml

  2. Run the errand using one of the following commands depending on your Ops Manager version:

    Ops Manager Version BOSH Command
    1.10 and earlier bosh run errand orphan-deployments
    1.11 bosh2 -d DEPLOYMENT-NAME run-errand orphan-deployments
    1.12 and later bosh -d DEPLOYMENT-NAME run-errand orphan-deployments

If orphan deployments exist, the errand script will:

  • Exit with exit code 10
  • Output a list of deployment names under a [stdout] header
  • Provide a detailed error message under a [stderr] header

For example:

[stdout]
[{"deployment_name":"service-instance_80e3c5a7-80be-49f0-8512-44840f3c4d1b"}]

[stderr] Orphan BOSH deployments detected with no corresponding service instance in Cloud Foundry. Before deleting any deployment it is recommended to verify the service instance no longer exists in Cloud Foundry and any data is safe to delete.

Errand 'orphan-deployments' completed with error (exit code 10)

These details will also be available through the BOSH /tasks/ API endpoint for use in scripting:

$ curl 'https://bosh-user:bosh-password@bosh-url:25555/tasks/task-id/output?type=result' | jq .
{
  "exit_code": 10,
  "stdout": "[{"deployment_name":"service-instance_80e3c5a7-80be-49f0-8512-44840f3c4d1b"}]\n",
  "stderr": "Orphan BOSH deployments detected with no corresponding service instance in Cloud Foundry. Before deleting any deployment it is recommended to verify the service instance no longer exists in Cloud Foundry and any data is safe to delete.\n",
  "logs": {
    "blobstore_id": "d830c4bf-8086-4bc2-8c1d-54d3a3c6d88d"
  }
}

If no orphan deployments exist, the errand script will:

  • Exit with exit code 0
  • Stdout will be an empty list of deployments
  • Stderr will be None
[stdout]
[]

[stderr]
None

Errand 'orphan-deployments' completed successfully (exit code 0)

If the errand encounters an error during running it will:

  • Exit with exit 1
  • Stdout will be empty
  • Any error messages will be under stderr

To clean up orphaned instances, run the following command on each instance:

WARNING: Running this command may leave IaaS resources in an unusable state.

Ops Manager Version BOSH Command
1.10 and earlier bosh delete deployment service-instance_SERVICE-INSTANCE-GUID
1.11 bosh2 delete-deployment service-instance_SERVICE-INSTANCE-GUID
1.12 and later bosh delete-deployment service-instance_SERVICE-INSTANCE-GUID

Select the BOSH Deployment for a Service Instance

This is an additional troubleshooting option for BOSH CLI v1 only. It does not apply to the BOSH CLI v2.

  1. Retrieve the GUID of your service instance with the 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 using the GUID you just obtained and a file name you want to use when saving the manifest.

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

Get Admin Credentials for a Service Instance

To retrieve the admin and read-only admin credentials for a service instance, perform the following steps:

  1. Identify the service deployment by GUID.
  2. Log into BOSH.
  3. Download the manifest for the service instance and add the GUID if using the BOSH CLI v1.

    Skip this step if you are using the BOSH CLI v2. You cannot download the manifest with the BOSH CLI v2. Open it in a text editor instead.

  4. Look in the manifest for the admin and roadmin credentials.

Reinstall a Tile

To reinstall a tile in the same environment where it was previously uninstalled:

  1. Ensure that the previous tile was correctly uninstalled as follows:
    1. Log in as an admin with cf login.
    2. Use cf m to confirm that the Marketplace does not list Redis for PCF.
    3. Depending on which version of the BOSH CLI you are using, follow one of the steps below to log in to BOSH as an admin:
      1. For BOSH CLI v2: Use bosh2 log-in.
      2. For BOSH CLI v1: Use bosh login.
    4. Depending on which version of the BOSH CLI you are using, follow one of the steps below to display your BOSH deployments to confirm that the output does not show a Redis for PCF deployment:
      1. For BOSH CLI v2: Use bosh2 deployments.
      2. For BOSH CLI v1: Use bosh deployments.
    5. Run the “delete-all-service-instances” errand to delete every instance of the service.
    6. Run the “deregister-broker” errand to delete the service broker.
    7. Depending on which version of the BOSH CLI you are using, follow one of the steps below:
      1. For BOSH CLI v2: Use bosh2 delete-deployment BROKER-DEPLOYMENT-NAME to delete the service broker BOSH deployment.
      2. For BOSH CLI v1: Use bosh delete deployment BROKER-DEPLOYMENT-NAME to delete the service broker BOSH deployment.
    8. Reinstall the tile.

View Resource Saturation and Scaling

BOSH CLI v2: Viewing statistics

To view usage statistics for any service do the following:

  1. For BOSH CLI v1 only: Select the broker deployment by running this command:
    bosh deployment BOSH_MANIFEST.yml

  2. Run the following commands depending on your Ops Manager version:

    Ops Manager Version BOSH Commands
    v1.10 and earlier Run the BOSH CLI v1 command bosh vms --vitals.
    To view process-level information, run bosh instances --ps.
    v1.11 Run the BOSH CLI v2 command bosh2 -d DEPLOYMENT-NAME vms --vitals. To view process-level information, run bosh2 -d DEPLOYMENT-NAME instances --ps
    v1.12 and later Run the BOSH CLI v2 command bosh -d DEPLOYMENT-NAME vms --vitals. To view process-level information, run bosh2 -d DEPLOYMENT-NAME instances --ps

Identify Service Instance Owner

If you want to identify which apps are using a specific service instance from the BOSH deployments name, you can run the following steps:

  1. Take the deployment name and strip the service-instance_ leaving you with the GUID.
  2. Log in to CF as an admin.
  3. Obtain a list of all service bindings by running the following: cf curl /v2/service_instances/GUID/service_bindings
  4. The output from the above curl gives you a list of resources, with each item referencing a service binding, which contains the APP-URL. To find the name, org, and space for the app, run the following:
    1. cf curl APP-URL and record the app name under entity.name
    2. cf curl SPACE-URL to obtain the space, using the entity.space_url from the above curl. Record the space name under entity.name
    3. cf curl ORGANIZATION-URL to obtain the org, using the entity.organization_url from the above curl. Record the organization name under entity.name

Note: When running cf curl ensure that you query all pages, because the responses are limited to a certain number of bindings per page. The default is 50. To find the next page curl the value under next_url

Monitor Quota Saturation and Service Instance Count

Quota saturation and total number of service instances are available through ODB metrics emitted to Loggregator. The metric names are shown below:

Metric Name Description
on-demand-broker/SERVICE-NAME-MARKETPLACE/quota_remaining global quota remaining for all instances across all plans
on-demand-broker/SERVICE-NAME-MARKETPLACE/PLAN-NAME/quota_remaining quota remaining for a particular plan
on-demand-broker/SERVICE-NAME-MARKETPLACE/total_instances total instances created across all plans
on-demand-broker/SERVICE-NAME-MARKETPLACE/PLAN-NAME/total_instances total instances created for a given plan

Note: Quota metrics are not emitted if no quota has been set.

Knowledge Base Articles

The following are Pivotal Knowledge Base articles about Redis for PCF:

Other Issues

Error Failed to target Cloud Foundry
Cause Your Pivotal Cloud Foundry is unresponsive
Solution Examine the detailed error message in the logs and check the PCF Troubleshooting Guide for advice
Error Failed to bind Redis service instance to test app
Cause Your deployment’s broker has not been registered with Pivotal Cloud Foundry
Solution Examine the broker-registrar installation step output and troubleshoot any problems.
Create a pull request or raise an issue on the source for this page in GitHub