Skip to content

Commit 6244a03

Browse files
committed
Update README.md
1 parent f381f6e commit 6244a03

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
11
# api-gateway-config-supervisor
22
Syncs config files from Amazon S3, Google Drive, Dropbox, Amazon Cloud Drive reloading the gateway with the updates
3+
4+
Table of Contents
5+
=================
6+
7+
* [Status](#status)
8+
* [Quick Start](#quick-start)
9+
* [Dependencies](#dependencies)
10+
* [Developer Guide](#developer-guide)
11+
12+
Status
13+
======
14+
This module is in design phase at the moment.
15+
16+
Quick Start
17+
============
18+
This module should be executed alongside the gateway in order to keep track of the configuration files and reload the gateway when there is a change.
19+
20+
It should expose a simple REST API for the API Gateway to check during health-checks so that in case this modules fails, the gateway may also appear unhealthy.
21+
22+
Dependencies
23+
============
24+
To be reviewed:
25+
* https://gowalker.org/github.com/ncw/rclone
26+
* TBD
27+
28+
Developer guide
29+
===============
30+
TBD

0 commit comments

Comments
 (0)