Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md: adjust markdown formatting #293

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

README.md: adjust markdown formatting #293

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
99fc25a
README.md: adjust markdown formatting
vazhnov Jan 20, 2024
d7a8e28
README.md: no need in small text for "We would welcome community help…"
vazhnov Jan 20, 2024
72a6f1f
README.md: move "THIS SHOULD, WE HOPE, IN THE WORKS" to a new line
vazhnov Jan 20, 2024
f91fbd3
README.md: use inline codeblock for a script name. Add a dot to the e…
vazhnov Jan 20, 2024
5821be5
README.md: add more space between different lists in "Operating syste…
vazhnov Jan 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 82 additions & 72 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,108 +4,118 @@
Generic base boxes, providing a variety of operating systems, and available across a number of different virtualized platforms.

## Website
https://roboxes.org

## Vagrant Boxes
https://app.vagrantup.com/generic
https://app.vagrantup.com/lavabit
https://app.vagrantup.com/lineage
https://roboxes.org

## Podman / Docker Images
https://hub.docker.com/u/roboxes/
https://hub.docker.com/u/lavabit/
or
https://quay.io/organization/roboxes
https://quay.io/organization/lavabit
## Vagrant boxes

## Pending Additions/Updates
* https://app.vagrantup.com/generic
* https://app.vagrantup.com/lavabit
* https://app.vagrantup.com/lineage

Add support for the new "architecture" flag. This means adding "386" or "amd64" as appropriate. And it means we need to add "arm64" boxes to the pipeline.
## Podman / Docker images

## Upcoming Additions
* https://hub.docker.com/u/roboxes/
* https://hub.docker.com/u/lavabit/

Oct 23rd, 2023 / FreeBSD 14.0
or

* https://quay.io/organization/roboxes
* https://quay.io/organization/lavabit

## Pending additions/updates

Add support for the new "architecture" flag. This means adding "386" or "amd64" as appropriate. And it means we need to add "arm64" boxes to the pipeline.

## Upcoming additions

Oct 23rd, 2023 / FreeBSD 14.0

\* Repo updated.
\*\* Beta/pre-prerelease added.
\*\* Beta/pre-prerelease added.

## Pending tasks

_We would welcome community help (as a pull request) with any of the following tasks:_

* Generate docker variants for the Ubuntu/Debian/Alpine configurations.
* Incorporate the upload/delete/release scripts into the `robox.sh` script as functions.
* Add vagrant user password randomization logic to the bundled Vagrantfiles.
* Improve the unit box validation/check script with SSH command tests/checks.
* Start building ARM variants for some virtual machines/boxes.
> ^-- WE NEED A HARDWARE DONATION TO MAKE ARM64 IMAGES

> **THIS SHOULD, WE HOPE, IN THE WORKS --^**

## Operating system requests

## Pending Tasks

<sup><sub>_We would welcome community help (as a pull request) with any of the following tasks._</sub></sup>
Generate docker variants for the Ubuntu/Debian/Alpine configurations
Incorporate the upload/delete/release scripts into the robox.sh script as functions.
Add vagrant user password randomization logic to the bundled Vagrantfiles.
Improve the unit box validation/check script with SSH command tests/checks.
Start building ARM variants for some virtual machines/boxes.
^-- WE NEED A HARDWARE DONATION TO MAKE ARM64 IMAGES
**THIS SHOULD, WE HOPE, IN THE WORKS --^**

## Operating System Requests
The following variants of existing builds have been requested, and will be added at a future date, when time allows (or someone submits a pull request):

The following variants of existing builds have been requested, and will be added at a future date, when time allows (or someone submits a pull request).

