Skip to content
This repository has been archived by the owner. It is now read-only.
Browse files

Documentation/vagrant: use rkt binary for getting started

Currently to get started with rkt we recommend using "vagrant up". This
tries to build rkt inside a virtual machine.

This cleans up the script to use a released version
of rkt instead.

It also removes scripts not being used any more.

Fixes #2789
  • Loading branch information
s-urbaniak committed Jun 21, 2016
1 parent af7ffb3 commit f0bed3d8bd8ee55cd0b23f3e82aa7d3a80d7f843
@@ -7,6 +7,36 @@ The [CoreOS releases page]( lists the version of rk

If the version of rkt included in CoreOS is too old, it's fairly trivial to fetch the desired version [via a systemd unit](

## Debian

rkt currently is packaged in Debian sid (unstable) available at

sudo apt-get install rkt

Note that due to an outstanding bug ( one has to use the "coreos" stage1 image:

sudo rkt run --insecure-options=image docker://nginx

If you prefer to install the newest version of rkt follow the instructions in the Ubuntu section below.

## Ubuntu

rkt is not packaged currently in Ubuntu. If you want the newest version of rkt the easiest method to install it is using the `` script:

sudo ./scripts/

The above script will install the "gnupg2", and "checkinstall" packages, download rkt, verify it, and finally invoke "checkinstall" to create a deb pakage and install rkt. To uninstall rkt, execute:

sudo apt-get remove rkt

## Fedora

rkt is packaged in the development version of Fedora, [Rawhide](

This file was deleted.

@@ -5,7 +5,7 @@ For a more in-depth guide of a full end-to-end workflow of building an applicati

## Using rkt on Linux

rkt consists of a single CLI tool, and is currently supported on amd64 Linux. A modern kernel is required but there should be no other system dependencies. We recommend booting up a fresh virtual machine to test out rkt.
rkt consists of a single CLI tool and can run on different platforms. The primary target platform currently is amd64 Linux. A modern kernel is required but there should be no other system dependencies.

To download the rkt binary, simply grab the latest release directly from GitHub:

@@ -16,6 +16,10 @@ cd rkt-v1.8.0
./rkt help

Like most applications, the easiest way to run rkt is to install it with your system's package manager, like apt on Debian or dnf on Fedora. If your distribution doesn't include a rkt package, or your operating system isn't Linux at all, running rkt in a Vagrant virtual machine can be nearly as simple. The instructions below start a virtual machine with rkt installed and ready to run.

Refer to the [distributions guide]( whether a package is available for your Linux distribution.

**SELinux Note**: rkt can use SELinux but the policy needs to be tailored to your distribution. We suggest that new users [disable SELinux]( to get started. If you can help package rkt for your distro [please help](!

### Optional: Set up Privilege Separation
@@ -65,7 +69,7 @@ If you want to run Vagrant on a Linux host machine, you may want to use libvirt
vagrant plugin install vagrant-libvirt
vagrant plugin install vagrant-mutate
vagrant mutate ubuntu/vivid64 libvirt
vagrant mutate ubuntu/xenial64 libvirt
vagrant up --provider=libvirt

@@ -76,6 +80,55 @@ vagrant ssh
rkt --help

Additional help can be consulted in the rkt man pages:

man rkt

The Vagrant setup also includes bash-completion to assist with rkt subcommands and options.

To reach pods from your host determine the IP address of the Vagrant machine:

vagrant ssh -c 'ip address'
3: enp0s8: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
link/ether 08:00:27:04:e4:5d brd ff:ff:ff:ff:ff:ff
inet brd scope global enp0s8
valid_lft forever preferred_lft forever

In the given example the Vagrant machine has the IP address ``. The following command starts a nginx container using host networking and will be reachable from the host:

sudo rkt run --net=host --insecure-options=image docker://nginx

The nginx container is now accessible on the host under In order to use containers with the default contained network, a route to the network has to be configured on the host:

On Linux execute:
sudo ip route add via

On OSX execute:
sudo route -n add

Now nginx can be started using the default network:
$ sudo rkt run --insecure-options=image docker://nginx
$ rkt list
0c3ab969 nginx running 2 minutes ago 2 minutes ago default:ip4=

The nginx container is now accessible on the host under

Success! The rest of the guide can now be followed normally.

## rkt basics
@@ -1,19 +1,19 @@
Vagrant.configure('2') do |config|
# grab Ubuntu 15.10 official image = "ubuntu/wily64" # Ubuntu 15.10 = "ubuntu/xenial64" # Ubuntu 16.04

# fix issues with slow dns
config.vm.provider :virtualbox do |vb, override|
vb.customize ["modifyvm", :id, "--natdnshostresolver1", "on"]
vb.customize ["modifyvm", :id, "--natdnsproxy1", "on"]
# add more ram, the default isn't enough for the build
vb.customize ["modifyvm", :id, "--memory", "1024"]

config.vm.provider :libvirt do |libvirt, override|
libvirt.memory = 1024

config.vm.synced_folder ".", "/vagrant", type: "rsync"
config.vm.provision :shell, :privileged => true, :path => "scripts/" "private_network", type: "dhcp"
config.vm.provision :shell, :privileged => true, :path => "scripts/"
config.vm.provision :shell, :inline => "usermod -a -G rkt-admin ubuntu"
config.vm.provision :shell, :inline => "usermod -a -G rkt ubuntu"

This file was deleted.

This file was deleted.

This file was deleted.

@@ -1,6 +1,65 @@

set -e
set -x

cd $(mktemp -d)


export DEBIAN_FRONTEND=noninteractive

apt-get update
apt-get install -y --no-install-recommends \
ca-certificates \
gnupg2 \
bash-completion \

curl -sSL | gpg2 --import -
key=$(gpg2 --with-colons --keyid-format LONG -k | egrep ^pub | cut -d ':' -f5)

wget --progress=bar:force"${version}"/rkt-v"${version}".tar.gz
wget --progress=bar:force"${version}"/rkt-v"${version}".tar.gz.asc
gpg2 --trusted-key "${key}" --verify-files *.asc

tar xvzf rkt-v"${version}".tar.gz

cat <<EOF >install-pak
for flavor in fly coreos kvm; do
install -Dm644 rkt-v${version}/stage1-\${flavor}.aci /usr/lib/rkt/stage1-images/stage1-\${flavor}.aci
install -Dm755 rkt-v${version}/rkt /usr/bin/rkt
for f in rkt-v${version}/manpages/*; do
install -Dm644 "\${f}" "/usr/share/man/man1/\$(basename \$f)"
install -Dm644 rkt-v${version}/bash_completion/rkt.bash /usr/share/bash-completion/completions/rkt
install -Dm644 rkt-v${version}/init/systemd/tmpfiles.d/rkt.conf /usr/lib/tmpfiles.d/rkt.conf
for unit in rkt-gc.{timer,service} rkt-metadata.{socket,service}; do
install -Dm644 rkt-v${version}/init/systemd/\$unit /usr/lib/systemd/system/\$unit
chmod +x install-pak

cat <<EOF >preinstall-pak
groupadd --force --system rkt-admin
groupadd --force --system rkt
chmod +x preinstall-pak

cp rkt-v"${version}"/scripts/ postinstall-pak
chmod +x postinstall-pak

cat <<EOF >>postinstall-pak
systemctl daemon-reload
systemd-tmpfiles --create /usr/lib/tmpfiles.d/rkt.conf

sudo cp -v $BUILDDIR/bin/* /usr/local/bin
checkinstall -y --pkgname=rkt --pkgversion="${version}" ./install-pak

0 comments on commit f0bed3d

Please sign in to comment.