A utility for automating multi-host, multi-environment software builds and deployments.
Project description
batou helps you to automate your application deployments:
- You create a model of your deployment using a simple but powerful Python API.
- You configure how the model applies to hosts in different environments.
- You verify and run the deployment with the batou utility.
Getting started with a new project is easy:
mkdir myproject
cd myproject
git init
curl -sL https://raw.githubusercontent.com/flyingcircusio/batou/main/bootstrap | sh
git commit -m "Start a batou project."
Here's a minimal application model:
$ mkdir -p components/myapp
$ cat > components/myapp/component.py
from batou.component import Component
from batou.lib.python import VirtualEnv, Package
from batou.lib.supervisor import Program
class MyApp(Component):
def configure(self):
venv = VirtualEnv('2.7')
self += venv
venv += Package('myapp')
self += Program('myapp',
command='bin/myapp')
And here's a minimal environment:
$ mkdir environments
$ cat > environments/dev/environment.cfg
[environment]
connect_method = local
[hosts]
localhost = myapp
To deploy this, you run:
$ ./batou deploy dev
Check the detailed documentation to get going with a more ambitious project.
Features
- Separate your application model from environments
- Supports idempotent operation for incremental deployments
- Deploy to multiple hosts simultaneously
- Automated dependency resolution for multi-host scenarios
- No runtime requirements on your application
- Encrypted secrets with multiple access levels: store your SSL certificates, SSH keys, service secrets and more to get true 1-button deployments.
- Deploy to local machines, Vagrant, or any SSH host
- Broad SSH feature support by using OpenSSH through execnet
- Only few dependencies required on the remote host
- Ships with a library of components for regularly needed tasks
- self-bootstrapping and self-updating - no additional scripting needed
License
The project is licensed under the 2-clause BSD license.
Hacking
- Make sure
mercurialandsubversionare installed and in$PATH. - Run
./develop.shto create a local virtualenv with everything set up. - Run the test suite using:
bin/tox - Build the documentation using:
cd doc; make - Set up GPG for the examples with
export GNUPGHOME=<DIRECTORY OF BATOU HERE>/src/batou/secrets/tests/fixture/gnupg - Make sure age is installed and in
$PATHfor age encryption support.
Development and release process
- Changes should be accompanied with a changelog entry. Use
./changelog.shto create one. - Releasing will create a tag and publishes the package to pypi. Use
./release-this.shto create a release.
Changelog
See CHANGES.md.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
batou-2.5.2.tar.gz
(194.3 kB
view details)
Built Distribution
batou-2.5.2-py3-none-any.whl
(174.9 kB
view details)
File details
Details for the file batou-2.5.2.tar.gz.
File metadata
- Download URL: batou-2.5.2.tar.gz
- Upload date:
- Size: 194.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9cc616c2319b61f241e4c948b00fef47641f4bef5aadf0a365431791541eac29 |
|
| MD5 | 6d58290b191402061f147991c14b68a1 |
|
| BLAKE2b-256 | b9ab648c3eb411d0fff0fa96e4447a9dc1e72eb7c7b5d56890695c81b1c6c2be |
File details
Details for the file batou-2.5.2-py3-none-any.whl.
File metadata
- Download URL: batou-2.5.2-py3-none-any.whl
- Upload date:
- Size: 174.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9e01a97addb1c936a79b4fa74109cce692b4711559aa467ad9dfc9ec8549a8d3 |
|
| MD5 | 04e45d6251a662884472b321ffe36de1 |
|
| BLAKE2b-256 | de0b2e5adfaa00ea96636b3d56d40c6942319fea95c7d74322f03c2e5ebdc50e |
