All Projects → tsuru → redisapi

tsuru / redisapi

Licence: BSD-3-Clause license
Redis service API for tsuru PaaS.

Programming Languages

python
139335 projects - #7 most used programming language

#redisapi

Build Status

This API exposes a Redis service to application developers using tsuru PaaS.

##Installation

The redisapi uses mongodb to store data about redis instances, and uses docker to spawn redis instances.

To install the api, all you need is a machine with python and pip installed. Clone the redisapi, cd into the created directory and then run:

pip install -r requirements.txt

##Configuration

This API is ready to be deployed as a tsuru application. It depends on the following environment variables:

  • REDIS_SERVER_HOST: the address of the server to which the API will provide access. Default value: none. redisapi will fail to start if this variable is not defined.
  • REDIS_SERVER_PORT: port used to connect to the Redis server. Default value: 6379.
  • REDIS_SERVER_PASSWORD: password used to connect to the Redis server. Default value: none. When undefined, access will be unauthenticated. For more details, check "Authentication feature" at http://redis.io/topics/security.
  • REDIS_PUBLIC_HOST: the public hosts that apps will use to connect to the redis server. This may be useful in the cases where you have a public and a private IP, the private IP is used by the API to manage the server, and the public API is delivered to apps whenever tsuru binds it to a service instance. Default value: the value of $REDIS_SERVER_HOST.

##Healthchecker

The redisapi has a module that creates healthcheckers for the redis instances created by the api. By default the healthchecker is disabled. To enable it you should set the environment variable HEALTH_CHECKER with the name of monitoring tool that you wants to use. Currently only zabbix is supported.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].