The tiniest Heroku/CloudFoundry-like PaaS you've ever seen.
piku, inspired by dokku, allows you do
git push deployments to your own servers.
I kept finding myself wanting an Heroku/CloudFoundry-like way to deploy stuff on a few remote ARM boards and my Raspberry Pi cluster, but since dokku didn't work on ARM at the time and even
docker can be overkill sometimes, I decided to roll my own.
piku supports a Heroku-like workflow, like so:
gitSSH remote pointing to your
pikuserver with the app name as repo name.
git remote add piku [email protected]:appname.
git push piku master.
pikudetermines the runtime and installs the dependencies for your app (building whatever's required).
GOPATHfor each app.
Procfilewhich is documented here and starts the relevant workers using uWSGI as a generic process manager.
releaseworker which is run once when the app is deployed.
config:set) or scale up/down worker processes (
ENVwhich is documented here.
staticworker type, with the root path as the argument, can be used to deploy a gh-pages style static site.
piku you need a VPS, Raspberry Pi, or other server bootstrapped with
piku's requirements. You can use a single server to run multiple
Warning: You should use a fresh server or VPS instance without anything important running on it already, as
piku-bootstrap will make changes to configuration files, running services, etc.
Once you've got a fresh server, download the piku-bootstrap shell script onto your local machine and run it:
curl https://piku.github.io/get | sh
The first time it is run
piku-bootstrap will install itself into
~/.piku-bootstrap on your local machine and set up a virtualenv there with the dependencies it requires. It will only need to do this once.
The script will display a usage message and you can then bootstrap your server:
./piku-bootstrap [email protected]
If you put the
piku-bootstrap script on your
PATH somewhere, you can use it again to provision other servers in the future.
See below for instructions on installing other custom dependencies that your apps might need like a database etc.
To make life easier you can also install the piku helper CLI. Install it into your path e.g.
~/bin to run it from anywhere.
./piku-bootstrap install-cli ~/bin
This shell script makes working with
piku remotes a bit simpler. If you have a git remote called
piku in the current folder it will infer the remote server and app name and insert those into the remote piku commands. This allows you to execute commands like the following on your running remote app:
$ piku logs $ piku config:set MYVAR=12 $ piku stop $ piku deploy $ piku destroy $ piku # <- will show help for the remote app
You can pass flags through to the underlying SSH command, for example
-t to run interactive commands remotely, and
-A to proxy authentication credentials in order to do remote git pulls.
Here is an example of using the
-t flag to obtain a
bash shell in the app directory of one of your Piku apps:
$ piku -t run bash Piku remote operator. Server: [email protected] App: dashboard [email protected]:~/.piku/apps/dashboard$ ls data ENV index.html package.json package-lock.json Procfile server.wisp
Tip: If you put this
piku script on your
PATH you can use the
piku command across multiple apps on your local.
piku-bootstrap uses Ansible internally and it comes with several extra built-in playbooks which you can use to bootstrap common components onto your
piku-bootstrap list-playbooks to show a list of built-in playbooks, and then to install one add it as an argument to the bootstrap command.
For example, to deploy
nodeenv onto your server:
piku-bootstrap [email protected] nodeenv.yml
You can also use
piku-bootstrap to run your own Ansible playbooks like this:
piku-bootstrap [email protected] ./myplaybook.yml
If you are on a LAN and are accessing
piku from macOS/iOS/Linux clients, you can try using
piku/avahi-aliases to announce different hosts via Avahi/mDNS/Bonjour.
As a baseline, it began its development on an original, 256MB Rasbperry Pi Model B, and still runs reliably on it.
Since I have an ODROID-U2, a bunch of Pi 2s and a few more ARM boards on the way, it is often tested on a number of places where running
x64 binaries is unfeasible.
But there are already a few folk using
piku on vanilla
x64 Linux without any issues whatsoever, so yes, you can use it as a micro-PaaS for 'real' stuff. Your mileage may vary.
piku currently supports deploying apps (and dependencies) written in Python, with Go, Clojure (Java) and Node (see above) in the works. But if it can be invoked from a shell, it can be run inside