- What is vanagon?
- Runtime requirements
- Configuration and Usage
- Overview
- Contributing
- License
- Maintainers
- Support
Vanagon is a tool to build a single package out of a project, which can itself contain one or more components. This tooling is being used to develop the puppet-agent package, which contains components such as openssl, ruby, and augeas among others. For a simple example, please see the examples directory.
Vanagon builds up a Makefile and packaging files (specfile for RPM, control/rules/etc for DEB) and copies them to a remote host, where make can be invoked to build all of the components and make a package of the contents.
Vanagon also provides a devkit command that will prepare a machine as a development environment for the entire project, or restricted to individual components of the project. The devkit command installs all required build tools, creates a master makefile for the project, and configures, builds, and installs all components. The result is an environment where you can work on individual components, then rebuild the project and test the installed artifacts.
Vanagon is self-contained. A recent version of ruby (2.1 or greater) should be all that is required. Beyond that, ssh, rsync and git are also required on the host, and ssh-server and rsync is required on the target (package installation for the target can be customized in the platform config for the target).
Vanagon won't be much use without a project to build. Beyond that, you must define any platforms you want to build for. Vanagon ships with some simple binaries to use, but the one you probably care about is named 'build'.
The build command has positional arguments and position independent flags.
The name of the project to build, and a file named <project_name>.rb must be present in configs/projects in the working directory.
The name of the platform to build against, and a file named <platform_name>.rb must be present in configs/platforms in the working directory.
Platform can also be a comma separated list of platforms such as platform1,platform2.
Target host is an optional argument to override the host selection. Instead of using a vm collected from the pooler, the build will attempt to ssh to target as the root user.
If building on multiple platforms, multiple targets can also be specified using a comma separated list such as host1,host2. If less targets are specified than platforms, the default engine (the pooler) will be used for platforms without a target. If more targets are specified than platforms, the extra will be ignored.
Specifies a directory where the sources should be placed and builds performed. Defaults to a temporary directory created with Ruby's Dir.mktmpdir.
Specifies where project configuration is found. Defaults to $pwd/configs.
Choose a different virtualization engine to use to select the build target. Currently supported engines are:
base- Pure ssh backend; no teardown currently definedlocal- Build on the local machine; platform name must match the local machinedocker- Builds in a docker containerpooler- Selects a vm from Puppet Labs' vm pooler to build onhardware- Build on a specific taget and lock it in redis
Indicates that the host used for building the project should be left intact after the build instead of destroyed. The host is usually destroyed after a successful build, or left after a failed build.
Increase verbosity of output.
Display command-line help.
A full path on disk for a private ssh key to be used in ssh and rsync communications. This will be used instead of whatever defaults are configured in .ssh/config.
When set, Vanagon will forward the ssh authentication agent connection.
Used in conjunction with the pooler engine, this is a token to pass to the vmpooler to access the API. Without this token, the default lifetime of vms will be much shorter.
The name of the host where redis is running. Redis is used to handle a lock when using the hardware engine. It defaults to redis, with no domain.
Port of the system where redis is running. Defaults to 6379.
build --preserve puppet-agent el-6-i386 will build the puppet-agent project
on the el-6-i386 platform and leave the host intact afterward.
build --engine=docker puppet-agent el-6-i386 will build the puppet-agent
project on the el-6-i386 platform using the docker engine (the platform must
have a docker_image defined in its config).
The devkit command has positional arguments and position independent flagged arguments.
As in build arguments.
As in build arguments.
Specifies specific components that should be built. If components are not specified, then all components in the project will be built. If components are specified as arguments, then any in the project that aren't specified as arguments will be retrieved from packages rather than built from source.
Supports all flagged arguments from the build command.
As in the build target host optional argument.
Display command-line help.
We'd love to get contributions from you! Once you are up and running, take a look at the Contribution Documents to see how to get your changes merged in.
See LICENSE file.
Vanagon is broken down into three core ideas: the project, the component and the platform. The project contains one or more components and is built for a platform. As a quick example, if I had a ruby app and wanted to package it, the project would probably contain a component for ruby and a component for my app. If I wanted to build it for debian wheezy, I would define a platform called wheezy and build my project against it.
For more detailed examples of the DSLs available, please see the examples directory and the YARD documentation for vanagon.
The Release Engineering team at Puppet Labs
Please log tickets and issues at our Issue Tracker. In addition there is an active #puppet-dev channel on Freenode.