Skip to content

cf-redis-broker job from cf-redis/306

Github source: 694a1b0c or master branch

Properties

redis

bg_save_command

The name of the obfuscated redis BGSAVE command.

Default
""

broker

auth
password

The password for HTTP Basic Auth on the Broker, also used for the agent

Default
admin
username

The username for HTTP Basic Auth on the Broker, also used for the agent

Default
admin
backend_host

The port for the broker unicorn process to run on

Default
localhost
backend_port

The port for the broker unicorn process to run on

Default
10005
backups
access_key_id

Access Key ID for the S3-compatible blob store that backups will be uploaded to

Default
""
bg_save_timeout

Timeout in seconds for Redis background save to complete when backing up instance

Default
3600
bucket_name

Name of the bucket into which backups will be uploaded

Default
""
endpoint_url

HTTP(S) endpoint of the S3-compatible blob store that backups will be uploaded to

Default
""
path

Path within the above bucket to which backups will be uploaded

Default
""
s3_region

S3 region for the S3-compatible blob store that backups will be uploaded to

Default
""
secret_access_key

Secret Access Key for the S3-compatible blob store that backups will be uploaded to

Default
""
dedicated_nodes

List of node IPs for the dedicated plan

Default
[]
dedicated_port

The port used by the redis instances

Default
6379
name

Name of the broker, to be used in cf commandline operations and by the broker-registrar

Default
redis
process_check_interval

Interval in seconds between checks for dead processes

Default
10
service_instance_limit

The maximum number of instances allowed

ssl
cert

SSL Certificate for broker (PEM encoded)

key

SSL private key for broker (PEM encoded)

start_redis_timeout

Maximum wait time in seconds for Redis to start up

Default
10

conf_path

The shared conf file for all Redis instances

Default
/var/vcap/jobs/cf-redis-broker/config/redis.conf

config_command

The name of the obfuscated redis CONFIG command.

data_directory

The directory which stores the persisted broker data

Default
/var/vcap/store/cf-redis-broker/redis-data

host

This host which the Redis server runs on

log_directory

The directory which stores the redis server logs

Default
/var/vcap/sys/log/redis

maxmemory

The maximum memory (in bytes) that Redis will use before evicting old data

Default
5.24288e+08

save_command

The name of the obfuscated redis SAVE command.

Default
""

statefile_path

Path to the broker statefile

Default
/var/vcap/store/cf-redis-broker/statefile.json

Templates

Templates are rendered and placed onto corresponding instances during the deployment process. This job's templates will be placed into /var/vcap/jobs/cf-redis-broker/ directory (learn more).

  • bin/cf-redis-broker_ctl (from cf-redis-broker_ctl.erb)
  • bin/drain (from drain.sh)
  • bin/nginx_ctl (from nginx_ctl.erb)
  • bin/process-watcher_ctl (from process-watcher_ctl.erb)
  • config/broker.yml (from broker.yml.erb)
  • config/nginx.conf (from nginx.conf.erb)
  • config/redis.conf (from redis.conf.erb)
  • config/ssl/cf-redis-broker.key (from cf-redis-broker.key.erb)
  • config/ssl/cf-redis-broker.pem (from cf-redis-broker.pem.erb)

Packages

Packages are compiled and placed onto corresponding instances during the deployment process. Packages will be placed into /var/vcap/packages/ directory.