vishnudxb / redis-cluster

Github action for running a redis cluster for your workflow

Redis Cluster GitHub Action

This GitHub Action sets up Redis cluster with 3 master and 3 slave in a single container for your testing purpose.

The image used is from https://hub.docker.com/r/vishnunair/docker-redis-cluster

Usage

See action.yml

Basic:

steps:
- uses: vishnudxb/redis-cluster@1.0.9
  with:
    master1-port: 5000
    master2-port: 5001
    master3-port: 5002
    slave1-port: 5003
    slave2-port: 5004
    slave3-port: 5005
    sleep-duration: 5 # Define the sleep duration for docker to start and ready for accepting connections (Here we set default to 5seconds)

Sample usage in github action job:

jobs:
  setup-build-publish-deploy:
    name: Run tests
    runs-on: ubuntu-latest
    steps:
    - name: Checkout
      uses: actions/checkout@v2
      with:
        token: ${{ secrets.GITHUB_TOKEN }}
        submodules: true

    - name: Test redis cluster
      uses: vishnudxb/redis-cluster@1.0.9
      with:
        master1-port: 5000
        master2-port: 5001
        master3-port: 5002
        slave1-port: 5003
        slave2-port: 5004
        slave3-port: 5005
        sleep-duration: 5

     # Running Test
    - name: Running Test
      run: |
         sudo apt-get install -y redis-tools
         docker ps -a
         redis-cli -h 127.0.0.1 -p 5000 ping
         redis-cli -h 127.0.0.1 -p 5000 cluster nodes

You can see the Output something like below from the Github action log:

License

The scripts and documentation in this project are released under the MIT License