This repository has been archived by the owner. It is now read-only.
Convox Praxis: A framework for modern application infrastructure.
Go Other
Switch branches/tags
20170831124901 20170831105449 20170828120224 20170828113857 20170828113602 20170828113302 20170828102025 20170816105924 20170816100405 20170816094807 20170801191448 20170801151142 20170801143209 20170801135207 20170801104136 20170731162929 20170727110712 20170725144836 20170725123054 20170725122007 20170725121111 20170725111219 20170725110245 20170725104912 20170725092318 20170721154707 20170721142204 20170721094315 20170720082526 20170720075209 20170718195348 20170718192849 20170718130435 20170718123809 20170714115812 20170713155416 20170713124206 20170711112338 20170711073537 20170710145140 20170710114359 20170710104857 20170710101149 20170707230635 20170707173709 20170707172341 20170707171446 20170707165343 20170707164202 20170707160516 20170707131455 20170707105824 20170706104937 20170705192404 20170705145547 20170705142640 20170705131001 20170705123219 20170704091928 20170704064654 20170704062546 20170704055532 20170704055252 20170704053622 20170704053214 20170704051105 20170703133603 20170703124332 20170703104621 20170703093700 20170703092742 20170630113518 20170629141435 20170629122732 20170628170448 20170628134831 20170627171306 20170627171043 20170627140317 20170627134712 20170627133157 20170627080714 20170626160220 20170626144513 20170623171030 20170623095520 20170623095040 20170622183515 20170621182047 20170621131230 20170620210151 20170620192207 20170619220540 20170619220131 20170619203254 20170619201609 20170619200733 20170619200441 20170619194407 20170619190554
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci
api
bin
cache
changes
cmd
cycle
docs
helpers
logger
manifest
mocks
provider
router
sdk/rack local resource streaming updated Jul 21, 2017
server
stdcli
types
vendor
.dockerignore
.gitignore
Dockerfile
Makefile
README.md
REGIONS
codecov.yml
convox.yml

README.md

Convox Praxis

A framework for modern application infrastructure.

QUICKSTART

Getting Started with Convox Praxis

ABOUT

Praxis allows you to specify the entire infrastructure for your application using simple primitives.

caches:
  sessions:
    expire: 1d
keys:
  master:
    roll: 30d
queues:
  mail:
    timeout: 1m
services:
  web:
    build: .
    port: 3000
    scale: 2-10
timers:
  cleanup:
    schedule: 0 3 * * *
    command: bin/cleanup
    service: web

API

Praxis makes these primitives available to your application with a simple API.

# list applications
GET /apps

# put an item on a queue
POST /apps/myapp/queues/mail

# get an item from a queue
GET /apps/myapp/queues/mail

# encrypt some data
POST /apps/myapp/keys/master/encrypt

Rack

A Rack is the substrate for running Praxis applications and exposes the Praxis API both externally to management tools and operators and internally to the applications themselves.

Praxis Racks are currently available for the following environments:

Local

Runs on your laptop (or any single node). Great for development and CI.

AWS

A fault-tolerant, highly scalable architecture built on modern AWS services such as ECS, ALB, and Lambda.

INSTALLATION

CLI

MacOS

$ curl https://s3.amazonaws.com/praxis-releases/cli/darwin/cx -o /usr/local/bin/cx
$ chmod +x /usr/local/bin/cx

Linux

$ curl https://s3.amazonaws.com/praxis-releases/cli/linux/cx -o /usr/local/bin/cx
$ chmod +x /usr/local/bin/cx

Rack

Local

$ sudo cx rack install local
Local Rack installation requires sudo to resolve and route local hostnames such as myapp-web.convox

AWS

$ cx rack install aws

DEPLOY

Create a convox.yml

TODO: Reference Docs

See the convox.yml and the examples/ subdirectory of this project.

Create an application

$ cx apps create myapp

Set environment variables

$ cx env set FOO=bar

Deploy the application

$ cx deploy

UPDATING

Your local CLI will automatically keep itself up to date.

You can update an installed Rack using cx rack update.

COPYRIGHT

Convox, Inc. 2017

LICENSE

Apache License, v2.0