werf

README

---

Werf (previously known as Dapp) is made to implement and support Continuous Integration and Continuous Delivery (CI/CD).

It helps DevOps engineers generate and deploy images by linking together:

• application code (with Git support),
• infrastructure code (with Ansible or shell scripts), and
• platform as a service (Kubernetes).

Werf simplifies development of build scripts, reduces commit build time and automates deployment. It is designed to make engineer's work fast end efficient.

Contents

• Features
• Requirements and Installation
  • Install Dependencies
  • Install werf
• Docs and Support
• Backward Compatibility Promise
• License

Features

• Complete application lifecycle management: build and cleanup images, deploy application into Kubernetes.
• Incremental rebuilds for git: reducing average build time for a sequence of git commits.
• Building images with Ansible or Shell scripts.
• Building multiple images from one description.
• Sharing a common cache between builds.
• Reducing image size by detaching source data and build tools.
• Running distributed builds with common registry.
• Advanced tools to debug built images.
• Tools for cleaning both local and remote Docker registry caches.
• Deploying to Kubernetes via helm, the Kubernetes package manager.

Installation

Install Dependencies

1. Git command line utility.

   Minimal required version is 1.9.0.

   To optionally use Git Submodules minimal version is 2.14.0.

2. Helm Kubernetes package manager. Helm is optional and only needed for deploy-related commands.

   Helm client installation instructions.

   Tiller backend installation instructions.

   Minimal version is v2.7.0-rc1.

Install Werf

Way 1 (recommended): using Multiwerf

Multiwerf is a version manager for Werf, which:

• downloads werf binary builds;
• manages multiple versions of binaries installed on a single host, that can be used at the same time;
• automatically updates werf binary (can be disabled).

mkdir ~/bin
cd ~/bin
curl -L https://raw.githubusercontent.com/flant/multiwerf/master/get.sh | bash
source <(multiwerf use 1.0 beta)

Way 2: download binary

The latest release can be reached via this page.

MacOS

curl -L https://dl.bintray.com/flant/werf/v1.0.0-beta.1/werf-darwin-amd64-v1.0.0-beta.1 -o /tmp/werf
chmod +x /tmp/werf
sudo mv /tmp/werf /usr/local/bin/werf

Linux

curl -L https://dl.bintray.com/flant/werf/v1.0.0-beta.1/werf-linux-amd64-v1.0.0-beta.1 -o /tmp/werf
chmod +x /tmp/werf
sudo mv /tmp/werf /usr/local/bin/werf

Windows

Download werf.exe.

Way 3: from source

go get github.com/flant/werf/cmd/werf

Docs and support

Official documentation

Getting started

Make your first werf application!

Backward Compatibility Promise

Note: This promise was introduced with werf 1.0 and does not apply to previous versions or to dapp releases.

Werf is versioned with Semantic Versioning. This means that major releases (1.0, 2.0) are allowed to break backward compatibility. In case of werf this means that update to the next major release may require to do a full re-deploy of applications or to perform other non-scriptable actions.

Minor releases (1.1, 1.2, etc.) may introduce new "big" features, but must do so without significant backward compatibility breaks with major branch (1.x). In case of werf this means that update to the next minor release is mostly smooth, but may require to run a provided upgrade script.

Patch releases (1.1.0, 1.1.1, 1.1.2) may introduce new features, but must do so without breaking backward compatibility with minor branch (1.1.x). In case of werf this means that update to the next patch release should be smooth and can be done automatically.

Patch releases are divided to channels. Channel is a prefix in a prerelease part of version (1.1.0-alpha.2, 1.1.0-beta.3, 1.1.0-ea.1). Version without prerelease part is considered to be from a stable channel.

• stable channel (1.1.0, 1.1.1, 1.1.2, etc.). This is a general available version and recommended for usage in critical environments with tight SLA. We guarantee backward compatibility between stable releases within minor branch (1.1.x).
• ea channel versions are mostly safe to use and we encourage to use this version everywhere. We guarantee backward compatibility between ea releases within minor branch (1.1.x). We guarantee that ea release should become a stable release not earlier than 2 weeks of broad testing.
• rc channel (2.3.2-rc.2). These releases are mostly safe to use and can even be used in non critical environments or for local development. We do not guarantee backward compatibility between rc releases. We guarantee that rc release should become ea not earlier than 1 week after internal tests.
• beta channel (1.2.2-beta.0). These releases are for more broad testing of new features to catch regressions. We do not guarantee backward compatibility between beta releases.
• alpha channel (1.2.2-alpha.12, 2.0.0-alpha.5, etc.). These releases can bring new features, but are unstable. We do not guarantee backward compatibility between alpha releases.

License

Apache License 2.0, see LICENSE.