This topic describes how to use Redis Enterprise Software (RS) for Pivotal Platform.

Creating a Redis Enterprise Database instance via cf CLI and service broker using service plans

  1. Perform 'cf login' to your foundation.

  2. Run the cf create-service redislabs [SERVICE PLAN] [SERVICE INSTANCE] where SERVICE PLAN uses one of the available Redis Enterprise service plans and SERVICE INSTANCE is the new service instance name.

    For example:

    # cf create-service redislabs small-redis redis2
    Creating service instance redis2 in org RedisLabs  space space1 as admin...
    OK

Available service plans are listed in either:

  • The tile's Ops Manager configuration, under Settings > Service Plans:

    Import button

  • Apps Manager > Marketplace screen.

    Import button

Creating a Redis Enterprise Database instance via Pivotal Platform Apps Manager

  1. From Pivotal Platform Apps Manager go to Marketplace and select Redis Enterprise on Pivotal Platform.

    Import button

  2. Select a plan from the available plans listed and click Select This Plan.

    Import button

  3. Write an instance name and optionally choose to bind to a deployed app then click Create.

    Import button Import button

Accessing the Redis Enterprise Cluster UI

  1. Connect to the Redis Enterprise Admin Console by placing the Cluster Management Console Subdomain in the host part of the following URL: https://[Cluster Management Console Subdomain].[System Domain].

    For example: https://console-redis.sys.my-domain.cf-app.com

  2. Log in using the Administrator email account and password you specified in the tile configuration above.

    Note -
    Do not create or delete databases through the Redis Enterprise Cluster UI. Use the cf creates/delete/update-service commands or use the Pivotal Apps Manager web UI to create and manage databases through available plans.

Installing a License Key in an Existing Cluster

  1. Connect to the Redis Enterprise UI per the instructions above.

  2. Log in using the Administrator email account and password you specified in the tile configuration.

  3. Navigate to the Settings section and then the General tab.

    Import button

  4. Paste the license key you received from Redis Labs into the Cluster key form field and click the Save button.

    Note -
    In case your license is already expired, changes to the cluster configuration, such as a version upgrade, will result in cluster failure. Always apply a valid license key in advance of making such changes.

Connect to Redis Database Using redis-cli

redis-cli is a simple command-line tool for interacting with Redis Database.

To connect to Redis Database, do the following:

  1. Connect to one of the IP addresses of the nodes through SSH and find redis-cli under /opt/redislabs/bin/redis-cli.

  2. Change to the /opt/redislabs/bin directory and run redis-cli to connect to port 12000 and to the database-endpoint that is reported in the database properties after you created the database.

    sudo /opt/redislabs/bin/redis-cli -p 12000 -h database-endpoint
  3. To store and retrieve a key in database1, run the following commands:

    set key1 123
    get key1

For example:

127.0.0.1:16653> set key1 123

OK

127.0.0.1:16653> get key1

"123"

For information about Redis Enterprise, see the Redis Enterprise documentation.