alpine-make-vm-image/README.adoc
2017-10-13 19:10:30 +02:00

42 lines
1.7 KiB
Text
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

= Make Alpine Linux VM Image
:script-name: alpine-make-vm-image
:script-sha1: 8800a07c8c8102a15726084d8ac2fcde0b4324dc
:gh-name: jirutka/{script-name}
:version: 0.2.0
ifdef::env-github[]
image:https://travis-ci.org/{gh-name}.svg?branch=master["Build Status", link="https://travis-ci.org/{gh-name}"]
endif::env-github[]
This project provides script for making customized https://alpinelinux.org/[Alpine Linux] disk images for virtual machines.
Its quite simple (250 LoC of shell), fast (~40 seconds on Travis CI including Travis VM initialization) and requires minimum dependencies (QEMU and filesystem tools).
TIP: Dont need VM, just want to chroot into Alpine Linux (e.g. on CI)?
Try https://github.com/alpinelinux/alpine-chroot-install[alpine-chroot-install]!
== Requirements
* Linux system with common userland (Busybox or GNU coreutils)
* POSIX-sh compatible shell (e.g. Busybox ash, dash, Bash, ZSH)
* qemu-img and qemu-nbd (automatically installed by the script if running on Alpine)
* e2fsprogs (for ext4), btrfs-progs (for Btrfs), or xfsprogs (for XFS) (automatically installed by the script if running on Alpine)
== Usage
Read documentation in link:{script-name}[{script-name}].
See link:.travis.yml[.travis.yml] for Travis example.
You can copy link:{script-name}[{script-name}] into your repository or download it on demand, e.g.:
[source, sh, subs="+attributes"]
wget https://raw.githubusercontent.com/{gh-name}/v{version}/{script-name} \
&& echo '{script-sha1} {script-name}' | sha1sum -c \
|| exit 1
== License
This project is licensed under http://opensource.org/licenses/MIT/[MIT License].
For the full text of the license, see the link:LICENSE[LICENSE] file.