<!-- DO NOT EDIT THE README.md FILE. IT IS GENERATED FROM README.md.in AND
CHANGES.md BECAUSE Github CANNOT DO INCLUDES -->
<p align="right">
<a href="https://travis-ci.org/flyingcircusio/batou"><img title="Current Build Status" src="https://travis-ci.org/flyingcircusio/batou.svg?branch=master"></a>
</p>
<img width="150" src="https://batou.readthedocs.io/en/latest/_static/batou.png">
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:
```console
$ mkdir myproject
$ cd myproject
$ curl https://raw.githubusercontent.com/flyingcircusio/batou/master/src/batou/bootstrap-template -o batou
$ chmod +x batou
$ ./batou
```
Here's a minimal application model:
```console
$ 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:
```console
$ mkdir environments
$ cat > environments/dev.cfg
[environment]
connect_method = local
[hosts]
localhost = myapp
```
To deploy this, you run:
```console
$ ./batou deploy dev
```
Check the [detailed documentation](http://batou.readthedocs.org) 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.
## Changelog
2.0b12 (2020-05-13)
-------------------
- Fix broken sort of configuration errors. (#52)
2.0b11 (2020-05-13)
-------------------
- Fix "is supervisord running" check in the Supervisor(enable=False) case
2.0b10 (2020-05-11)
-------------------
- Fix Python 3 compatibility for Debian logrotate component.
- Improve output ordering and formatting. The diffs for predicted (or applied)
changes now appear in proper order.
- Provide better error messages when batou fails to lock a secret file.
2.0b9 (2020-05-09)
------------------
- Refactor the `appenv` component into smaller components (and move it to `batou.lib.appenv`.
- Always update pip when installing an appenv - this also fixes the Travis tests.
2.0b8 (2020-05-08)
------------------
- Replace 'Deploying <xxx>' with 'Scheduling' as this is only the moment where
we decide that a component is not blocked by another any longer and can done
as soon as the worker pool is able to do it. Specifically this means that the
following output isn't necessarily from this component.
- Mark the hostname for each deployed component in the breadcrumb output
so that asynchronously deployed components can be visually identified
correctly.
- Show diff of file changes - both during predict and deployment - to better
estimate whether template changes are as expected.
2.0b7 (2020-05-07)
------------------
- Update embedded `appenv` to support Python 3.4+.
- Add component `AppEnv` to manage virtualenvs similar to the `appenv` package
superseding previous virtualenv and buildout components.
- Allow using `assert` statements instead of `batou.UpdateNeeded`.
- Ensure the working directory is the `defdir` during the `configure` phase to
allow using relative path names.
2.0b6 (2020-04-24)
------------------
- Various smaller fixes to get the remoting code working again.
- Update supervisor to 4.1 and Python 3.
- Allow specifying major versions for virtualenvs (i.e. '2' and '3') to get
convergence for virtualenvs where we don't control the minor version of the
targets.
- Add ability to disable supervisor programs.
- Remove '--fast' and '--reset' mode as this isn't needed/ supported by
appenv at the moment.
- Simplify SSH/sudo and try sudo first. Probably needs further attention once
we're along the release cycle.
- Fix Python 2.7 virtualenvs - upgrade to latest old-style release of
`virtualenv`.
### 2.0b5 (2020-04-15)
- Switch to new bootstrapping/self-installing pattern "appenv". See
`appenv.py` for a work-in-progress schema.
### 2.0b4 (2020-01-13)
- Fix incorrect long->int conversion from 2to3. (Mercurial support)
- Fix brownbag release due to missing support files.
### 2.0b3 (2020-01-10)
- Fix Python3 compatibility for logrotate and crontab
- Add six as dependency, so deployments can be made compatible to both Python 2 and 3 more easy.
### 2.0b2 (2019-10-15)
#### General
- Make encryption/decryption error prompt more readable.
- Fix coding style issues.
#### Features
- Add coarse grained parallelization of deployments.
Using asyncio we now schedule rooot components for deployment as soon as all
their dependencies are completed. However, due to execnet being synchronous
this only has a visible effect for components on multiple hosts. This will
speed up long running multi-host deployments.
In the future this will become more fine-grained so that we can even deploy
multiple independent components on the same host in parallel.
#### Bugs
- Fix issue #5: allow using % in secrets similar to regular overrides.
- Fix secrets editing, add test coverage for the affected code.
#### Testing
- Relax global pytest timeouts to avoid slow network failures.
- Switch from broken/abandoned pytest-codecheckers to pytest-flake8
- Enable flake8, remove unused pytest markers.
- Fix warnings
- Make warnings errors.
#### Build system / Development environment
- Update example batou scripts
- Fix travis build environments. Support Python 3.5, 3.6, 3.7, 3.8-dev and
nightly (also 3.8 currently).
- Generalize development bootstrapping code for dual use in local and travis environments.
### 2.0b1 (2019-10-11)
- Drop support for Python 2.
- Move to Python 3.5+.
A smooth migration mechanism may become available in the future
based on users' needs.
- The default hash function is now 'sha512', existing deployments
need to be migrated manually.