This topic gives you reference information about the Google Redis service (csb-google-redis). It details the plans, configuration parameters, and binding credentials.
Caution The Google Redis service offering is currently in beta and is intended for evaluation and test purposes only. Do not use this product in a production environment.
The table below lists the plans for Google Redis:
Plan | Description |
---|---|
basic | A basic plan with no failover. Data will be lost on maintenance or cluster changes. |
ha | A highly available plan with automatic failover. |
When configuring Cloud Service Broker for GCP you can add additional plans. For how to configure plans, see Configure Services with Cloud Service Broker for GCP.
The following table lists parameters which can only be configured for additional plans:
Parameter Name | Values | Default |
---|---|---|
name * |
The plan name | n/a |
id * |
A unique GUID | n/a |
description * |
Description of the new plan | n/a |
service_tier * |
The service tier of the instance - BASIC or STANDARD_HA | n/a |
display_name |
Name to use when displaying plan in marketplace | n/a |
free |
When false, Service Instances of this Service Plan have a cost | true |
bindable |
Specifies whether Service Instances of the Service Plan can bind to applications | true |
plan_updateable |
Whether the Plan supports upgrade/downgrade/sidegrade to another version | true |
* Required
You can also add any of the configuration parameters listed in the parameters section to your plan.
Note If you set a parameter at plan level, developers cannot change the value when creating or updating service instances.
You can provision a service by running:
cf create-service csb-google-redis PLAN-NAME SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
You can update the configuration parameters for a service instance by running:
cf update-service SERVICE-INSTANCE-NAME -c '{"PARAMETER-NAME": "PARAMETER-VALUE"}'
The following table lists the parameters that you can configure, by using the -c
flag, when provisioning a csb-google-redis service:
Parameter Name | Type | Description | Default | Operation |
---|---|---|---|---|
display_name |
string | The display name of the Redis instance. | INSTANCE-ID |
provision and update |
memory_size_gb |
integer | The size of the instance in gigabytes, 1–300. | 4 |
provision and update |
instance_id |
string | Permanent identifier for your instance. | csb-INSTANCE-ID |
provision and update |
region |
string | The region of the Redis instance. | us-central1 |
provision and update |
authorized_network |
string | The name of the Google Compute Engine network to which the instance is connected. | default |
provision |
authorized_network_id |
string | The ID of the Google Compute Engine network to which the instance is connected. | "" |
provision |
reserved_ip_range |
string | The range of IP addresses reserved for this instance. | "" |
provision |
credentials |
string | The GCP credentials. | The value the operator entered for Credentials in Ops Manager. | provision and update |
project |
string | The GCP project to use. | The value the operator entered for Project in Ops Manager. | provision and update |
You can bind a service by running:
cf bind-service APP-NAME SERVICE-INSTANCE --binding-name BINDING-NAME
The format for binding credentials for Google Redis is as follows:
{
"host" : "INSTANCE-HOST",
"port" : "INSTANCE-PORT",
"memory_size_gb" : "INSTANCE-SIZE-GB",
"service_tier" : "SERVICE-TIER",
"redis_version" : "REDIS-VERSION"
}