Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blacksmith-community/redis-forge-boshrelease
A Blacksmith Forge for deploying dedicated standalone and clustered Redis instances
https://github.com/blacksmith-community/redis-forge-boshrelease
bosh forge redis
Last synced: 5 days ago
JSON representation
A Blacksmith Forge for deploying dedicated standalone and clustered Redis instances
- Host: GitHub
- URL: https://github.com/blacksmith-community/redis-forge-boshrelease
- Owner: blacksmith-community
- License: mit
- Created: 2016-05-26T20:25:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-07-26T23:41:06.000Z (2 months ago)
- Last Synced: 2024-07-27T00:36:29.139Z (2 months ago)
- Topics: bosh, forge, redis
- Language: Shell
- Homepage:
- Size: 318 KB
- Stars: 2
- Watchers: 9
- Forks: 11
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Blacksmith Redis Forge
This Blacksmith Forge teaches a [Blacksmith Broker][broker] how to
deploy standalone and clustered [Redis][redis] service
deployments, which are useful for caching, persistent key-value
store, and distributed lock management.
## Deploying
To deploy this forge, you will need to add it to your existing
Blacksmith Broker manifest deployment, co-locating the
`redis-blacksmith-plans` job on the Blacksmith instance group.
Here's an example to get you started (clipped for brevity):
```yaml
releases:
- name: redis-forge
version: latest
instance_groups:
- name: blacksmith
jobs:
- name: redis-blacksmith-plans
release: redis-forge
properties:
plans:
# your plans here
# (see below)
```
The Redis Forge deploys redis by using jobs that are found
_inside_ the `redis-forge` BOSH release, which means that your
Blacksmith BOSH director also needs that release. Blacksmith is
able to upload that release for you, if you want.
For the Spruce users out there:
```
---
instance_groups:
- name: blacksmith
jobs:
- name: blacksmith
properties:
releases:
- (( append ))
- (( grab releases.redis-forge ))
```
Finally, you'll need to define plans for Blacksmith to deploy.
The following sections discuss those ad nauseum.
## Standalone Topology
The `standalone` topology is as straightforward as they come: a
singe dedicated VM that runs redis bound on all interfaces, to
port 6379. If TLS is enabled it will bind to port 16379.
Here's a diagram to clear things up:
### Configuration Options
- *vm_type* - The name of a BOSH `vm_type` from your cloud-config.
You can use this to size your Redis appropriate to your workload
requirements, in terms of RAM and CPU. Increasing the disk size
via the VM type is not going to net you much of a gain (see
the `disk_size`, `disk_type`, and `persist` options instead.
- *azs* - An array of BOSH availability zone names (per cloud-config),
for your standalone node placement. Deployed VMs will be
randomly distributed across these AZs. By default, all nodes will
be put in `z1`.
- *network* - The name of the network to deply these instances to.
This network should be defined in your cloud-config, and should
be large enough to handle your anticipated service footprint.
It does not need any static IP addresses.
By default, VMs will be deployed into a network named
`redis-service`.
- *persist* - Whether or not the data stored in this Redis
instance should be written to disk or not. If you are just
implementing a cache service using Redis, you don't need to
specify this (or `disk_size`) -- by default this topology is
diskless.
Persistent Redis instances use the append-only format (AOF),
storing the file in `/var/vcap/store/standalone/redis.aof`. The
AOF file is fsync'd once every second to balance safety with
performance.
- *disk_size* - If you specify `persist` to get a durable key-value
store, you can also specify this configuration value to change
the size of the persistent disk. By default, you get a 1G disk.
- *disk_type* - If you specify `persist` to get a durable key-value
store, you can also specify this configuration value to change
the persistent disk type. If both _disk_ and _disk_type_ are
defined, the _disk_ configuration value will be ignored.
### Example Configuration
A single standalone plan, persistent, with 4G of disk:
```
instance_groups:
- name: blacksmith
jobs:
- name: redis-blacksmith-plans
release: redis-forge
properties:
plans:
single-4g:
type: standalone
persist: true
disk_size: 4_096
```
Here's a configuration that provides two different sizes of
persistent standalone, as well as a large (per cloud-config)
non-persistent cache service:
```
instance_groups:
- name: blacksmith
jobs:
- name: redis-blacksmith-plans
release: redis-forge
properties:
plans:
small:
type: standalone
persist: true
disk_size: 4_096
large:
type: standalone
persist: true
disk_size: 16_384
cache:
type: standalone
```
## Clustered Topology
The `cluster` topology shards the Redis key hash space across _M_
masters, each with _R_ replicas. It provides fault tolerance,
with optional (but highly encouraged) striping across BOSH
availability zones.
Here's a diagram, showing a _M=2, R=2_ configuration:
We can refer to this as a _2x2_ setup, 2 masters, with 2 replicas
each, for a total of 6 VMs. The first master (in purple) will
handle hash slots 0-8191, and the second master (in blue) takes
slots 8192-16382. Each pair of replicas contain a complete copy
of the hash slots its master is responsible for.
In the event of failure of a master, one of its replicas will
promote to a master, ensuring consistent cluster operations.
Clustered nodes do not persist their data to disk; instead they
rely on replication to ensure durability of the data.
### Configuration Options
- *vm_type* - The name of a BOSH `vm_type` from your cloud-config.
You can use this to size your Redis appropriate to your workload
requirements, in terms of RAM and CPU.
- *azs* - A list of BOSH availability zone names (per
cloud-config), across which to stripe the nodes. By default,
nodes will be put in `z1` and `z2`.
- *network* - The name of the network to deply these instances to.
This network should be defined in your cloud-config, and should
be large enough to handle your anticipated service footprint.
It does not need any static IP addresses.
By default, VMs will be deployed into a network named
`redis-service`.
- *masters* - How many Redis Master instances to spin. Must be at
least 1. There is no default.
- *replicas* - How many Redis Replica instances to provision for
each Redis Master. Must be at least 1, which is the default.
Normally, you only need 1-3 replicas, depending on your
tolerance for data loss.
## Example Configuration
Here's the configuration for the 6-VM 2x2 cluster pictured in the
topology digram above:
```
instance_groups:
- name: blacksmith
jobs:
- name: redis-blacksmith-plans
release: redis-forge
properties:
plans:
clustered:
type: cluster
masters: 2
replicas: 2
```
Here, we provide two different clustered configurations, one with
wide sharding but shallow replication (4x1), and another 3-node
minimal cluster on very large (per cloud-config) VMs.
```
instance_groups:
- name: blacksmith
jobs:
- name: redis-blacksmith-plans
release: redis-forge
properties:
plans:
clustered-4x1:
type: cluster
masters: 4
replicas: 1
minimal:
type: cluster
vm_type: very-large
masters: 1
replicas: 2
```
## Redis Hard Coded Redis Configuration Parameters
For security reasons the following Redis commands have been disabled in all plan types.
1. DEBUG
1. CONFIG
1. SHUTDOWN
1. SYNC
1. SLAVEOF
## Redis Configuration Plan Parameters
These Redis configuration parameters can be used when plans are created during forge deployment.
Some of these parameters may dependent on other parameters or plan model properties.
| Parameter | Description | Default | Notes |
| --------- | ----------- | ------- | ----- |
| auth.password | The password required of clients wishing to use this Redis instance. | | |
| persistent | Whether or not the Redis dataset should persist to disk (via AOF semantics) | true | |
| lua_scripting_enabled | Whether or not to allow lua scripting. | true | |
| client_connections | Set the max number of connected clients at the same time | 10000 | |
| client_timeout | Close the connection after a client is idle for N seconds | 0 | 0 = disable |
| client_tcpkeepalive | If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence of communication | 300 | |
| redis_maxmemory | Set a memory usage limit to the specified amount of bytes. | 0 | 0 = VM limit |
| redis_maxmemory-policy | Sets the behavior Redis follows when maxmemory is reached. | allkeys-lru, |allkeys-lru, noeviction,
volatile-lru, allkeys-random,
volatile-ttl, volatile-lfu,
allkeys-lfu |
| redis_notify-keyspace-events | Sets the keyspace notifications for events that affect the Redis data set | "" | |
| redis_slowlog-log-slower-than | Sets the threshhold execution time (seconds). Commands that exceed this execution time are added to the slowlog.| 10000 | |
| redis_slowlog-max-len | Sets the length (count) of the slowlog queue. | 128 | |
| redis_no-appendfsync-on-rewrite | If you have latency problems turn this to true. Otherwise leave it as false | false | This parameter has significance only if the *persistent* parameter is set true. |
| redis_auto-aof-rewrite-percentage | Modify the percentage for auto append on rewrite. | 100 | This parameter has significance only if the *persistent* parameter is set true. |
| redis_auto-aof-rewrite-min-size: | Modify the minimum file size for auto append on rewrite. | 64mb | This parameter has significance only if the *persistent* parameter is set true. |
| exporter | If set to true, a Prometheus redis_exporter will be colocated on the Redis nodes | false |
Memory units may be specified when specifying bytes.
1k => 1000 bytes
1kb => 1024 bytes
1m => 1000000 bytes
1mb => 1024\*1024 bytes
1g => 1000000000 bytes
1gb => 1024\*1024\*1024 bytes
units are case insensitive so 1GB 1Gb 1gB are all the same.
## CF Create Service Configuration Parameters
App developers can customize the following parameters. See the [Redis documentation](https://redis.io/topics/config) for more detail. In particular, look at the self documented redis.conf file for your deployed Redis version.
| Property | Default | Options | Description |
|-----------------------------|---------|---------| ----------- |
| **maxmemory-policy** | *allkeys-lru* | allkeys-lru, noeviction,
volatile-lru,
allkeys-random,
volatile-ttl,
volatile-lfu,
allkeys-lfu | Sets the behavior Redis follows when *maxmemory* is reached. Please see the [redis.conf][2] for their brief definitions.|
| **notify-keyspace-events** | “” | Set a combination of the following characters
(e.g., *“Elg”*):
K, E, g, $, l, s, h, z, x, e, A | Sets the keyspace notifications for events that affect the Redis data set. Please see the [redis.conf][2] file for their succinct definitions. |
| **slowlog-log-slower-than** | 10000 | 0-20000 | Sets the threshhold execution time (seconds). Commands that exceed this execution time are added to the slowlog. |
| **slowlog-max-len** | 128 | 1-2024 | Sets the length (count) of the slowlog queue.|
## Forge Maintainer Notes
### Upgrading Redis Releases
1. Remember to use the s3 folder 'redis' when adding a new Redis tarbal.
example: `bosh add-blob ~/Downloads/redis-5.0.12.tar.gz redis/redis-5.0.12.tar.gz`
1. Remember to remove the previous redis blob before creating a final release through the pipeline
example: `bosh remove-blob redis/redis-5.0.10.tar.gz`
1. Create a release tarball for testing purposes. You will need the --version the first time you create a
development release
example `bosh create-release --name=redis-forge --version=0.4.7+dev.1 --tarball=/tmp/redis-forge.tar.gz --force`
1. Get the private.yml for the S3 bucket from someone in the know. The file goes into the 'config' directory.
Now you can use bosh to upload the blob to S3.
1. Add the 'release_notes.md' to the ci directory.
## Contributing
If you find a bug, please raise a [Github Issue][1] first,
before submitting a PR.
[1]: https://github.com/blacksmith-community/redis-forge-boshrelease/issues
[2]: https://raw.githubusercontent.com/redis/redis/5.0/redis.conf
[broker]: https://github.com/cloudfoundry-community/blacksmith
[redis]: https://redis.io