https://github.com/dhiaayachi/dynx

Dynamic Docker friendly gateway
https://github.com/dhiaayachi/dynx

lua nginx openresty redis upstream

Last synced: 3 months ago
JSON representation

Dynamic Docker friendly gateway

• Host: GitHub
• URL: https://github.com/dhiaayachi/dynx
• Owner: dhiaayachi
• License: apache-2.0
• Created: 2017-07-18T19:28:18.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-17T22:04:32.000Z (almost 7 years ago)
• Last Synced: 2024-07-18T14:42:33.287Z (4 months ago)
• Topics: lua, nginx, openresty, redis, upstream
• Language: Lua
• Homepage:
• Size: 71.3 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# dynx

[![Build Status](https://travis-ci.org/dhiaayachi/dynx.svg?branch=master)](https://travis-ci.org/dhiaayachi/dynx)

[![Coverage Status](https://coveralls.io/repos/github/dhiaayachi/dynx/badge.svg?branch=master)](https://coveralls.io/github/dhiaayachi/dynx?branch=master)

Dynamic Docker friendly gateway  

The purpose of the project is to provide a dynamically configurable gateway that is easilly deployable in a docker swarm enviroment.

### Requirements:

- Offer dynamic routing 

- configurable through an easy to use rest api

- No down time to relad configuration

- configuration should be shared by all the nodes but no context is shared between nodes (No node to node communication)

- ...

### Current solution:

The current solution use openresty (NGINX based scriptable gateway) with a redis as a Database. It's based on dns

The NGINX have 2 servers configured:

- server listening on 8888 is for configuration and is used to push an upstream to a redis List ( the key is the desired location/API)

- server listening on 8666 have a wildcard location that will execute a lua (rewrite) script to find the upstream, based on the path 

  and rewrite it to the configured upstream

The current solution is based on https://github.com/tes/lua-resty-router

  

### TODO

- Update the README to add a demo and how to deploy

- ~~Add the ability to remove a location~~

- Add the ability to configure multiple upstream for one location (load balancing)

- ~~Add a pipeling with tests (specially for LUA scripting)~~

- Add the ability to delete all locations

- ~~Add unit test framework for the lua libraries~~

- Write documentation with examples and use cases

- Add swagger documentation for the API

- Add an etcd backend support

- Add regex support for upstream

- ...

 # Join the team 

 Do you want to collaborate? Join the project at https://crowdforge.io/projects/261