A modular, vendor-neutral API, that wraps provisioning instructions for all CDN vendors that support it.
Go to file
Jenkins 3c99426bea Merge "CGI escape random erroring message" 2015-06-03 21:14:16 +00:00
doc Workflow documentation is now in infra-manual 2014-12-05 03:30:46 +00:00
docker Added Zookeeper to fig config 2015-03-30 13:45:00 -04:00
etc fix: change cassandra schema migration consistency level: LOCAL_QUORUM 2015-04-28 16:50:01 -04:00
poppy Merge "CGI escape random erroring message" 2015-06-03 21:14:16 +00:00
requirements Changes from nose to testr 2015-05-26 15:20:03 -04:00
scripts Merge "Added credentials for CCU api" 2015-04-24 15:44:11 +00:00
tests Merge "Makes sure that origin and domain cannot be same" 2015-06-02 18:41:53 +00:00
tools Changes from nose to testr 2015-05-26 15:20:03 -04:00
.coveragerc Create Service 2014-09-26 17:07:19 -04:00
.gitignore Changes from nose to testr 2015-05-26 15:20:03 -04:00
.gitreview Add .gitreview file. 2014-08-13 10:49:54 -04:00
.testr.conf Changes from nose to testr 2015-05-26 15:20:03 -04:00
AUTHORS.rst updated Authors list 2014-07-14 16:49:29 -04:00
HACKING.rst updated tests to use poppy 2014-08-07 13:16:46 -04:00
LICENSE Initial commit 2014-02-12 08:30:06 -08:00
MANIFEST.in Initial Commit 2014-02-12 11:33:37 -05:00
README.rst Add cassandra schema migration framework 2015-02-27 13:41:10 -05:00
openstack-common.conf renamed cdn references in code to poppy 2014-08-07 11:01:11 -04:00
pylintrc Add pylintrc options for better pylint reporting 2015-03-09 15:04:56 -04:00
run_tests.sh Changes from nose to testr 2015-05-26 15:20:03 -04:00
setup.cfg Updates pbr version to 2015.1 2015-05-04 10:02:34 -04:00
setup.py Fixes bugs missing session keyword and cassandra ordered dict 2014-12-22 13:50:35 -05:00
tox.ini Changes from nose to testr 2015-05-26 15:20:03 -04:00

README.rst

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
  • 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.

  1. From your home folder create the ~/.poppy folder and clone the repo:

    $ cd
    $ mkdir .poppy
    $ git clone https://github.com/stackforge/poppy.git
  2. 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
  3. 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
    migrations_path = /home/poppy/poppy/storage/cassandra/migrations
  4. 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}  ;
  5. For logging, find the [DEFAULT] section in ~/.poppy/poppy.conf and modify as desired:

    log_file = server.log
  6. Change directories back to your local copy of the repo:

    $ cd poppy
  7. 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 .
  8. Install and start zookeeper driver:

    http://zookeeper.apache.org/doc/trunk/zookeeperStarted.html
    
    or more easily use a zookeeper docker:
    
    https://registry.hub.docker.com/u/jplock/zookeeper/
  9. Start poppy task flow worker:

    $ poppy-worker
  10. Start the Poppy server:

    $ poppy-server
  11. 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
  1. 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

  1. 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
  2. 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
  3. Create a Keyspace with Replication:

    CREATE KEYSPACE poppy WITH REPLICATION = { 'class' : 'SimpleStrategy', 'replication_factor' : 1 };
  4. 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