Skip to content

[WIP] Add the Ability to use Redis for Storage #85

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 15 commits into from
Closed

[WIP] Add the Ability to use Redis for Storage #85

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
a755576
Adding ExternalStore implementation
pseudomuto Sep 30, 2016
0ac02d9
DRYing out the tests
pseudomuto Sep 30, 2016
3c28591
Add --storage-command option for using external storage
pseudomuto Sep 30, 2016
63f2a77
Update README with details about external storage
pseudomuto Sep 30, 2016
f251f45
Lint fixes
pseudomuto Sep 30, 2016
3beaf58
make each implementation it's own module
pseudomuto Oct 1, 2016
f95f120
Add redis implementation
pseudomuto Oct 1, 2016
f2adccf
Remove external script storage type
pseudomuto Oct 1, 2016
94bb611
Adding storage-provider options and updating README
pseudomuto Oct 2, 2016
f143f16
Make redis an regular dependency
pseudomuto Oct 3, 2016
b385007
Update README to be more clear
pseudomuto Oct 3, 2016
efc7679
Ensure last_activity is read/written correctly
pseudomuto Oct 3, 2016
23b66d3
Support for closest matching prefix for redis
pseudomuto Oct 3, 2016
07bfe07
Add redis errors to the log
pseudomuto Oct 3, 2016
d1c3a1a
Fix issue with getTarget('/')
pseudomuto Oct 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,3 +248,26 @@ first part of the URL path, e.g.:
"/otherdomain.biz": "http://10.0.1.4:5555",
}
```

## Using External Storage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: I'll have more detail after Min and Kyle's reviews.

## Route table and external storage (optional)

With the default configuration,  configurable-http-proxy (CHP) places the route table in the local process' memory.

If you would like to use external storage for the route table, i.e. redis, memcached, mysql, and others, you may specify an executable to use external storage. You would:


By default CHP uses memory in the local process for storing the route table. If you'd prefer to use an external storage
mechanism, like redis, memcached, mysql, etc. You can specify an executable to be used instead, by passing the path to
your script in the `--storage-command` option.

To do this, you'll need to ensure that the script is both accessible on the path and executable. The script should
support the following API, where `<path>` is the incoming request path and `<base64_json>` is a base64 encoded JSON
object.

```
$ /path/to/script get <path>
$ /path/to/script get_all
$ /path/to/script add <path> <base64_json>
$ /path/to/script update <path> <base64_json>
$ /path/to/script remove <path>
$ /path/to/script exists <path>
```

For an example, check out [the script] we use for testing this functionality.

[the script]: https://github.com/jupyterhub/configurable-http-proxy/blob/master/test/support/external_store