Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
shcorya authored Jan 6, 2024
1 parent a08466e commit db954d9
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,32 @@
# Keyes

[![Docker image size](https://img.shields.io/docker/image-size/stevecorya/keyes?style=flat-square)](https://hub.docker.com/r/stevecorya/keyes)
[![Docker image size](https://img.shields.io/docker/image-size/coryaent/krause?style=flat-square)](https://hub.docker.com/r/coryaent/krause)

Keyes allows one to easily setup an eventually consistent, highly available, Redis-compatible datastore.
Krause allows one to easily setup an eventually consistent, highly available, Redis-compatible datastore.

## Overview
[KeyDB](https://keydb.dev/) is a fork of [Redis](https://redis.io/) which strives to maintain 100% [compatibility](https://docs.keydb.dev/docs/compatibility/) with the Redis wire protocol. Keyes is a script which assists with running KeyDB on multiple nodes within Docker Swarm by adding automatic discovery to KeyDB.

Keyes enables automatic discovery by querying Swarm's DNS server for a lookup of ```tasks.<service-name>.```

In terms of CAP theorem, keyes is available and partition tolerant. It is not gaurenteed to be consistent.
Krause enables automatic discovery by querying Swarm's DNS server for a lookup of ```tasks.<service-name>.```

## Example
```bash
docker network create --opt encrypted --driver overlay --attachable keydb
```
```yaml
version: '3.8'

services:
master:
image: stevecorya/keyes
image: coryaent/krause
environment:
- SERVICE_NAME={{.Service.Name}}
networks:
- keydb
deploy:
mode: global
replicas: 6
placement:
max_replicas_per_node: 1

networks:
keydb:
Expand Down

0 comments on commit db954d9

Please sign in to comment.