convox / docs

Convox Documentation

Convox

Convox is an open-source PaaS based on Kubernetes available for multiple cloud providers.

Supported Clouds

• Amazon Web Services
• Digital Ocean
• Google Cloud
• Microsoft Azure

Getting Started

• Introduction

Installation

• Command Line Interface
• Development Rack
• Production Rack

Features

• Release Management
• Secrets Management
• Load Balancing (automatic SSL)
• Service Discovery
• Resource Management (Postgres, Redis, etc)
• Automated Rollbacks
• Autoscaling
• Scheduled Runs (cron)
• One-off Commands

Resources

• Homepage
• Stack Overflow

Development Tips

When testing new changes, a good way of adding them to a test rack is to build the image locally,push to a public repo and update the k8s deployment api:

docker build -t user/convox:tag .
docker push user/convox:tag
kubectl set image deploy api system=user/convox:tag -n rackName-system

If testing new changes in terraform, install the rack using the following command to have the /terraform folder mapped to the rack tf manifest.

/convox: CONVOX_TERRAFORM_SOURCE=$PWD//terraform/system/%s convox rack install aws rack1

After saving your changes, go to (Linux:~/.config/convox/racks/rack1 or OSX:/System/Volumes/Data/Users/$PROFILENAME/Library/Preferences/convox/racks and run terraform apply

License

• Apache 2.0

docs's Issues

Broken links to CircleCI and Travis

https://github.com/convox/docs/blob/master/docs/integrations/integrations-overview.md contains links to an example integration for Circle CI and Travis CI but the links are broken.

Documentation about custom domains is wrong

It says to point to the Rack URL but it should be the app URL

Suggestion: add a cookbook / examples section

Ideas:
-- http -> https redirect using nginx
-- muti-service reverse proxy example (Injecting env vars into nginx configs)
-- Deployment examples for common frameworks (expressjs, django, laravel, etc)

Documentation about rollbacks is incorrect.

The documentation currently says that you can use convox releases promote to roll back to an older release.

I tried this yesterday, and got an error saying "cannot promote to an older release, use rollback".

Missing documentation for resources

It would be nice if there was more documentation for the convox resources command, preferably in the output of convox --help or in the online documentation.

I can never remember how to link/unlink as the only documentation that shows up is:

convox resources            list resources
convox resources info       get information about a resource
convox resources proxy      proxy a local port to a resource
convox resources url        get url for a resource

...and it appears to be undocumented: https://docs.convox.com/application/resources