acbuild

module

v0.2.2 Latest Latest Go to latest Published: Dec 19, 2015 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/appc/acbuild

Links

Open Source Insights

README ¶

acbuild

acbuild is a command line utility to build and modify App Container Images (ACIs), the container image format defined in the App Container (appc) spec.

Rationale

We needed a powerful tool for constructing and manipulating ACIs that made it easy to iteratively build containers, both from scratch and atop existing images. We wanted that tool to integrate well with Unix mechanisms like the shell and Makefiles so it would fit seamlessly into well-known administrator and developer workflows.

Installation

Dependencies

acbuild can only be run on a Linux system, and has only been tested on the amd64 architecture.

For trying out acbuild on Mac OS X, it's recommended to use Vagrant. Instructions on how to do this are a little further down in this document.

acbuild requires a handful of commands be available on the system on which it's run:

systemd-nspawn
cp
modprobe
gpg

Prebuilt Binaries

The easiest way to get acbuild is to download one of the releases from GitHub.

Build from source

The other way to get acbuild is to build it from source.

Follow these steps to do so:

Grab the source code for acbuild by git cloneing the source repository:
```
cd ~
git clone https://github.com/appc/acbuild
```
Run the build script from the root source repository directory:
```
cd acbuild
./build
```
Or, if you want to build in docker (assuming $PWD exists and contains acbuild/ on your Docker host):
```
cd acbuild
./build-docker
```
A bin/ directory will be created that contains the acbuild tool. To make sure your shell can find this executable, append this directory to your environment's $PATH variable. You can do this in your .bashrc or similar file, for example:
```
vi ~/.bashrc
```

and put the following lines at the end of the file:

export ACBUILD_BIN_DIR=~/acbuild/bin
export PATH=$PATH:$ACBUILD_BIN_DIR

Trying out acbuild using Vagrant

For users with Vagrant 1.5.x or greater, there's a provided Vagrantfile that can quickly get you set up with a Linux VM that has both acbuild and rkt. The following steps will grab acbuild, set up the machine, and ssh into it.

git clone https://github.com/appc/acbuild
cd acbuild
vagrant up
vagrant ssh

Documentation

Documentation about acbuild and many of its commands is available in the Documentation directory in this repository.

Examples

Check out the examples directory for some common applications being packaged into ACIs with acbuild.

https://github.com/sgotti/baci
https://github.com/appc/spec/tree/master/actool - particularly the build and patch-manifest subcommands. acbuild may subsume such functionality, leaving actool as a validator only.
https://github.com/blablacar/cnt

Directories ¶

Path	Synopsis
Godeps
_workspace/src/github.com/appc/spec/aci Package aci contains various functions for working with App Container Images.	Package aci contains various functions for working with App Container Images.
_workspace/src/github.com/appc/spec/discovery Package discovery contains an experimental implementation of the Image Discovery section of the appc specification.	Package discovery contains an experimental implementation of the Image Discovery section of the appc specification.
_workspace/src/github.com/appc/spec/pkg/acirenderer
_workspace/src/github.com/appc/spec/pkg/device
_workspace/src/github.com/appc/spec/pkg/tarheader Package tarheader contains a simple abstraction to accurately create tar.Headers on different operating systems.	Package tarheader contains a simple abstraction to accurately create tar.Headers on different operating systems.
_workspace/src/github.com/appc/spec/schema Package schema provides definitions for the JSON schema of the different manifests in the App Container Specification.	Package schema provides definitions for the JSON schema of the different manifests in the App Container Specification.
_workspace/src/github.com/appc/spec/schema/lastditch Package lastditch provides fallback redefinitions of parts of schemas provided by schema package.	Package lastditch provides fallback redefinitions of parts of schemas provided by schema package.
_workspace/src/github.com/appc/spec/schema/types Package types contains structs representing the various types in the app container specification.	Package types contains structs representing the various types in the app container specification.
_workspace/src/github.com/coreos/go-semver/semver
_workspace/src/github.com/coreos/ioprogress
_workspace/src/github.com/coreos/rkt/pkg/fileutil
_workspace/src/github.com/coreos/rkt/pkg/multicall
_workspace/src/github.com/coreos/rkt/pkg/sys
_workspace/src/github.com/coreos/rkt/pkg/tar Package tar contains helper functions for working with tar files	Package tar contains helper functions for working with tar files
_workspace/src/github.com/coreos/rkt/pkg/uid
_workspace/src/github.com/inconshreveable/mousetrap
_workspace/src/github.com/kylelemons/godebug/diff Package diff implements a linewise diff algorithm.	Package diff implements a linewise diff algorithm.
_workspace/src/github.com/kylelemons/godebug/pretty Package pretty pretty-prints Go structures.	Package pretty pretty-prints Go structures.
_workspace/src/github.com/spf13/cobra Package cobra is a commander providing a simple interface to create powerful modern CLI interfaces.	Package cobra is a commander providing a simple interface to create powerful modern CLI interfaces.
_workspace/src/github.com/spf13/pflag pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags.	pflag is a drop-in replacement for Go's flag package, implementing POSIX/GNU-style --flags.
_workspace/src/github.com/syndtr/gocapability/capability Package capability provides utilities for manipulating POSIX capabilities.	Package capability provides utilities for manipulating POSIX capabilities.
_workspace/src/golang.org/x/crypto/ssh/terminal Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.	Package terminal provides support functions for dealing with terminals, as commonly found on UNIX systems.
_workspace/src/golang.org/x/net/html Package html implements an HTML5-compliant tokenizer and parser.	Package html implements an HTML5-compliant tokenizer and parser.
_workspace/src/golang.org/x/net/html/atom Package atom provides integer codes (also known as atoms) for a fixed set of frequently occurring HTML strings: tag names and attribute keys such as "p" and "id".	Package atom provides integer codes (also known as atoms) for a fixed set of frequently occurring HTML strings: tag names and attribute keys such as "p" and "id".
_workspace/src/golang.org/x/net/html/charset Package charset provides common text encodings for HTML documents.	Package charset provides common text encodings for HTML documents.
_workspace/src/k8s.io/kubernetes/pkg/api/resource
_workspace/src/speter.net/go/exp/math/dec/inf Package inf (type inf.Dec) implements "infinite-precision" decimal arithmetic.	Package inf (type inf.Dec) implements "infinite-precision" decimal arithmetic.
_workspace/src/xi2.org/x/xz
acbuild
lib
registry The registry package exists to manage ACIs for acbuild.	The registry package exists to manage ACIs for acbuild.
tests
util
fsdiffer

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL

README ¶

acbuild

Rationale

Installation

Dependencies

Prebuilt Binaries

Build from source

Trying out acbuild using Vagrant

Documentation

Examples

Related work

Directories ¶