more readme
This commit is contained in:
parent
2bd6efcadb
commit
cfefe02a86
17
README.md
17
README.md
@ -5,24 +5,31 @@ Sk4nZ OpenBSD Packer
|
||||
|
||||
**skz-opack** enables simple execution of [OpenBSD](https://www.openbsd.org) virtual machines from a Linux host or Google Cloud Compute, leveraging Packer and Vagrant, from a Makefile target named `opack`.
|
||||
|
||||
## Installation Instructions
|
||||
## Instructions
|
||||
|
||||
To get started with **skz-opack**, follow these steps:
|
||||
|
||||
1. Clone the repository using the following command:
|
||||
```sh
|
||||
git clone https://www.sk4.nz/skz-opack.git
|
||||
git clone https://git.sk4.nz/sk4nz/skz-opack.git
|
||||
```
|
||||
2. Ensure you have the following dependencies installed:
|
||||
- GNU Make
|
||||
- [GNU Make](https://www.gnu.org/software/make/)
|
||||
- [libvirt](https://libvirt.org/)
|
||||
- [Vagrant](https://www.vagrantup.com/)
|
||||
- [Vagrant-Libvirt module](https://github.com/vagrant-libvirt/vagrant-libvirt)
|
||||
|
||||
3. Use the project by including `path/to/skz-opack/src/opack.mk` and invoking the `opack` target in your Makefile to create and manage OpenBSD virtual machines with Packer and Vagrant.
|
||||
|
||||
## Architecture
|
||||
|
||||
|
||||
|
||||
## Available make targets
|
||||
Available make target are `opack`, `clean` and `cleancache`.
|
||||
Available make target are:
|
||||
- `opack`
|
||||
- `clean`
|
||||
- `cleancache`
|
||||
|
||||
## Examples
|
||||
### Quick example
|
||||
@ -36,7 +43,7 @@ include path/to/src/opack.mk # mandatory
|
||||
|
||||
After invokation with `make opack`, it will download, install, and run the latest OpenBSD release in a local VM.
|
||||
Once executed, the VM is running and it is possible to log into it using the `vagrant ssh` command.
|
||||
Then, `make clean` will remove the VM, but not the vagrant image. When reinvoking `make opack`, the already existing image will be reused.
|
||||
Then, `make clean` will remove the VM, but not the vagrant box (in order to clean everythin, use `make cleancache`).
|
||||
|
||||
### Complex Example
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user