[Fedora Rawhide](https://fedoraproject.org/wiki/Releases/Rawhide)
[OpenSUSE Tumbleweed](https://software.opensuse.org/distributions/tumbleweed)

This operating system has been requested, but at present doesn't apppear to have sufficient interest. If that changes, it could be easily added by adapting the existing Debian/Ubuntu configurations.
* [Fedora Rawhide](https://fedoraproject.org/wiki/Releases/Rawhide)
* [OpenSUSE Tumbleweed](https://software.opensuse.org/distributions/tumbleweed)

[Pop\!\_OS](https://pop.system76.com/)

The following operating systems have been requested by a member of the Robox community, but require a volunteer to generate a configuration, before they can be incorporated into the workflow.
This operating system has been requested, but at present doesn't appear to have sufficient interest. If that changes, it could be easily added by adapting the existing Debian/Ubuntu configurations:

[Haiku](https://www.haiku-os.org/get-haiku/)
[Minix](https://www.minix3.org/)
[Parrot](https://www.parrotsec.org/)
[SmartOS](https://www.joyent.com/smartos)
* [Pop\!\_OS](https://pop.system76.com/)

## Operating System Candidates
The following operating systems have been requested by a member of the Robox community, but require a volunteer to generate a configuration, before they can be incorporated into the workflow:

The following operating systems are potential candidates. They may be added in the future.
* [Haiku](https://www.haiku-os.org/get-haiku/)
* [Minix](https://www.minix3.org/)
* [Parrot](https://www.parrotsec.org/)
* [SmartOS](https://www.joyent.com/smartos)

Manjaro
Mint
OpenSolaris
Slackware
## Operating system candidates

MacOS
Darwin

ReactOS
Windows
The following operating systems are potential candidates. They may be added in the future.

Tails
Kali
* Manjaro
* Mint
* OpenSolaris
* Slackware

## Adding Boxes

Submit a pull request with your favorite distro.
* MacOS
* Darwin

## Building a Box

To build a Robox locally, run the following:
* ReactOS
* Windows


* Tails
* Kali

## Adding boxes

Submit a pull request with your favorite distro.

## Building a box

To build a Robox locally, run the following:

```bash
git clone https://github.com/lavabit/robox && cd robox
./robox.sh box generic-BOX-PROVIDER
```

You will to replace the BOX and PROVIDER placeholders in the example above.
You will to replace the BOX and PROVIDER placeholders in the example above.

Replace `BOX` with one of the these values: `[alma8|alma9|alpine35|alpine36|alpine37|alpine38|alpine39|alpine310|alpine311|alpine312|alpine313|alpine314|alpine315|alpine316|alpine317|arch|centos6|centos7|centos8|centos8s|centos9s|debian8|debian9|debian10|debian11|devuan1|devuan2|devuan3|devuan4|dragonflybsd5|dragonflybsd6|fedora25|fedora26|fedora27|fedora28|fedora29|fedora30|fedora31|fedora32|fedora33|fedora34|fedora35|fedora36|fedora37|freebsd11|freebsd12|freebsd13|gentoo|hardenedbsd11|hardenedbsd12|hardenedbsd13|netbsd8|netbsd9|openbsd6|openbsd7|opensuse15|opensuse42|oracle7|oracle8|oracle8|rhel6|rhel7|rhel8|rocky8|rocky9|ubuntu1604|ubuntu1610|ubuntu1704|ubuntu1710|ubuntu1804|ubuntu1810|ubuntu1904|ubuntu1910|ubuntu2004|ubuntu2010|ubuntu2104|ubuntu2110|ubuntu2204|ubuntu2210|ubuntu2304]`

And replace `PROVIDER` with one of these values: `[docker|hyperv|libvirt|parallels|virtualbox|vmware]`.

A configuration for all of the distros is available for every provider, EXCEPT Docker. At present we have only adapted a subset of the configurations to build Docker/Podman images.

The above presumes you already have [`packer`](https://www.packer.io/) and the hypervisor for the targeted provider installed. The `res/providers/providers.sh` script may provide guidance on the steps required to setup a Linux build host for VMWare/Virtualbox/Docker/libvirt. Please note that this scripts was written for RHEL/CentOS 7. You will then need to adapt the package names and CLI commands to your environment.

## VirtualBox Disks
And replace `PROVIDER` with one of these values: `[docker|hyperv|libvirt|parallels|virtualbox|vmware]`.

A configuration for all of the distros is available for every provider, EXCEPT Docker. At present we have only adapted a subset of the configurations to build Docker/Podman images.

The above presumes you already have [`packer`](https://www.packer.io/) and the hypervisor for the targeted provider installed. The `res/providers/providers.sh` script may provide guidance on the steps required to setup a Linux build host for VMWare/Virtualbox/Docker/libvirt. Please note that this scripts was written for RHEL/CentOS 7. You will then need to adapt the package names and CLI commands to your environment.

## VirtualBox disks

Enabling the discard/nonrotational options with our VirtualBox configs, appears to improve performance, but only on build robots equipped with SSDs or NVMe drives, and then only if the virtual machine is configured with VDI virtual disks. This combination allows guests to utilize discard/unmap/trim. However, if a virtual machine is deployed onto traditional magnetic hard disks with discard/nonrotational enabled, performance will drop significantly ( 1/50th of normal in some cases ).
Enabling the discard/nonrotational options with our VirtualBox configs, appears to improve performance, but only on build robots equipped with SSDs or NVMe drives, and then only if the virtual machine is configured with VDI virtual disks. This combination allows guests to utilize discard/unmap/trim. However, if a virtual machine is deployed onto traditional magnetic hard disks with discard/nonrotational enabled, performance will drop significantly ( 1/50th of normal in some cases ).

Furthermore, while Packer appears to use VDI disk image files, when the virtual machine is exported and converted into a Vagrant box, the disk gets converted into the VMDK format. The discard/nonrotational options are preserved, and the result is that when the base box is deployed, it results in a virtual machine with the discard/nonrotational options enabled with an unsupported VMDK virtual disk.

As a result, we are currently not using the following options in our Packer config files.
As a result, we are currently not using the following options in our Packer config files.
```
"hard_drive_discard": true,
"hard_drive_nonrotational" : true,
Expand All @@ -131,13 +141,13 @@ AHCI#0P0: Canceled write at offset 82372182016 (524288 bytes left) returned rc=V

The roboxes are maintained by volunteers, and provided for free. As such we rely on donations to cover the cost of the hardware, and bandwidth. If you find this project useful, and would like to see it grow, please help by making a Bitcoin, Bitcoin Cash, Monero or [monetary donation](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=99THGS6F4HGLU&source=url). If you represent a public cloud, and would like to provide infrastructure support, please contact us directly, or open a ticket.

Monero
* Monero
8B3BsNGvpT3SAkMCa672FaCjRfouqnwtxMKiZrMx27ry1KA7aNy5J4kWuJBBRfwzsKZrTvud2wrLH2uvaDBdBw9cSrVRzxC

Bitcoin
* Bitcoin
3NKSTPEeTGmuA95CGGqnyi3zPASSApLZbE

Bitcoin Cash
* Bitcoin Cash
qqxyedtn68jg84w4mkd3vsw2nu6pgkydnudza0ed0m

[Roboxes](https://roboxes.org) is maintained by Ladar Levison, with infrastructure provided by [Lavabit LLC](https://lavabit.com).