Create a Replicated Redis Statefulset on Kubernetes, powered by the cdk8s project
Disclaimer
This construct is under heavy development, and breaking changes will be introduced very often. Please don't forget to version lock your code if you are using this construct.
Overview
cdk8s-redis-sts is a cdk8s library.
import { Construct } from 'constructs';
import { App, Chart, ChartProps } from 'cdk8s';
import { MyRedis } from '@opencdk8s/cdk8s-redis-sts';
export class MyChart extends Chart {
constructor(scope: Construct, id: string, props: ChartProps = { }) {
super(scope, id, props);
new MyRedis(this, 'dev', {
image: 'redis',
namespace: 'databases',
volumeSize: '10Gi',
replicas: 2,
createStorageClass: true,
volumeProvisioner: 'kubernetes.io/aws-ebs',
storageClassName: "io1-slow",
storageClassParams: {
type: 'io1',
fsType: 'ext4',
iopsPerGB: "10",
},
});
}
}
const app = new App();
new MyChart(app, 'dev');
app.synth();
Then the Kubernetes manifests created by cdk8s synth
command will have Kubernetes resources such as Statefulset
, ConfigMap
and Service
as follows.
manifest.k8s.yaml
allowVolumeExpansion: true
apiVersion: storage.k8s.io/v1
kind: StorageClass
metadata:
name: io1-slow
parameters:
fsType: ext4
iopsPerGB: "10"
type: io1
provisioner: kubernetes.io/aws-ebs
reclaimPolicy: Retain
---
apiVersion: v1
data:
master.conf: |-
bind 0.0.0.0
daemonize no
port 6379
tcp-backlog 511
timeout 0
tcp-keepalive 300
supervised no
slave.conf: |-
slaveof dev 6379
kind: ConfigMap
metadata:
name: dev-redis-conf
---
apiVersion: v1
kind: Service
metadata:
labels:
app: dev
name: dev
namespace: databases
spec:
ports:
- port: 6379
targetPort: 6379
selector:
app: dev
type: ClusterIP
---
apiVersion: apps/v1
kind: StatefulSet
metadata:
labels:
app: dev
name: dev
namespace: databases
spec:
replicas: 2
selector:
matchLabels:
app: dev
serviceName: dev
template:
metadata:
labels:
app: dev
spec:
containers:
- command:
- bash
- -c
- |-
[[ `hostname` =~ -([0-9]+)$ ]] || exit 1
ordinal=${BASH_REMATCH[1]}
if [[ $ordinal -eq 0 ]]; then
redis-server /mnt/redis/master.conf
else
redis-server /mnt/redis/slave.conf
fi
env: []
image: redis
name: redis
ports:
- containerPort: 6379
resources:
limits:
cpu: 400m
memory: 512Mi
requests:
cpu: 200m
memory: 256Mi
volumeMounts:
- mountPath: /data
name: dev
- mountPath: /mnt/redis/
name: dev-redis-conf
terminationGracePeriodSeconds: 10
volumes:
- configMap:
name: dev-redis-conf
name: dev-redis-conf
volumeClaimTemplates:
- metadata:
name: dev
namespace: databases
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 10Gi
storageClassName: io1-slow
Installation
TypeScript
Use yarn
or npm
to install.
$ npm install @opencdk8s/cdk8s-redis-sts
$ yarn add @opencdk8s/cdk8s-redis-sts
Python
$ pip install cdk8s-redis-sts
Contribution
-
Fork (link)
-
Bootstrap the repo:
npx projen # generates package.json yarn install # installs dependencies
-
Development scripts:
Command Description yarn compile
Compiles typescript => javascript yarn watch
Watch & compile yarn test
Run unit test & linter through jest yarn test -u
Update jest snapshots yarn run package
Creates a dist
with packages for all languages.yarn build
Compile + test + package yarn bump
Bump version (with changelog) based on [conventional commits] yarn release
Bump + push to master
-
Create a feature branch
-
Commit your changes
-
Rebase your local changes against the master branch
-
Create a new Pull Request (use conventional commits for the title please)