Skip to content

Instantly share code, notes, and snippets.

@pr1ntf

pr1ntf/iohyve-0.2.12.sh

Created June 4, 2015 22:51
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save pr1ntf/3ae9005551630913e06b to your computer and use it in GitHub Desktop.
Save pr1ntf/3ae9005551630913e06b to your computer and use it in GitHub Desktop.
Download ZIP
Before the fork.
Raw
iohyve-0.2.12.sh
#!/bin/sh
# iohyve v0.2.12 2015/05/18 "persist docs"
# Process command line
__parse_cmd () {
while [ $# -gt 0 ] ; do
case "$1" in
version) __version
exit
;;
setup) __setup "$@"
exit
;;
list) __list
exit
;;
isolist) __isolist
exit
;;
vmmlist) __vmmlist
exit
;;
running) __running
exit
;;
fetch) __fetch "$@"
exit
;;
remove) __remove "$@"
exit
;;
create) __create "$@"
exit
;;
install) __install "$@"
exit
;;
load) __load "$@"
exit
;;
boot) __boot "$@"
exit
;;
start) __start "$@"
exit
;;
stop) __stop "$@"
exit
;;
off) __off "$@"
exit
;;
scram) __scram
exit
;;
destroy) __destroy "$@"
exit
;;
delete) __delete "$@"
exit
;;
set) __set "$@"
exit
;;
get) __get "$@"
exit
;;
getall) __getall "$@"
exit
;;
conlist) __conlist
exit
;;
console) __console "$@"
exit
;;
conreset) __conreset
exit
;;
readme) __readme
exit
;;
man) __man
exit
;;
help|-h) __help
exit
;;
esac
shift
done
}
# Show version
__version() {
echo 'iohyve v0.2.12 2015/05/18 persist docs'
}
# Setup iohyve
__setup() {
local pool="$2"
echo "Setting up iohyve..."
zfs create $pool/iohyve
zfs set mountpoint="/iohyve" $pool/iohyve
zfs create $pool/iohyve/ISO
zfs set mountpoint="/iohyve/ISO" $pool/iohyve/ISO
}
# List guests
__list() {
echo "Listing guests..."
zfs list | grep iohyve | grep -v ISO | cut -d ' ' -f 1 | cut -d '/' -f 3 | sed 1d
}
# List iso's
__isolist() {
echo "Listing ISO's..."
zfs list | grep iohyve/ISO | cut -d ' ' -f 1 | cut -d '/' -f 4 | sed 1d
}
# List VMM (who has resources)
__vmmlist() {
echo "Listing VMM directory..."
ls /dev/vmm | grep ioh- | cut -c 5-
}
# List running guests by PID
__running() {
echo "Listing running guests..."
ps | grep "ioh-" | grep -v "grep" | cut -d ':' -f 3- | cut -d '-' -f 2 | cut -d '(' -f 1
}
# Fetch ISO
__fetch() {
local url="$2"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
local name="$(basename $2)"
echo "Fetching $url..."
zfs create $pool/iohyve/ISO/$name
fetch $url -o /iohyve/ISO/$name
}
# Remove ISO
__remove() {
local name="$2"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
echo "Removing $name..."
zfs destroy $pool/iohyve/ISO/$name
}
# Create guest
__create() {
local name="$2"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
local size="$3"
local con="$4"
echo "Creating $name..."
zfs create $pool/iohyve/$name
truncate -s $size /iohyve/$name/$name.img
zfs set iohyve:name=$name $pool/iohyve/$name
zfs set iohyve:size=$size $pool/iohyve/$name
zfs set iohyve:ram=256M $pool/iohyve/$name
zfs set iohyve:cpu=1 $pool/iohyve/$name
zfs set iohyve:tap=tap0 $pool/iohyve/$name
zfs set iohyve:con=$con $pool/iohyve/$name
zfs set iohyve:os=freebsd $pool/iohyve/$name
zfs set iohyve:loader=bhyveload $pool/iohyve/$name
zfs set iohyve:persist=0 $pool/iohyve/$name
}
# Install guest
__install() {
local name="$2"
local iso="$3"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
local ram="$(zfs get -H -o value iohyve:ram $pool/iohyve/$name)"
local con="$(zfs get -H -o value iohyve:con $pool/iohyve/$name)"
local cpu="$(zfs get -H -o value iohyve:cpu $pool/iohyve/$name)"
local tap="$(zfs get -H -o value iohyve:tap $pool/iohyve/$name)"
local loader="$(zfs get -H -o value iohyve:loader $pool/iohyve/$name)"
echo "Installing $name..."
if [ $loader == "bhyveload" ]; then
bhyveload -m $ram -d /iohyve/ISO/$iso/$iso -c /dev/${con}A ioh-$name &
sleep 12
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -s4,ahci-cd,/iohyve/ISO/$iso/$iso -lcom1,/dev/${con}A ioh-$name &
elif [ $loader == "grub" ]; then
printf '\(hd0\)\ /iohyve/'$name'/'$name'.img\n' > /iohyve/$name/device.map
printf '\(cd0\)\ '/iohyve/ISO/$iso/$iso'\n' >> /iohyve/$name/device.map
grub-bhyve -m /iohyve/$name/device.map -r cd0 -c /dev/${con}A -M $ram ioh-$name &
else
echo "I don't understand what OS you are using."
echo "Use iohyve set loader=bhyveload or loader=grub to set custom loader"
fi
}
# Load guest
__load() {
local name="$2"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
local ram="$(zfs get -H -o value iohyve:ram $pool/iohyve/$name)"
local con="$(zfs get -H -o value iohyve:con $pool/iohyve/$name)"
local loader="$(zfs get -H -o value iohyve:loader $pool/iohyve/$name)"
local os="$(zfs get -H -o value iohyve:os $pool/iohyve/$name)"
echo "Loading $name..."
if [ $loader == "bhyveload" ]; then
bhyveload -m $ram -d /iohyve/$name/$name.img -c /dev/${con}A ioh-$name &
elif [ $loader == "grub" ]; then
printf '\(hd0\)\ /iohyve/'$name'/'$name'.img\n' > /iohyve/$name/device.map
if [ $os == "centos6" ]; then
grub-bhyve -m /iohyve/$name/device.map -r hd0,msdos1 -d /grub -c /dev/${con}A -M $ram ioh-$name &
else
grub-bhyve -m /iohyve/$name/device.map -r hd0,msdos1 -c /dev/${con}A -M $ram ioh-$name &
fi
else
echo "I don't understand what loader you are using."
echo "Use iohyve set loader=bhyveload or loader=grub to set custom loader"
fi
}
# Boot guest
__boot() {
local name="$2"
local iso="$3"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
local ram="$(zfs get -H -o value iohyve:ram $pool/iohyve/$name)"
local con="$(zfs get -H -o value iohyve:con $pool/iohyve/$name)"
local cpu="$(zfs get -H -o value iohyve:cpu $pool/iohyve/$name)"
local tap="$(zfs get -H -o value iohyve:tap $pool/iohyve/$name)"
local loader="$(zfs get -H -o value iohyve:loader $pool/iohyve/$name)"
echo "Booting $name..."
if [ $loader == "bhyveload" ]; then
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -s4,ahci-cd,/iohyve/ISO/$iso/$iso -lcom1,/dev/${con}A ioh-$name &
elif [ $loader == "grub" ]; then
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -s4,ahci-cd,/iohyve/ISO/$iso/$iso -lcom1,/dev/${con}A ioh-$name &
else
echo "I don't understand what loader you are using."
echo "Use iohyve set loader=bhyveload or loader=grub to set custom loader"
fi
}
# Start guest (combine load and boot)
__start() {
local name="$2"
local flag="$3"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
local ram="$(zfs get -H -o value iohyve:ram $pool/iohyve/$name)"
local con="$(zfs get -H -o value iohyve:con $pool/iohyve/$name)"
local cpu="$(zfs get -H -o value iohyve:cpu $pool/iohyve/$name)"
local tap="$(zfs get -H -o value iohyve:tap $pool/iohyve/$name)"
local os="$(zfs get -H -o value iohyve:os $pool/iohyve/$name)"
if [ $flag == "-p" ]; then
zfs set iohyve:persist=1 $pool/iohyve/$name
local persist="$(zfs get -H -o value iohyve:persist $pool/iohyve/$name)"
if [ $os == "freebsd" ]; then
bhyveload -m $ram -d /iohyve/$name/$name.img ioh-$name > /dev/null
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -lcom1,/dev/${con}A ioh-$name &
elif [ $os == "centos6" ]; then
grub-bhyve -m /iohyve/$name/device.map -r hd0,msdos1 -d /grub -M $ram -c /dev/${con}A ioh-$name
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -lcom1,/dev/${con}A ioh-$name &
elif [ $os == "debian" ] || [ $os == "ubuntu" ]; then
printf '\(hd0\)\ /iohyve/'$name'/'$name'.img\n' > /iohyve/$name/device.map
grub-bhyve -m /iohyve/$name/device.map -r hd0,msdos1 -M $ram -c /dev/${con}A ioh-$name
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -lcom1,/dev/${con}A ioh-$name &
else
echo "iohyve start is not supported for this operating system."
echo "Use iohyve load and iohyve boot instead."
fi
sleep 40
local pid="$(ps | grep ioh-$name | grep -v grep | cut -c1-5)"
while [ $persist == "1" ]
do
persist="$(zfs get -H -o value iohyve:persist $pool/iohyve/$name)"
if [ $pid == $(ps | grep ioh-$name | grep -v grep | cut -c1-5) ]; then
sleep 20
else
bhyvectl --force-poweroff --vm=ioh-$name
bhyvectl --destroy --vm=ioh-$name
sleep 5
if [ $os == "freebsd" ]; then
bhyveload -m $ram -d /iohyve/$name/$name.img ioh-$name > /dev/null
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -lcom1,/dev/${con}A ioh-$name &
elif [ $os == "centos6" ]; then
grub-bhyve -m /iohyve/$name/device.map -r hd0,msdos1 -d /grub -M $ram -c /dev/${con}A ioh-$name
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -lcom1,/dev/${con}A ioh-$name &
elif [ $os == "debian" ] || [ $os == "ubuntu" ]; then
printf '\(hd0\)\ /iohyve/'$name'/'$name'.img\n' > /iohyve/$name/device.map
grub-bhyve -m /iohyve/$name/device.map -r hd0,msdos1 -M $ram -c /dev/${con}A ioh-$name
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -lcom1,/dev/${con}A ioh-$name &
else
echo "iohyve start is not supported for this operating system."
echo "Use iohyve load and iohyve boot instead."
fi
sleep 15
pid="$(ps | grep ioh-$name | grep -v grep | cut -c1-5)"
sleep 5
fi
done
else
echo "Starting $name... (Takes 15 seconds for FreeBSD guests, 10 for Debian guests)"
if [ $os == "freebsd" ]; then
bhyveload -m $ram -d /iohyve/$name/$name.img ioh-$name > /dev/null
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -lcom1,/dev/${con}A ioh-$name &
elif [ $os == "centos6" ]; then
grub-bhyve -m /iohyve/$name/device.map -r hd0,msdos1 -d /grub -M $ram ioh-$name > /dev/null
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -lcom1,/dev/${con}A ioh-$name &
elif [ $os == "debian" ] || [ $os == "ubuntu" ]; then
printf '\(hd0\)\ /iohyve/'$name'/'$name'.img\n' > /iohyve/$name/device.map
grub-bhyve -m /iohyve/$name/device.map -r hd0,msdos1 -M $ram ioh-$name > /dev/null
bhyve -c $cpu -A -H -P -m $ram -s0,hostbridge -s1,lpc -s2,virtio-blk,/iohyve/$name/$name.img \
-s3,virtio-net,$tap -lcom1,/dev/${con}A ioh-$name &
else
echo "iohyve start is not supported for this operating system."
echo "Use iohyve load and iohyve boot instead."
fi
fi
}
# Gracefully stop a guest
__stop() {
local name="$2"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
local pid="$(ps | grep "ioh-" | grep $name | grep -v "grep" | cut -c1-5)"
echo "Stopping $name..."
zfs set iohyve:persist=0 $pool/iohyve/$name
kill $pid
sleep 20
bhyvectl --destroy --vm=ioh-$name
}
# Gracefully shut down all guests via ACPI (Does not destroy)
__scram() {
echo "Shutting down all guests..."
killall bhyve
}
# Destroy guest
__destroy() {
local name="$2"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
echo "Destroying $name..."
zfs set iohyve:persist=0 $pool/iohyve/$name
bhyvectl --force-poweroff --vm=ioh-$name
bhyvectl --destroy --vm=ioh-$name
}
# Delete guest
__delete() {
local name="$2"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
echo "Deleting $name..."
zfs destroy $pool/iohyve/$name
}
# Set ZFS props
__set() {
local name="$2"
local propval="$3"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
echo "Setting $name prop $propval..."
zfs set iohyve:$propval $pool/iohyve/$name
}
# Get ZFS props
__get() {
local name="$2"
local prop="$3"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
echo "Getting $name prop $prop..."
zfs get -H -o value iohyve:$prop $pool/iohyve/$name
}
# Get all ZFS props
__getall() {
local name="$2"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
echo "Getting $name props..."
zfs get all $pool/iohyve/$name | grep iohyve:
}
# List Consoles in use
__conlist() {
echo "Listing active nullmodem consoles..."
ls /dev | grep nmdm | grep A | cut -d 'A' -f 1
}
# Run console (dirty pre-zfs workaround)
__console() {
local name="$2"
local pool="$(zfs list | grep iohyve | head -n1 | cut -d '/' -f 1)"
local con="$(zfs get -H -o value iohyve:con $pool/iohyve/$name)"
echo "Starting console on $name..."
echo "~~. to escape console [uses cu(1) for console]"
cu -l /dev/${con}B -s 9600
}
# Reset all consoles. This kills the cu(1)
__conreset() {
killall cu
}
# Print readme page
__readme() {
cat << 'EOT'
### Welcome! ###
# iohyve is an all in one quick start for utilizing built-in FreeBSD and ZFS
# tools for managing bhyve guests. iohyve acts much like @pannon's iocage and it's
# inspiration is drawn from it's ideas. iohyve's aim is to get a solid basis of how bhyve
# will interact with iocage's ideas. This includes resource limiting/management, store data in
# zfs proprieties, vnet, and UUID's in addition to creation, starting, stopping, and destroying
# live guests. Snapshoting and other features might be better saved for iocage integration.
# Big thanks to @pannon and @skarekrow for all their help, their code, and patience. :)
# If you are just setting up shared networking, just set the guest's IP to a valid IP address
# on the host's network. If you choose to use VNET, you'll need to set a few more things up.
### Quick Pre-flight checklist ###
# iohyve's network is meant to work either via VNET or Shared IP, both utilizing tap(4)
# The goal is to potentialy have bhyve guests and iocage jails living on the same VNET
# Things labeled as NEEDED are needed at the very least for shared IP guests.
# Everything else is for VNET.
#
#
# The following needs to be added to kernal config and recompiled
# options VIMAGE # VNET/VIMAGE option for VNET only.
#
# VirtIO support (Included in GENERIC kernel)
# device virtio # Generic VirtIO bus (required)
# device virtio_pci # VirtIO PCI device
# device vtnet # VirtIO Ethernet device
# device virtio_blk # VirtIO Block device
# device virtio_scsi # VirtIO SCSI device
# device virtio_balloon # VirtIO Memory Balloon device
#
#
# Below is added to /boot/loader.conf
# vmm_load="YES" # bhyve module NEEDED
# nmdm_load="YES" # For the nullmodem console NEEDED
# if_bridge_load="YES" # bridge module NEEDED
# if_tap_load="YES" # tap module NEEDED
#
#
# These are added to /etc/sysctl.conf
# net.link.tap.up_on_open=1 # tap setup NEEDED
# net.inet.ip.forwarding=1 # gateway setup
# net.link.bridge.pfil_onlyip=0 # misc gotcha
# net.link.bridge.pfil_bridge=0 # misc gotcha
# net.link.bridge.pfil_member=0 # misc gotca
#
#
# Below is added to /etc/rc.conf for firewall and VNET stuff
# cloned_interfaces="bridge0 bridge1 tap0" # bridge1 not needed for non-vnet setups
# ifconfig_bridge0="addm em0 10.10.123.1/24 up addm tap0" # 10.10.155.1 is the VNET Gateway
# # '10.10.123.1/24 up' not needed for non-vnet
# gateway_enable="YES" # Not needed for non-vnet setups
# pf_enable="YES" # Not needed for non-vnet setups
# pf_rules="/etc/pf.conf" # Not needed for non-vnet setups
# pflog_enable="yes" # Not needed for non-vnet setups
#
#
# Below is an example /etc/pf.conf ***Not needed for non-vnet setups
# Remember to start pf service and run 'pfctl -ef /etc/pf.conf'
#
# pub="XXX.XXX.XXX.XXX" # IP address of host
# jail_net="10.10.155.00/24" #
# example_jail="10.10.155.10" # Already existing iocage vnet jail
# example_guest="10.10.155.11" # IP for new guest
# if="em0" # The physical ethernet interface
#
# set block-policy return
# set skip on lo
# scrub in
#
# NAT
# nat on $if from $example_jail to !$jail_net -> $pub # Give jail route out
# nat on $if from $example_guest to !$jail_net -> $pub # Give guest route out
#
# default
# pass out on $if from $pub to any
# block in log on $if
#
# ssh on the host machine
# pass in quick on $if proto tcp from any to $pub port 4444 # my SSH port is on 4444
EOT
}
# Print man page
__man() {
cat << 'EOT' | less
NAME
iohyve(8) - bhyve manager/launcher v0.2 "I made a thing"
SYNOPSIS
iohyve version
iohyve setup [pool]
iohyve list
iohyve isolist
iohyve vmmlist
iohyve running
iohyve fetch [URL]
iohyve remove [ISO]
iohyve create [name] [size] [console]
iohyve install [name] [ISO]
iohyve load [name]
iohyve boot [name] [ISO]
iohyve start [name] [-p]
iohyve stop [name]
iohyve off [name]
iohyve scram
iohyve destroy [name]
iohyve delete [name]
iohyve set [name] [prop=value]
iohyve get [name] [prop]
iohyve getall [name]
iohyve conlist
iohyve console [name]
iohyve readme
iohyve help
iohyve man
DESCRIPTION
The iohyve(8) shell script utilizes the FreeBSD hypervisor bhyve(8),
zfs(8), and nmdm(4) to make virtualization on FreeBSD easy and simple.
Currently, only FreeBSD guests can be configured, with more on the way.
The basic idea is to store bhyve settings in zfs user properties of zfs
datasets that house important guest files like block devices and grub
configurations. iohyve(8) uses the virtio drivers built into the GENERIC
kernel for virtualization. iohyve(8) does not run out of the box. For
starters, you will need to run 'kldload vmm' for bhyve and 'kldload nmdm'
for the null modem device that helps you connect with your virtual guest.
You can run 'iohyve readme' to learn more about host configuration.
Make sure you have enough tap devices. Only one guest per tap device.
You can always run 'ifconfig tap1' then 'ifconfig bridge0 addm tap1'
Then you can set the guest to use it with 'iohyve guest set tap=tap1'
OPTIONS
version Prints the current running version of iohyve
setup Installs required zfs datasets for iohyve to function.
Usage: 'iohyve setup [poolname]' where [poolname] is the zpool
you want to install iohyve on.
list Lists the zfs dataset directorys for iohyve.
isolist Lists the installed ISOs in the /iohyve/ISO directory.
vmmlist Lists the current guests that are loaded into bhyves VMM.
(Use to see who has resources)
running Lists all the current running and booted guests by Process ID.
fetch Fetches installation ISO or install image and creates a
dataset for it.
Usage: 'iohyve fetch [URL]' where [URL] is the HTTP or FTP URL to
fetch from the internet.
remove Removes installed ISO from /iohyve/ISO
Usage: 'iohyve remove [ISO]' where [ISO] is the name of the ISO
you would like to delete.
create Creates new guest operating system.
Usage: 'iohyve create [name] [size] [console]' where [name] is
the name you would like to use, [size] is the size of the
virtual block device in '16G' format where the capital G
signifies gigabytes, and [console] is the name of the null
modem device in the form of 'nmdmN' where N is 0-99 leaving
out the /dev/ & A or B.
(See console options below for more details)
install Loads and boots into ISO for guest installation.
Usage: 'iohyve install [name] [ISO]' where [name] is the name
of the guest, and [ISO] is the name of the ISO you would
like to boot from in the form of: 'instal.iso'
load Loads the guest operating system bootloader and resources.
Usage: 'iohyve load [name]' where [name] is the name
of the guest operating system.
boot Boots the guest into the operating system. 'iohyve run' needs
to be run before this is done.
Usage: 'iohyve boot [name] [ISO]' where [name] is the name
of the guest operating system. [ISO] is optional and
only for non FreeBSD guests.
start Starts the guest operating system. (Combines load & boot)
Usage: 'iohyve start [name] -p' where [name] is the name
of the guest operating system. Appending the -p
flag will allow the guest to persist.
stop Gracefully stops guest operating system.
Usage: 'iohyve stop [name]' where [name] is the name
of the guest operating system.
off Forces a power off of guest. Also destroys guest resources.
Usage: 'iohyve off [name]' where [name] is the name
of the guest operating system.
scram Gracefully stop all bhyve guests. Does not destroy resources.
destroy Destroys guest resources.
(Resources viewed with 'iocage vmmlist')
Usage: 'iohyve destroy [name]' where [name] is the name
of the guest operating system.
delete Deletes all data for the guest.
Usage: 'iohyve delete [name]' where [name] is the name
of the guest operating system.
set Sets ZFS properties for guests one at a time
Usage: 'iohyve set [name] [prop=value]' where [name] is the name
of the guest operating system.
Properties:
ram=512M or ram=2G (M for megabytes, G for gigabtyes)
cpu=1 (number of cpu cores)
con=nmdm0 (where to attach null modem console)
tap=tap0 (tap device for virtio-net)
size=size of block device
name=name of guest
os=OS type (freebsd, debian, ubuntu, and centos6 supported)
loader=the boot loader (bhyveload or grub)
get Gets ZFS properties for guests one at a time
Usage: 'iohyve get [name] [prop]' where [name] is the name
of the guest operating system. [prop] is the
property you want to view. (See 'iohyve set' info)
getall Gets all the ZFS properties for a guest
Usage: 'iohyve getall [name]' where [name] is the name
of the guest operating system.
conlist Lists all of the connected and in use nullmodem consoles
console Consoles into a guest operating system. Utilizes nmdm(4) and
cu(1) to open a console on a guest operating system. Since
bhyve(8) does not emulate video, so we need to administer
the guests via a serial communication device. Since iohyve
uses cu(1), you will need to press the tilde (~) twice
then period (.) to exit the console.
(Think typing ~~. real fast to exit console)
Usage: 'iohyve console [name]' where [name] is the name
of the guest operating system.
readme Outputs README file. You can run 'iohyve readme > README.txt'
to save the readme to a file.
help General usage help.
man This man page.
EXAMPLES
Setup iohyve zpool named tank:
iohyve setup tank
Fetch FreeBSD install ISO for later:
iohyve fetch ftp://ftp.freebsd.org/.../10.1/FreeBSD-10.1-RELEASE-amd64-bootonly.iso
Create a new FreeBSD guest named bsdguest on console nmdm0 with an 8Gigabyte virtual HDD:
iohyve create bsdguest 8G nmdm0
List ISO's:
iohyve isolist
Install the FreeBSD guest bsdguest:
iohyve install bsdguest FreeBSD-10.1-RELEASE-amd64-bootonly.iso
Console into the intallation:
iohyve console bsdguest
Once installation is done, exit console (~~.) and destroy guest:
iohyve destroy bsdguest
Now that the guest is installed, it can be started like usual:
iohyve start bsdguest
Some guest os's (Like FreeBSD and Debian Linux Distros) can be gracefully stopped:
iohyve stop bsdguest
List all guests created with:
iohyve list
List all guests that have resources allocated using:
iohyve vmmlist
List all runnng guests using:
iohvye running
You can change guest properties by using set:
iohyve bsdguest set ram=512M #set ram to 512 Megabytes
iohyve bsdguest set cpu=1 #set cpus to 1 core
iohyve bsdguest set tap=tap0 #set tap device for ethernet
iohyve bsdguest set con=nmdm0 #set the console to attach to
Get a spcific guest property:
iohyve get bsdguest ram
Get all guest properties:
iohyve getall bsdguest
Start a FreeBSD guest in persistent mode:
iohyve start bsdguest -p &
Debian based distros like Ubuntu and obviously Debian:
Fetch Linux ISO:
iohyve fetch http://cdimage.debian.org/.../debian-8.0.0-amd64-netinst.iso
Create linux guest:
iohyve create jessie 8G nmdm1
Set correct properties for linux guest:
iohyve set jessie loader=grub # Sets correct bootloader
iohyve set jessie os=debian # Sets correct OS type
Attach ISO and load installer from ISO:
iohyve install jessie debian-8.0.0-amd64-netinst.iso # loads grub
Console into grub loader to boot: (once OS is chosen, ~~. to exit)
iohyve console jessie
Boot into installation ISO:
iohyve boot jessie debian-8.0.0-amd64-netinst.iso
Console into guest and set up: (~~. to exit)
iohvye console jessie
Destroy linux guest before booting without installation ISO:
iohyve destroy jessie
Start linux guest like normal:
iohyve start jessie
CentOS 6 guests:
Fetch CentOS 6 ISO
iohyve fetch http://centos.escapemg.com/.../CentOS-6.6-x86_64-netinstall.iso
Create CentOS 6 guest:
iohyve create centos6 16G nmdm6
Set correct properties:
iohyve set centos6 ram=512M # Min Sys Requirements
iohyve set centos6 loader=grub # Grub loader
iohyve set centos6 os=centos6 # OS type
Attach ISO and load installer:
iohyve install centos6 CentOS-6.6-x86_64-netinstall.iso
Console into guest:
iohyve console centos6
In the grub console:
grub> ls (cd0)/isolinux/ # list isolinux directory
boot.cat boot.msg grub.conf initrd.img isolinux.bin isolinux.cfg memtest splash
.jpg TRANS.TBL vesamenu.c32 vmlinuz
grub> linux (cd0)/isolinux/vmlinuz # load kernel
grub> initrd (cd0)/isolinux/initrd.img # ramfs
grub> boot # boot machine
~~. # exit from console
Boot into the installation ISO:
iohyve boot centos6 CentOS-6.6-x86_64-netinstall.iso
Console into the guest and install the it:
iohyve console centos6
Destroy guest:
iohyve destory centos6
Load the centos6 guest:
iohyve load centos6
Console into booloader:
iohyve console centos6
Find kernel and ramfs:
grub> ls (hd0,msdos1)/
lost+found/ grub/ efi/ System.map-2.6.32-504.el6.x86_64 config-2.6.32-504.el6.x
86_64 symvers-2.6.32-504.el6.x86_64.gz vmlinuz-2.6.32-504.el6.x86_64 initramfs-
2.6.32-504.el6.x86_64.img
grub> linux (hd0,msdos1)/vmlinuz-2.6.32-504.el6.x86_64 root=/dev/mapper/VolGroup-lv_root
grub> initrd (hd0,msdos1)/initramfs-2.6.32-504.el6.x86_64.img
grub> boot
~~.
Boot the OS:
iohyve boot centos6
Console into the OS:
iohyve console centos6
Log into root and install grub2:
[root@localhost ~]# yum install wget bison gcc flex nano
[root@localhost ~]# wget ftp://ftp.gnu.org/gnu/grub/grub-2.00.tar.gz
[root@localhost ~]# tar -xzf grub-2.00.tar.gz
[root@localhost ~]# cd grub-2.00
[root@localhost grub-2.00]# ./configure
[root@localhost grub-2.00]# make install
[root@localhost grub-2.00]# /usr/local/sbin/grub-mkconfig -o /boot/grub/grub.cfg
[root@localhost grub-2.00]# /usr/local/sbin/grub-install /dev/vda
[root@localhost grub-2.00]# init 0
Destory guest:
iohyve destroy centos6
Start CentOS 6 guest:
iohyve start centos6
AUTHOR
Trent -- @pr1ntf
THANKS
@pannon
@skarekrow
SEE ALSO
bhyve(8), bhyveload(4), zfs(8), nmdm(4), cu(1)
EOT
}
# Print help page
__help() {
cat << 'EOT'
iohyve version
setup [pool]
list
isolist
vmmlist
running
fetch [URL]
remove [ISO]
create [name] [size] [console]
install [name] [ISO]
load [name]
boot [name] [ISO]
start [name] [-p]
stop [name]
off [name]
scram
destroy [name]
delete [name]
set [name] [prop=value]
get [name] [prop]
getall [name]
conlist
console [name]
readme
help
man
EOT
}
__parse_cmd "$@"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment