Skip to content
Snippets Groups Projects
Commit 18687085 authored by Ariel D'Alessandro's avatar Ariel D'Alessandro
Browse files

virtualbox: Document VirtualBox OVA appliance image


Current SDK images requests to manually setup the Virtual Machine in
VirtualBox, as we're only provinding the disk image (.vdi file).

Support to generate a VirtualBox Appliance image (.ova file) that works
out of the box has been recently added to `apertis-image-recipes`.

Starting Apertis release version `v2022`, SDK images will be uploaded in
OVA format. Let's document that and still keep the previous `.vdi` disk
image setup for old versions reference.

Signed-off-by: default avatarAriel D'Alessandro <ariel.dalessandro@collabora.com>
parent 29608543
No related branches found
No related tags found
1 merge request!255T7638: virtualbox: Document VirtualBox OVA appliance image
Pipeline #256267 passed
......@@ -95,16 +95,68 @@ For instructions on uninstalling VirtualBox, are also provided in the [user manu
# VirtualBox Setup
VirtualBox can be configured as follows:
- option A: from its GUI
- option B: via the command line
If you have not already downloaded an Apertis SDK image, the
[images]({{< ref "images.md" >}}) page contains information regarding the
options available. SDK images provided explicitly for use with VirtualBox can
be found in two different formats:
## Option A: From the VirtualBox GUI
- VirtualBox appliance image, file extension `.ova`. Since Apertis release version `v2022`.
- Compressed disk image, file extension `.vdi.gz`.
- If you have not already downloaded an Apertis SDK image, the
[images]({{< ref "images.md" >}}) page contains information regarding the
options available. SDK images provided explicitly for use with VirtualBox
have the file extension `.vdi.gz`.
Depending on the downloaded image, VirtualBox can be configured as follows:
- Option A: VirtualBox GUI using `.ova` image file
- Option B: From the Command Line using `.ova` disk file
- Option C: VirtualBox GUI using `.vdi` disk file
- Option D: From the Command Line using `.vdi` disk file
## Option A: VirtualBox GUI using `.ova` image file
- Start the VirtualBox application ("Oracle VM VirtualBox" in the Start menu).
![](/images/vbox-ova-1.png)
- Go to `File``Import Appliance` or click the **Import** Icon. This launches
the **Import Virtual Appliance** screen.
- Select the downloaded `.ova` image from the file system:
- Source: `Local File System`.
- File: path to the downloaded `.ova` image.
- Next screen is **Appliance settings**, where the imported VM configuration is
shown and can be tweaked. There's no need to modify these parameters unless you
know what you're doing.
![](/images/vbox-ova-2.png)
- Clicking **Import** starts importing the virtual machine.
## Option B: From the Command Line using `.ova` disk file
- Run the following commands:
<!-- end list -->
$ RELEASE=v2022
$ REVISION=0
$ OVAFILE=./apertis_$RELEASE-sdk-amd64-sdk_$RELEASE.$REVISION.ova
$ wget https://images.apertis.org/release/$RELEASE/$RELEASE.$REVISION/amd64/sdk/$OVAFILE
--2022-06-14 16:20:04-- https://images.apertis.org/release/v2022/v2022.0/amd64/sdk/apertis_v2022-sdk-amd64-sdk_v2022.0.ova
Resolving images.apertis.org (images.apertis.org)... 2a00:1098:0:82:1000:25:2eeb:e3bc, 46.235.227.188
Connecting to images.apertis.org (images.apertis.org)|2a00:1098:0:82:1000:25:2eeb:e3bc|:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 1751623680 (1.7G) [application/octet-stream]
Saving to: ‘apertis_v2022-sdk-amd64-sdk_v2022.0.ova’
apertis_v2022-sdk-a 100%[===================>] 1.70G 6.10MB/s in 4m 57s
2022-06-14 16:26:01 (6.32 MB/s) - ‘apertis_v2022-sdk-amd64-sdk_v2022.0.ova’ saved [1751623680/1751623680]
$ vboxmanage import $OVAFILE
[...]
Successfully imported the appliance.
## Option C: VirtualBox GUI using `.vdi` disk file
- Extract the gzipped VDI image file to a local folder on your PC. The image
for the virtual machine is a single file.
......@@ -168,7 +220,7 @@ might crash).
If you would like additional information about creating a new virtual machine you can find it in the [VirtualBox manual](https://www.virtualbox.org/manual/ch01.html#gui-createvm)
{{% /notice %}}
## Option B: From the Command Line
## Option D: From the Command Line using `.vdi` disk file
- Run the following commands:
......
......@@ -6,12 +6,20 @@
{{ $variant := (.Get 3) }}
{{ $extra := (.Get 4) }}
{{ $version := (index .Site.Data.releases $release).version }}
{{ $revision := (index .Site.Data.releases $release).revision }}
{{ $scratch := newScratch }}
{{ $scratch.Set "variant" "" }}
{{ if eq $type "sdk" }}
{{ $scratch.Set "extension" ".vdi.gz" }}
{{ $basever := (substr $version 1 4) }}
{{ if gt $basever 2021 }}
{{ $scratch.Set "extension" ".ova" }}
{{ else }}
{{ $scratch.Set "extension" ".vdi.gz" }}
{{ end }}
{{ $scratch.Set "firmware" $type }}
{{ else }}
{{ $scratch.Set "extension" ".img.gz" }}
......@@ -33,7 +41,4 @@
{{ $firmware := $scratch.Get "firmware" }}
{{ $variant := $scratch.Get "variant" }}
{{ $version := (index .Site.Data.releases $release).version }}
{{ $revision := (index .Site.Data.releases $release).revision }}
{{ $baseurl }}/{{ $version }}/{{ $version }}.{{ $revision }}/{{ $arch }}/{{ $type }}/apertis{{ $variant }}_{{ $version }}-{{ $type }}-{{ $arch }}-{{ $firmware }}_{{ $version}}.{{ $revision }}{{ $extension }}
static/images/vbox-ova-1.png

227 KiB

static/images/vbox-ova-2.png

322 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment