Described Virtual Box setup in user guide (#236)

doc/changes/changes_1.1.0.md

@@ -27,6 +27,7 @@ n/a
 ## Documentation
 
 * 204: Updated developer guide
+* #219: Described Virtual Box setup in user guide
 
 ## Refactoring
 

doc/developer_guide/aws.md

@@ -62,7 +62,7 @@ The bucket has private access. In order to control access, the Bucket cloudforma
 The following diagram shows the involved cloudformation stacks:
 ![image info](./img/cloudformation-stacks.drawio.png)
 
-The following resources are permanent and need to be deployed using the "deploy" [commands](#deployment-commands):
+The following resources are permanent and need to be deployed using the "deploy" [commands](commands.md#deployment-commands):
 * `DATA-SCIENCE-SANDBOX-VM-Bucket`
 * `DATA-SCIENCE-SANDBOX-CI-TEST-CODEBUILD`
 * `DATA-SCIENCE-SANDBOX-RELEASE-CODEBUILD`

doc/user_guide/editions.md

@@ -10,11 +10,11 @@ Recommendations
 * When you want to use the VM Edition then select an appropriate VM image format depending on the Hypervisor software available on your system.
 
 
-| Description                              | Format(s)                                                                |
-|------------------------------------------|--------------------------------------------------------------------------|
-| [AMI Edition](ami-usage.md)              | Amazon Machine Image (AMI)                                               |
-| [Docker Edition](docker/docker-usage.md) | Docker Image                                                             |
-| [Virtual Machine Edition](vm-usage.md)   | VMware Virtual Machine Disk (VMDK), Virtual Hard Disk by Microsoft (VHD) |
+| Description                                       | Format(s)                                                                |
+|---------------------------------------------------|--------------------------------------------------------------------------|
+| [AMI Edition](ami-usage.md)                       | Amazon Machine Image (AMI)                                               |
+| [Docker Edition](docker/docker-usage.md)          | Docker Image                                                             |
+| [Virtual Machine Edition](vm-edition/vm-usage.md) | VMware Virtual Machine Disk (VMDK), Virtual Hard Disk by Microsoft (VHD) |
 
 Each of the editions is associated with an _image_ in a specific format.
 

doc/user_guide/vm-usage.md → doc/user_guide/vm-edition/qemu.md

@@ -1,31 +1,10 @@
-# AI-Lab Virtual Machine Edition
-
-The AI-Lab Virtual Machine Edition offers two different VM images
-* VMware Virtual Machine Disk (VMDK)
-* Virtual Hard Disk by Microsoft (VHD)
-
-The following table shows which Hypervisor supports which image formats:
-
-| Hypervisor          | VMDK | VHD |
-|---------------------|------|-----|
-| VMWare work station | yes  | ?   |
-| Virtual box         | yes  | yes |
-| Hyper-V             | ?    | yes |
-| WSL 2               | ?    | ?   |
-
-Notes for Hypervisors based on KVM/[QEMU](https://en.wikipedia.org/wiki/QEMU):
-* There multiple alternative UIs, see https://en.wikipedia.org/wiki/Libvirt#User_Interfaces.
-* File in format VHD or VMDK needs to be converted first, see
-  * https://docs.openstack.org/image-guide/convert-images.html
-   * https://linux.die.net/man/1/qemu-img
-
 ## Boxes (QEMU) on Linux operating system
 
 ### Overview
 
 1. Open the `VMDK` image
 2. Select Ubuntu 20.04 LTS as template
-3. [Configure RAM](system-requirements.md)
+3. [Configure RAM](../system-requirements.md)
 4. Start the VM
 
 ### Step-by-step
@@ -42,15 +21,10 @@ Notes for Hypervisors based on KVM/[QEMU](https://en.wikipedia.org/wiki/QEMU):
 ![image info](./img/tutorial-screenshot-select-resources.png)
 8. The image will be imported and then will automatically start
 ![image info](./img/tutorial-screenshot-importing.png)
-9. See section [Login](#login) about how to login
+9. See section [Login](vm-usage.md#login) about how to login
 10. If you want to connect to the Jupyterlab, you need to find out the IP address of the VM:
 - Click the 3 dots in Boxes, then preferences<br />
 ![image info](./img/tutorial-screenshot-open-preferences.png)
 - Then the IP address will be shown:<br />
 ![image info](./img/tutorial-screenshot-show-ip.png)
-- Use _IP-Address_:49494 to connect to the [Jupterlab](jupyter.md#open-jupyter-in-your-browser)
-
-
-## Login
-
-See [Log in to AMI and VM Editions](login-vm-and-ami.md) for logging into the system.
+- Use _IP-Address_:49494 to connect to the [Jupterlab](../jupyter.md#open-jupyter-in-your-browser)

doc/user_guide/vm-edition/vm-usage.md

@@ -0,0 +1,29 @@
+# AI-Lab Virtual Machine Edition
+
+The AI-Lab Virtual Machine Edition offers two different VM images
+* VMware Virtual Machine Disk (VMDK)
+* Virtual Hard Disk by Microsoft (VHD)
+
+The following table shows which Hypervisor supports which image formats:
+
+| Hypervisor          | VMDK | VHD |
+|---------------------|------|-----|
+| VMWare work station | yes  | ?   |
+| Virtual box         | yes  | yes |
+| Hyper-V             | ?    | yes |
+| WSL 2               | ?    | ?   |
+
+Notes for Hypervisors based on KVM/[QEMU](https://en.wikipedia.org/wiki/QEMU):
+* There multiple alternative UIs, see https://en.wikipedia.org/wiki/Libvirt#User_Interfaces.
+* File in format VHD or VMDK needs to be converted first, see
+  * https://docs.openstack.org/image-guide/convert-images.html
+   * https://linux.die.net/man/1/qemu-img
+
+## Instructions for specific operating systems and hypervisors
+
+* [Boxes (QEMU) on Linux operating system](qemu.md)
+* [Importing image format VMDK into Oracle Virtual Box on Windows](win-vbox.md)
+
+## Login
+
+See [Log in to AMI and VM Editions](../login-vm-and-ami.md) for logging into the system.

doc/user_guide/vm-edition/win-vbox.md

@@ -0,0 +1,50 @@
+# Importing image format VMDK into Oracle Virtual Box on Windows
+
+## Preparation
+
+* [Download the VMDK image file](https://github.com/exasol/ai-lab/releases) for the latest version of the AI-Lab VM Edition
+* Download Oracle Virtual Box
+* Start Windows application _Oracle Virtual Box_
+
+## Select Virtual machine Name and Operating System
+
+* Create a new virtual machine
+* Enter a name for your virtual machine, e.g. "Exasol-AI-Lab-1.0.0"
+* Select a folder to store the VM image to
+* Select operating system "Linux", e.g. version "Ubuntu 22.04"
+* Click button "Next"
+
+![](img/win-vbox/1.png)
+
+## Select Hardware
+
+* Select Base Memory > 8000 MB
+* Select > 2 CPUs
+* Click button "Next"
+
+![](img/win-vbox/2.png)
+
+## Select  Virtual Hard disk
+
+* Select "Use an Existing Virtual Hard Disk File"
+* Select the path to the AI-Lab vmk image file
+
+![](img/win-vbox/3.png)
+
+## Review Summary
+
+![](img/win-vbox/4.png)
+
+## Adjust Network Settings in Oracle Virtual Box Manager
+
+* Check "Enable Network Adapter"
+* For "Attached to" select "NAT"
+* Select your Adapter Type, MAC Address, and maybe "Cable Connected"
+* Click button "Port Forwarding"
+* Forward port 49494 or the virtual machine to the same or any other free port on your Host machine
+
+![](img/win-vbox/5.png)
+
+## Run the Virtual Machine
+
+![](img/win-vbox/6.png)