A continuous deployment pipeline implementation to transport applications to a runtime context using build-packs.
“OK Deploy” helps you to deliver applications to their intended target runtime, and manage them during their life-cycle while remaining in the data center. The initial focus is Java web applications and Tomcat 7/8.
The main command line tool is ok
, which for one is easy to type,
and frankly also allows me to have a ok computer
sub-command. 😃
It is designed to have similarities to git
's interface.
“OK” projects are normal git
repositories, with some conventions on
the file system structure and branch names applied.
OK Deploy can be installed via pip install ok-deploy
as usual,
see releases for an overview of available versions.
To get a bleeding-edge version from source, use these commands:
repo="Build-The-Web/ok-deploy"
pip install -r "https://raw.githubusercontent.com/$repo/master/requirements.txt"
pip install -UI -e "git+https://github.com/$repo.git#egg=${repo#*/}"
See Contributing on how to create a full development environment.
To add bash completion, read the Click docs about it, or just follow these instructions:
cmdname=ok-deploy
mkdir -p ~/.bash_completion.d
( export _$(tr a-z- A-Z_ <<<"$cmdname")_COMPLETE=source ; \
$cmdname >~/.bash_completion.d/$cmdname.sh )
grep /.bash_completion.d/$cmdname.sh ~/.bash_completion >/dev/null \
|| echo >>~/.bash_completion ". ~/.bash_completion.d/$cmdname.sh"
. "/etc/bash_completion"
Create a brand new project in a local working directory.
This is just a wrapper around git init
, and creates
additional files to form a fully compliant “OK” project.
For version management of changes after that, use git
as usual.
Create a local working directory for a project by getting it from a remote repository.
This is just a wrapper around git clone
, and allows you
to specify the source by just providing a project name,
that is then found based on OK's configuration.
Makes the computer talk to you. 😁
Query information about the project in the current directory, and other pertinent information about the local and remote environments.
Manages your local copy of the deployment configuration.
Perform a deployment.
Control the state of a deployed application.
To create a working directory for this project, call these commands:
git clone "https://github.com/Feed-The-Web/ok-deploy.git"
cd "ok-deploy"
. .env --yes --develop
invoke build --docs test check
See CONTRIBUTING for more.
Tools
Packages
Project sponsored by 1&1.