cf_redis_broker

Documentation

Index

• type Auth
• type Backups
• type Broker
• type Cf
• type CfRedisBrokerJob
• type Nats
• type Redis
• type Replication
• type SlowLog
• type Snapshotting

Types

type Auth

type Auth struct {

	/*Password - Descr: The password for HTTP Basic Auth on the Broker, also used for the agent Default: admin
	 */
	Password interface{} `yaml:"password,omitempty"`

	/*Username - Descr: The username for HTTP Basic Auth on the Broker, also used for the agent Default: admin
	 */
	Username interface{} `yaml:"username,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Backups

type Backups struct {

	/*EndpointUrl - Descr: HTTP(S) endpoint of the S3-compatible blob store that backups will be uploaded to Default: https://s3.amazonaws.com
	 */
	EndpointUrl interface{} `yaml:"endpoint_url,omitempty"`

	/*RestoreAvailable - Descr: Makes the backup restore binary available Default: true
	 */
	RestoreAvailable interface{} `yaml:"restore_available,omitempty"`

	/*AccessKeyId - Descr: Access Key ID for the S3-compatible blob store that backups will be uploaded to Default:
	 */
	AccessKeyId interface{} `yaml:"access_key_id,omitempty"`

	/*BucketName - Descr: Name of the bucket into which backups will be uploaded Default:
	 */
	BucketName interface{} `yaml:"bucket_name,omitempty"`

	/*SecretAccessKey - Descr: Secret Access Key for the S3-compatible blob store that backups will be uploaded to Default:
	 */
	SecretAccessKey interface{} `yaml:"secret_access_key,omitempty"`

	/*Path - Descr: Path within the above bucket to which backups will be uploaded Default:
	 */
	Path interface{} `yaml:"path,omitempty"`

	/*BgSaveTimeout - Descr: Timeout in seconds for Redis background save to complete when backing up instance Default: 3600
	 */
	BgSaveTimeout interface{} `yaml:"bg_save_timeout,omitempty"`

	/*BackupTmpDir - Descr: Temporary directory to use for backups. MUST be on same device (persistent disk) as redis data Default: /var/vcap/store/tmp_backup
	 */
	BackupTmpDir interface{} `yaml:"backup_tmp_dir,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Broker

type Broker struct {

	/*BackendPort - Descr: The port for the broker unicorn process to run on Default: 10005
	 */
	BackendPort interface{} `yaml:"backend_port,omitempty"`

	/*Network - Descr: The name of the network that the redis broker runs on. Default: <nil>
	 */
	Network interface{} `yaml:"network,omitempty"`

	/*DedicatedNodes - Descr: List of node IPs for the dedicated plan Default: []
	 */
	DedicatedNodes interface{} `yaml:"dedicated_nodes,omitempty"`

	/*Name - Descr: Name of the broker, to be used in cf commandline operations and by the broker-registrar Default: redis
	 */
	Name interface{} `yaml:"name,omitempty"`

	/*ProcessCheckInterval - Descr: Interval in seconds between checks for dead processes Default: 10
	 */
	ProcessCheckInterval interface{} `yaml:"process_check_interval,omitempty"`

	/*DedicatedVmPlanId - Descr: Dedicated-VM plan id displayed in the catalog metadata Default: 74E8984C-5F8C-11E4-86BE-07807B3B2589
	 */
	DedicatedVmPlanId interface{} `yaml:"dedicated_vm_plan_id,omitempty"`

	/*ServiceInstanceLimit - Descr: The maximum number of instances allowed Default: <nil>
	 */
	ServiceInstanceLimit interface{} `yaml:"service_instance_limit,omitempty"`

	/*Backups - Descr: Temporary directory to use for backups. MUST be on same device (persistent disk) as redis data Default: /var/vcap/store/tmp_backup
	 */
	Backups *Backups `yaml:"backups,omitempty"`

	/*DedicatedPort - Descr: The port used by the redis instances Default: 6379
	 */
	DedicatedPort interface{} `yaml:"dedicated_port,omitempty"`

	/*BackendHost - Descr: The port for the broker unicorn process to run on Default: localhost
	 */
	BackendHost interface{} `yaml:"backend_host,omitempty"`

	/*Subdomain - Descr: Subdomain for route registrar Default: redis-broker
	 */
	Subdomain interface{} `yaml:"subdomain,omitempty"`

	/*StartRedisTimeout - Descr: Maximum wait time in seconds for Redis to start up Default: 600
	 */
	StartRedisTimeout interface{} `yaml:"start_redis_timeout,omitempty"`

	/*Auth - Descr: The username for HTTP Basic Auth on the Broker, also used for the agent Default: admin
	 */
	Auth *Auth `yaml:"auth,omitempty"`

	/*SharedVmPlanId - Descr: Shared-VM plan id displayed in the catalog metadata Default: C210CA06-E7E5-4F5D-A5AA-7A2C51CC290E
	 */
	SharedVmPlanId interface{} `yaml:"shared_vm_plan_id,omitempty"`

	/*ServiceName - Descr: Service name displayed in the catalog metadata Default: p-redis
	 */
	ServiceName interface{} `yaml:"service_name,omitempty"`

	/*ServiceId - Descr: Service id displayed in the catalog metadata Default: EEA47C3A-569C-4C24-869D-0ADB5B337A4C
	 */
	ServiceId interface{} `yaml:"service_id,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Cf

type Cf struct {

	/*Nats - Descr: The password to use when authenticating with NATS Default: <nil>
	 */
	Nats *Nats `yaml:"nats,omitempty"`

	/*AppsDomain - Descr: Domain shared by the UAA and CF API eg 'bosh-lite.com' Default: <nil>
	 */
	AppsDomain interface{} `yaml:"apps_domain,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type CfRedisBrokerJob

type CfRedisBrokerJob struct {

	/*Redis - Descr: Set TCP_NODELAY on the slave socket after SYNC. Default: no
	 */
	Redis *Redis `yaml:"redis,omitempty"`

	/*Cf - Descr: The password to use when authenticating with NATS Default: <nil>
	 */
	Cf *Cf `yaml:"cf,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Nats

type Nats struct {

	/*Username - Descr: The user to use when authenticating with NATS Default: <nil>
	 */
	Username interface{} `yaml:"username,omitempty"`

	/*Port - Descr: Port that NATS listens on Default: <nil>
	 */
	Port interface{} `yaml:"port,omitempty"`

	/*Host - Descr: Hostname/IP of NATS Default: <nil>
	 */
	Host interface{} `yaml:"host,omitempty"`

	/*Password - Descr: The password to use when authenticating with NATS Default: <nil>
	 */
	Password interface{} `yaml:"password,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Redis

type Redis struct {

	/*Replication - Descr: Set TCP_NODELAY on the slave socket after SYNC. Default: no
	 */
	Replication *Replication `yaml:"replication,omitempty"`

	/*TcpKeepAlive - Descr: TCP keepalive Default: 0
	 */
	TcpKeepAlive interface{} `yaml:"tcp_keep_alive,omitempty"`

	/*DataDirectory - Descr: The directory which stores the persisted broker data Default: /var/vcap/store/cf-redis-broker/redis-data
	 */
	DataDirectory interface{} `yaml:"data_directory,omitempty"`

	/*ClientTimeout - Descr: Close the connection after a client is idle for N seconds (0 to disable) Default: 0
	 */
	ClientTimeout interface{} `yaml:"client_timeout,omitempty"`

	/*ConfPath - Descr: The shared conf file for all Redis instances Default: /var/vcap/jobs/cf-redis-broker/config/redis.conf
	 */
	ConfPath interface{} `yaml:"conf_path,omitempty"`

	/*Broker - Descr: Temporary directory to use for backups. MUST be on same device (persistent disk) as redis data Default: /var/vcap/store/tmp_backup
	 */
	Broker *Broker `yaml:"broker,omitempty"`

	/*Snapshotting - Descr: save <seconds> <changes>; 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]
	 */
	Snapshotting *Snapshotting `yaml:"snapshotting,omitempty"`

	/*BgSaveCommand - Descr: The name of the obfuscated redis BGSAVE command. Default:
	 */
	BgSaveCommand interface{} `yaml:"bg_save_command,omitempty"`

	/*Databases - Descr: Set the number of databases. The default database is DB 0. Default: 16
	 */
	Databases interface{} `yaml:"databases,omitempty"`

	/*LogDirectory - Descr: The directory which stores the redis server logs Default: /var/vcap/sys/log/redis
	 */
	LogDirectory interface{} `yaml:"log_directory,omitempty"`

	/*SlowLog - Descr: the execution time, in microseconds, to exceed in order for the command to get logged Default: 10000
	 */
	SlowLog *SlowLog `yaml:"slow_log,omitempty"`

	/*ConfigCommand - Descr: The name of the obfuscated redis CONFIG command. Default: <nil>
	 */
	ConfigCommand interface{} `yaml:"config_command,omitempty"`

	/*Maxmemory - Descr: The maximum memory (in bytes) that Redis will use before evicting old data Default: 524288000
	 */
	Maxmemory interface{} `yaml:"maxmemory,omitempty"`

	/*StatefilePath - Descr: Path to the broker statefile Default: /var/vcap/store/cf-redis-broker/statefile.json
	 */
	StatefilePath interface{} `yaml:"statefile_path,omitempty"`

	/*LogLevel - Descr: Specify the server log verbosity level (debug, verbose, notice, warning) Default: notice
	 */
	LogLevel interface{} `yaml:"log_level,omitempty"`

	/*LuaTimeLimit - Descr: Max execution time of a Lua script in milliseconds. Default: 5000
	 */
	LuaTimeLimit interface{} `yaml:"lua_time_limit,omitempty"`

	/*SaveCommand - Descr: The name of the obfuscated redis SAVE command. Default:
	 */
	SaveCommand interface{} `yaml:"save_command,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Replication

type Replication struct {

	/*SlaveServeStaleData - Descr: Master-Slave replication. Use slaveof to make a Redis instance a copy of another Redis server. Default: yes
	 */
	SlaveServeStaleData interface{} `yaml:"slave_serve_stale_data,omitempty"`

	/*SlavePriority - Descr: 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
	 */
	SlavePriority interface{} `yaml:"slave_priority,omitempty"`

	/*SlaveReadOnly - Descr: Configure a slave instance to accept writes or not. Default: yes
	 */
	SlaveReadOnly interface{} `yaml:"slave_read_only,omitempty"`

	/*ReplDisableTcpNodelay - Descr: Set TCP_NODELAY on the slave socket after SYNC. Default: no
	 */
	ReplDisableTcpNodelay interface{} `yaml:"repl_disable_tcp_nodelay,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type SlowLog

type SlowLog struct {

	/*LogSlowerThan - Descr: the execution time, in microseconds, to exceed in order for the command to get logged Default: 10000
	 */
	LogSlowerThan interface{} `yaml:"log_slower_than,omitempty"`

	/*MaxLen - Descr: 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
	 */
	MaxLen interface{} `yaml:"max_len,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!

type Snapshotting

type Snapshotting struct {

	/*RdbCompression - Descr: Compress string objects using LZF when dump .rdb databases Default: yes
	 */
	RdbCompression interface{} `yaml:"rdb_compression,omitempty"`

	/*StopWritesOnBgsaveError - Descr: This will make the user aware (in an hard way) that data is not persisting on disk properly Default: yes
	 */
	StopWritesOnBgsaveError interface{} `yaml:"stop_writes_on_bgsave_error,omitempty"`

	/*RdbChecksum - Descr: RDB files created with checksum disabled have a checksum of zero that will tell the loading code to skip the check. Default: yes
	 */
	RdbChecksum interface{} `yaml:"rdb_checksum,omitempty"`

	/*Save - Descr: save <seconds> <changes>; 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]
	 */
	Save interface{} `yaml:"save,omitempty"`
}

* File Generated by enaml generator * !!! Please do not edit this file !!!