Introduction

This repository contains a few tools to help automatically install an (amd64) OpenBSD on an OVH VPS. The process is cumbersome, but works reasonably well.

For more details, see this blog post.

Requirements

Before starting, you'll need:

an amd64 OVH VPS that can be fully erased;
a Linux system from which to run all this;
an existing remotely (SSH) available OpenBSD, used to tweak the default bsd.rd so as to include an install.conf; see autoinstall(8);
OVH API credentials to use the API: we rely on the default mechanism provided by the official OVH API Python wrapper;
ovh-do, a small script to automatize OVH API access.

The tools being rather sharp, it's advised to take the time to read the code and/or the blog post.

Files

./rdsetroot.c

A quickly patched rdsetroot(8) to compile on Linux. So far unused. See TODO.md:/^#.*@ufs-write.

bin/getbsdrd

Download OpenBSD files, e.g. bsd.rd:

$ getbsd -h
NAME
	getbsd

SYNOPSYS
	getbsd [-h]
	getbsd [-v version] [-a arch] [-m mirror] [-p mpath] <file> [path/to/output]

DESCRIPTION
	getbsd downloads an OpenBSD file (e.g. bsd.rd), where:

	  version       $version   OpenBSD version      (default: 7.1)
	  arch          $arch      Architecture to use  (default: amd64)
	  mirror        $mirror    OpenBSD mirror       (default: https://cdn.openbsd.org)
	  mpath         $mirror    Mirror path          (default: pub/OpenBSD)

	If no path/to/output is specified, resulting file is sent
	to stdout.

bin/patchbsdrd

Patch an existing OpenBSD bsd.rd to include a given install.conf

NAME
	patchbsdrd

SYNOPSYS
	patchbsdrd [-h]
	patchbsdrd [-i install.conf] [-r remote] [-w rwd] </path/to/bsd.rd>
	   [path/to/output/bsd.rd]

DESCRIPTION
	patchbsdrd augments a given OpenBSD bsd.rd with the given install.conf, where:

	  install.conf  $install   Path to install.conf (default: ./install.conf)
	  remote        $remote    Remote OpenBSD (ssh) (default: )
	  rwd           $rwd       Remote work dir      (default: /root/mkbsdrd/)

	If no bsd.rd output path is specified, the input one is modified "in-place".

SEE ALSO
	autoinstall(8)

bin/mkbsdrd

Wraps both getbsd and patchbsdrd: creates a bsd.rd embedding a specific install.conf file, using the remote OpenBSD to edit the default bsd.rd. See also upobsd.

$ mkbsdrd -h
NAME
	mkbsdrd

SYNOPSYS
	mkbsdrd [-h]
	mkbsdrd [-v version ] [-a arch] [-m mirror] [-p mpath] [-i install.conf]
	   [-r remote] [-w rwd] [path/to/bsd.rd]

DESCRIPTION
	mkbsdrd fetch and augment an OpenBSD bsd.rd with the given install.conf,
	where:

	  version       $version   OpenBSD version      (default: 7.0)
	  arch          $arch      Architecture to use  (default: amd64)
	  mirror        $mirror    OpenBSD mirror       (default: https://cdn.openbsd.org)
	  mpath         $mirror    Mirror path          (default: pub/OpenBSD)
	  install.conf  $install   Path to install.conf (default: ./install.conf)
	  remote        $remote    Remote OpenBSD (ssh) (default: )
	  rwd           $rwd       Remote work dir      (default: /root/mkbsdrd/)

	If no bsd.rd output path is specified, resulting bsd.rd is printed
	to stdout.

SEE ALSO
	autoinstall(8)

bin/switchport

Push a temporary scripts switching the sshd(8) listening port from 22 to something else. This is crude, and for now, solely targets a freshly installed OpenBSD.

$ switchport -h bin/switchport
NAME
	switchport

SYNOPSYS
	switchport [-h]
	switchport [-u user] [-p port] <m> [newport] [path/to/sshd_config]

DESCRIPTION
	Update sshd(8) listening port of m (assumed to be an OpenBSD)

	  user       $user   SSH user                 (default: root)
	  port       $port   Current SSH port to use  (default: 22)

bin/install-openbsd-to

Shell script installing an OpenBSD to the given VPS IP. It assumes that the VPS has been:

configured to be an OVH "stock" Debian image;
with a password-less SSH access to the default debian user;
and a GRUB2 setup.

By default, the OpenBSD is set with a root of hd0,gpt1; the bsd.rd is likely to have been created by mkbsdrd and the debian setup via ovh-do rebuild-debian <vps-is>:

$ install-openbsd-to -h
install-openbsd-to <vps-id> <bsd.rd> [grub-root-id]

bin/ovh-install-openbsd

The main wrapper, that uses ovh-do, mkbsdrd (hence getbsd and patchbsdrd), install-openbsd-to and switchport to perform the complete automatic installation.

$ ovh-install-openbsd -h
ovh-install-openbsd [-p port] [-g grub-root-id] [-i vps-ip] <vps-id> [mkbsdrd-opts]

bin/mkvm

Nearly automatic VM install, see skreutz.com/posts/autoinstall-openbsd-on-qemu/ for more.

mbivert/ovh-openbsd