A modular, vendor-neutral API, that wraps provisioning instructions for all CDN vendors that support it.
Go to file
tonytan4ever 110aff8d78 fix: null provider_service_id when DNS failed
Change-Id: Idc1cd078961d683406b4f08eb4727169f691e569
2016-01-08 16:18:45 -05:00
doc Change repositories from stackforge to openstack 2015-10-26 14:58:43 -04:00
docker End To End tests for multiple origin 2015-11-10 12:43:29 -05:00
etc feat: default automatic C* schema migration to false in request 2015-10-12 14:03:38 -04:00
hadoop feat: add log delivery pig script 2015-06-12 11:39:45 -04:00
poppy fix: null provider_service_id when DNS failed 2016-01-08 16:18:45 -05:00
requirements dependency: add netifaces 2015-12-07 16:08:38 -05:00
scripts Add spsId when upserting SAN info 2015-10-25 20:18:54 -04:00
tests fix: null provider_service_id when DNS failed 2016-01-08 16:18:45 -05: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 feat: Delete SSL Cert endpoint 2015-10-23 10:08:54 -04:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:35:01 +00:00
.testr.conf Changes from nose to testr 2015-05-26 15:20:03 -04:00
AUTHORS.rst Implements: Health check with UUIDs 2015-11-10 09:46:08 -05: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 Change repositories from stackforge to openstack 2015-10-26 14:58:43 -04:00
kill_poppy.sh Added Docker Files to mimic third party API's 2015-08-04 15:12:34 -04: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_poppy.sh Fixed issue where referrer domains were not validated 2015-09-01 15:42:15 -04:00
run_tests.sh Changes from nose to testr 2015-05-26 15:20:03 -04:00
setup.cfg remove python 2.6 trove classifier 2015-12-23 01:31:14 +00:00
setup.py Pin pbr to 0.11.0: Jenkins build process will install pbr first and then build wheel file. The working version is 0.11.0 2015-08-04 17:07:58 -04:00
tox.ini Merge "Put py34 first in the env order of tox" 2016-01-08 16:33:56 +00:00

README.rst

Poppy

CDN as a Service

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
    • Akamai (Production Ready)
    • Fastly (In Development)
    • Amazon CloudFront (In Development)
    • MaxCDN (In Development)
    • Your CDN Here...
  • Sends configurations to n configured CDN providers
  • Supports multiple backends (CassandraDB recommended)
    • CassandraDB
    • Your DB provider here
  • Supports multiple dns providers
    • Rackspace DNS
    • Openstack Designate (Coming Soon)
  • Openstack Compatable
    • Uses Keystone for authentication
    • Uses Swift for log delivery
  • Multiple Origins to pull from (Public Servers, Amazon S3 Buckets, ...)
  • 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 and Zookeeper installed and running in a Docker Container.

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

    $ cd
    $ mkdir .poppy
    $ git clone https://github.com/openstack/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 = <docker ip>
    keyspace = poppy
    migrations_path = /home/poppy/poppy/storage/cassandra/migrations
    automatic_schema_migration = True     #True is recommended for local dev machine
  4. For logging, find the [DEFAULT] section in ~/.poppy/poppy.conf and modify as desired:

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

    $ cd poppy
  6. Install general requirements:

    $ pip install -r requirements/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 .

To install additional dependencies, see Additional Dependencies.

  1. Install and start cassandra and zookeeper driver:

    $ pip install docker-compose
    $ docker-compose -f docker/compose/dependencies.yml up -d
  2. Start poppy task flow worker:

    $ poppy-worker
  3. Start the Poppy server:

    $ poppy-server
  4. Test out that Poppy is working by requesting the home doc (with a sample project ID):

    $ curl -i -X GET -H "X-Project-ID: 000" -H "X-Auth-Token: 000" -H "Content-Type: application/json" http://127.0.0.1:8888/v1.0/

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

Additional Dependencies

Ubuntu 14.04

For Python 2.7:

$ sudo apt-get install python-dev

For Python 3.4:

$ sudo apt-get install python3.4-dev

For PyPy:

$ sudo apt-get install pypy-dev

Install these two packages regardless of the Python version:

$ sudo apt-get install libffi6 libffi-dev

$ sudo apt-get install libssl-dev

Installing Cassandra and Zookeeper Locally

We recommend running Cassandra and Zookeeper in a docker container when developing locally.

Follow the instuctions in the /poppy/docker/compose/README.md file for running Poppy locally.

Running tests

First install the additional requirements:

$ pip install tox

And then run tests:

$ tox