5cb58cb303
Change-Id: I8f6b0fea655858a2521e104811e6ccf72dfb5c09 |
||
---|---|---|
doc | ||
docker | ||
etc | ||
poppy | ||
requirements | ||
scripts | ||
tests | ||
.coveragerc | ||
.gitignore | ||
.gitreview | ||
AUTHORS.rst | ||
HACKING.rst | ||
LICENSE | ||
MANIFEST.in | ||
openstack-common.conf | ||
pylintrc | ||
README.rst | ||
setup.cfg | ||
setup.py | ||
tox.ini |
Poppy
CDN Provider Management as a Service
Note: This is a work in progress and is not currently recommended for production use.
What is Poppy ============
Users have come to expect exceptional speed in their applications, websites, and video experiences. Because of this, using a CDN has become standard for companies, no matter their size.
Poppy will take all the guess work out of the CDN market for our users. Poppy will give them a consistently speedy experience from integrated partners, with an easy to use RESTful API.
Vendor lock-in to a particular CDN provider is removed by abstracting away the plethora of vendor API's available. This means that a customer only has to integrate with one CDN API, and reap the benefits of using multiple providers.
Your content can be distributed to multiple providers seamlessly instead of just one.
Running performance benchmarks against each configured CDN provider allows you to simply repoint your DNS at the new provider; and with that simple change you can ensure your application is running using the fastest provider at the time. It will also allow you to handle CDN failures and minimize disruption to your application from CDN outages.
Features
- Wraps third party CDN provider API's
-
- Fastly (http://www.fastly.com)
- Amazon CloudFront
- MaxCDN
- Your CDN Here...
- Sends configurations to n configured CDN providers
- Supports multiple backends (CassandraDB recommended)
-
- CassandraDB
- Your DB provider here
- Openstack Compatable
-
- Uses Keystone for authentication
- Multiple Origins to pull from (including Rackspace Cloud Files)
- Supports Multiple Domains
- Custom Caching and TTL rules
- Set Restrictions on who can access cached content
What Poppy is not
Poppy does not run its own Edge Cache or POP servers. This is purely a management API to abstract away the myriad of CDN providers on the market.
Getting Started
Note: These instructions are for running a local instance of CDN and not all of these steps are required. It is assumed you have CassandraDB installed and running.
From your home folder create the
~/.poppy
folder and clone the repo:$ cd $ mkdir .poppy $ git clone https://github.com/rackerlabs/cdn.git
Copy the Poppy config files to the directory
~/.poppy
:$ cp poppy/etc/poppy.conf ~/.poppy/poppy.conf $ cp poppy/etc/logging.conf ~/.poppy/logging.conf
Find the
[drivers:storage:cassandradb]
section in~/.poppy/poppy.conf
and modify the URI to point to your local casssandra cluster:[drivers:storage:cassandra] cluster = "localhost" keyspace = poppy
By using cassandra storage plugin, you will need to create the default keyspace "poppy" on your cassandra host/cluster. So log into cqlsh, do:
cqlsh> CREATE KEYSPACE poppy WITH REPLICATION = { 'class' : 'SimpleStrategy' , 'replication_factor' : 1} ;
For logging, find the
[DEFAULT]
section in~/.poppy/poppy.conf
and modify as desired:log_file = server.log
Change directories back to your local copy of the repo:
$ cd poppy
Install general requirements:
$ pip install -r requirements/requirements.txt
Install Requirements for each Provider configured:
$ pip install -r poppy/providers/fastly/requirements.txt
Run the following so you can see the results of any changes you make to the code without having to reinstall the package each time:
$ pip install -e .
Start the Poppy server:
$ poppy-server
Test out that Poppy is working by requesting the home doc (with a sample project ID):
$ curl -i -X GET http://0.0.0.0:8888/v1.0/123
You should get an HTTP 200 along with some headers that will look similar to this:
HTTP/1.0 200 OK
Date: Thu, 13 Feb 2014 14:34:21 GMT
Server: WSGIServer/0.1 Python/2.7.3
Content-Length: 464
Content-Type: application/json-home
Cache-Control: max-age=86400
To run unit/functional test:
$ tox
To run a full test suite with api test, you will need to put in
correct CDN vendor configuration (in ~/.poppy/poppy.conf
)
first, e.g:
[drivers:provider:fastly]
apikey = "<your_fastly_api_key>"
Then start a poppy server:
$ poppy-server -v
And run test suite with api test::
$ tox -- --exclude=none
Installing Cassandra Locally
Mac OSX
Update your Java SDK to the latest version (v7+):
http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
You can check the version currently running with:
$java -version
Follow the instructions on the datastax site to install cassandra for Mac OSX:
http://www.datastax.com/2012/01/working-with-apache-cassandra-on-mac-os-x
Create a Keyspace with Replication:
CREATE KEYSPACE poppy WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 1 };
Import the Cassandra Schema to set up the required tables that CDN will need:
Open ./cqlsh and import the /poppy/storage/cassandra/schema.cql file
Running tests
First install the additional requirements:
$ pip install tox
And then run tests:
$ tox