Name: node-rproxy
Owner: racker
Description: A reverse proxy for RESTful services
Created: 2012-04-19 20:22:17.0
Updated: 2016-07-18 18:14:45.0
Pushed: 2013-05-21 00:39:24.0
Size: 4408
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
A reverse proxy for RESTful services.
Middleware is a node module which exposes a single method and acts on a request or a response. There are two types of middleware:
Note: Currently response middleware is only limited to modifying the response headers.
Configuration is stored in a JSON format in a file. Example configuration can
be found in example/config.json.
host - listen address for the reverse proxy serverport - listen port for the reverse proxy serverworkers - number of workers processes to use. Defaults to the number of
available CPUs.host - listen address for the admin API serverport - listen port for the admin API serverkey - API key used for authentication which must be provided in the
x-api-key header.host - listen address for the proxy targetport - listen port for the proxy targetmiddleware_run_list - an object with two keys:request - an array of middleware to run for every requestresponse - an array of middleware to run for every responseA list of special headers which are added to every request by rproxy before proxying it to the backend server.
X-RP-Request-Id - Unique ID associated with a request. This ID can be used
to map and track the request between rproxy and the backend server.This ID can be used to track and map requests between rproxy and backend server even when tracing middleware is not used.
This middleware parses a user tenant id from the URL or a header called X-Tenant-Id
and puts it on the request object.
tenant_id_regex - regular expression which is used for parsing tenant id
from the request URL. If not provided it defaults to /\/(\d+)\/?/.This middleware authenticates a user against the Keystone API.
It expects authentication token to be provided in the header with the name
X-Auth-Token or in the query string with the name x-auth-token.
Unless ?skip-auth-cache query string is provided, token is stored in the cache
until it expires.
username - admin username for the Keystone auth serverpassword - admin password for the Keystone auth serverurls - an array of Kesystone API URLs to hit in parallel when
authenticating a user. Authentication is be considered as successful if at
least one URL returns a success. By default this array contains URL for US and
UK Keystone server.whitelist - A list of paths which don't require authenticationNR-1000 - missing X-Tenant-Id headerNR-1001 - missing X-Auth-Token headerNR-1002 - invalid or expired auth tokenNR-5000 - something unexpected has happenedThis middleware provides flexible rate limiting based on the requested paths.
bucket_size - Size of a bucket in seconds. This value also specifies a
minimum time period you can rate limit on.limits - An array of limit objects. Each object has the following keys:method - HTTP method of the limited pathpath_regex - Regular expression for the rate limited pathlimit - Request limit for this pathperiod - Period in seconds. This value can't be smaller than
bucket_sizeview_path - Special path which, when hit will sent current user limits to the
backend using a POST requestview_backend_path - Path on the backend where the users limits are sent to
when user hits view_path on the proxy.NR-2000 - rate limit has been reachedThis middleware intercepts special usage headers returned by the backend and sends usage events to an Atom Hopper instance.
url - Atom Hopper instance URLservice_name - Name of the serviceregion - Service region or globaldatacenter - Service datacenter or globalThis middleware removes headers with the specified prefix from the response.
This middleware integrated wits Zipkin distributed tracing. It supports submitting traces to a remote RESTkin endpoint.
For more information about tracing, please have a look at the Node tracing client called https://github.com/racker/node-tryfer.
Note: This middleware is special, because if enabled, it integrates with other middleware such as authentication and rate limiting.
service_name_prefix - Prefix which is prepended in front of the service nameignored_headers - A list of request header names which are stripped from the
from the request header object which is stored as an annotation on the trace
object.authentication.url - URL to the Keystone authentication endpoint which is used
to obtain the token which is then used to authenticate against the RESTkin API.authentication.username - API username.authentication.apiKey - API key.restkin.url - URL to the RESTkin HTTP endpointThis middleware propagates parent trace ID in the request header called
x-b3-traceid to the backend server.
This ID can be used by the backend server to attach other child traces to it.
By default tests are automatically run on every commit on Travis-ci. You can view the build status at http://travis-ci.org/#!/racker/node-rproxy.
If you want to run them locally you need to have either Redis or Cassandra (or both) installed.
npm run-script lint
DB_BACKEND=redis REDIS_HOME=<path to the directory containg redis-server binary> npm run-script test
DB_BACKEND=cassandra CASSANDRA_HOME=<path to the directory containg cassandra binary> CASSANDRA_CONF=<path to cassandra configuration> npm run-script test
Sample configurations for Cassandra 1.1 and 1.2 are kept in tests/conf/cass-1.1 and tests/cass/cass-1.2.
You are welcome to use them during development, or you can specify your own configuration.
By default, Travis-CI runs all tests against Cassandra 1.1.