Zarf is intended to install & run on a multitude of 64-bit Linux distributions.
Check the table below to understand which distros which we test against & if there are any known issues or usage caveats.
We support running an instance of Zarf inside a local VM (of any of the supported OSes) for test & demonstration purposes.
Run the following commands from the project root directory.
To get a VM running, it's as easy as running a single command:
make vm-init OS=[VM_ID] # e.g. make vm-init OS=ubuntu
Besure to pass a VMID or you'll start a VM instance for _every one of the supported OS types. Yikes!
Work in the VM
To connect into the VM instance you just started, run:
vagrant ssh [VM_ID] # e.g. vagrant ssh ubuntu
Once connected, you can work with your mounted-from-the-host copy of Zarf like so:
sudo su # escalate permissions (to "root" user)
cd /opt/zarf # access Zarf
When you're done with the VM, you can exit back to the host terminal by running:
exit # de-escalate permissions (back to "vagrant" user)
exit # exits VM shel & drops you back on the host
Closing out the demo environment is also a single command:
This will shutdown & destroy all the demo VM instances it can find. Easy-peasy—nice and clean.