Skip to content

cf-redis-broker job from cf-redis/411

Github source: c085efa5 or master branch

Properties

cf

apps_domain

Domain shared by the UAA and CF API eg ‘10.244.0.34.xip.io’

nats

host

Hostname/IP of NATS

password

The password to use when authenticating with NATS

port

Port that NATS listens on

username

The user to use when authenticating with NATS

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
https://s3.amazonaws.com
path

Path within the above bucket to which backups will be uploaded

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
dedicated_vm_plan_id

Dedicated-VM plan id displayed in the catalog metadata

Default
74E8984C-5F8C-11E4-86BE-07807B3B2589
name

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

Default
redis
network

The name of the network that the redis broker runs on.

process_check_interval

Interval in seconds between checks for dead processes

Default
10
service_id

Service id displayed in the catalog metadata

Default
EEA47C3A-569C-4C24-869D-0ADB5B337A4C
service_instance_limit

The maximum number of instances allowed

service_name

Service name displayed in the catalog metadata

Default
p-redis
shared_vm_plan_id

Shared-VM plan id displayed in the catalog metadata

Default
C210CA06-E7E5-4F5D-A5AA-7A2C51CC290E
start_redis_timeout

Maximum wait time in seconds for Redis to start up

Default
600

client_timeout

Close the connection after a client is idle for N seconds (0 to disable)

Default
0

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

databases

Set the number of databases. The default database is DB 0.

Default
16

log_directory

The directory which stores the redis server logs

Default
/var/vcap/sys/log/redis

log_level

Specify the server log verbosity level (debug, verbose, notice, warning)

Default
notice

lua_time_limit

Max execution time of a Lua script in milliseconds.

Default
5000

maxmemory

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

Default
5.24288e+08

replication

repl_disable_tcp_nodelay

Set TCP_NODELAY on the slave socket after SYNC.

Default
"no"
slave_priority

The slave priority is an integer number published by Redis in the INFO output. It is used by Redis Sentinel in order to select a slave to promote into a master if the master is no longer working correctly.

Default
100
slave_read_only

Configure a slave instance to accept writes or not.

Default
"yes"
slave_serve_stale_data

Master-Slave replication. Use slaveof to make a Redis instance a copy of another Redis server.

Default
"yes"

save_command

The name of the obfuscated redis SAVE command.

Default
""

slow_log

log_slower_than

the execution time, in microseconds, to exceed in order for the command to get logged

Default
10000
max_len

The length of the slow log. There is no limit to this length. Just be aware that it will consume memory. You can reclaim memory used by the slow log with SLOWLOG RESET.

Default
128

snapshotting

rdb_checksum

RDB files created with checksum disabled have a checksum of zero that will tell the loading code to skip the check.

Default
"yes"
rdb_compression

Compress string objects using LZF when dump .rdb databases

Default
"yes"
save

save ; Will save the DB if both the given number of seconds and the given number of write operations against the DB occurred.

Default
  - 900 1
  - 300 10
  - 60 10000
stop_writes_on_bgsave_error

This will make the user aware (in an hard way) that data is not persisting on disk properly

Default
"yes"

statefile_path

Path to the broker statefile

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

tcp_keep_alive

TCP keepalive

Default
0

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)
  • bin/route-registrar_ctl (from route-registrar_ctl)
  • config/backup.yml (from backup.yml.erb)
  • config/broker.yml (from broker.yml.erb)
  • config/nginx.conf (from nginx.conf.erb)
  • config/redis.conf (from redis.conf.erb)
  • config/registrar_settings.yml (from registrar_settings.yml.erb)
  • config/restore.yml (from restore.yml.erb)

Packages

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