alpine-make-vm-image/README.adoc

= 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.
It’s 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: Don’t need VM, just wants 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.
-												Prepare project

											
										
										
											2017-08-29 18:01:51 +00:00
+								= Make Alpine Linux VM Image
-												Readme: Add content

											
										
										
											2017-08-29 22:54:42 +00:00
+								:script-name: alpine-make-vm-image
-												Release version 0.2.0

											
										
										
											2017-10-11 19:18:58 +00:00
+								:script-sha1: 8800a07c8c8102a15726084d8ac2fcde0b4324dc
-												Readme: Add content

											
										
										
											2017-08-29 22:54:42 +00:00
+								:gh-name: jirutka/{script-name}
-												Release version 0.2.0

											
										
										
											2017-10-11 19:18:58 +00:00
+								:version: 0.2.0
-												Readme: Add content

											
										
										
											2017-08-29 22:54:42 +00:00
 								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[]
-												Readme: Improve preamble

											
										
										
											2017-10-11 19:36:32 +00:00
+								This project provides script for making customized https://alpinelinux.org/[Alpine Linux] disk images for virtual machines.
 								It’s quite simple (250 LoC of shell), fast (~40 seconds on Travis CI including Travis VM initialization) and requires minimum dependencies (QEMU and filesystem tools).
-												Readme: Add content

											
										
										
											2017-08-29 22:54:42 +00:00
-												Readme: Add tip for alpine-chroot-install

											
										
										
											2017-10-11 19:56:03 +00:00
+								TIP: Don’t need VM, just wants to chroot into Alpine Linux (e.g. on CI)?
 								     Try https://github.com/alpinelinux/alpine-chroot-install[alpine-chroot-install]!
-												Readme: Add content

											
										
										
											2017-08-29 22:54:42 +00:00
 								== Requirements
-												Readme: Add requirement for Linux system

											
										
										
											2017-10-11 19:28:44 +00:00
+								* Linux system with common userland (Busybox or GNU coreutils)
-												Readme: Add content

											
										
										
											2017-08-29 22:54:42 +00:00
+								* POSIX-sh compatible shell (e.g. Busybox ash, dash, Bash, ZSH)
-												Add support for downloading apk-tools if not available on host

											
										
										
											2017-10-11 17:48:03 +00:00
+								* 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)
-												Readme: Add content

											
										
										
											2017-08-29 22:54:42 +00:00
 								== 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.