Linux

This document will provide you with instructions on how to prepare and register your own template image for use with Frame. Before moving forward with the preparation procedure, please ensure you have read through the general requirements on the BYO image page and considerations below.

Considerations

• Create a template VM running a supported version of Ubuntu from an ISO or from the AWS, Azure, or GCP Marketplace.

Create an Ubuntu Template Image VM

The following instructions assume you have an Ubuntu 20.04 ISO image in your desired infrastructure. If you already have an Ubuntu VM you wish to use as the starting point for your template VM, then you can skip to the installation of the Frame Guest Agent.

1. Create a VM using your Ubuntu ISO (mounted as a CD-ROM). The VM should have at least 2 vCPUs, 8 GB memory, 40 GiB disk, and a network interface.
2. Power on the VM and access the VM through the console or via ssh.
3. Choose your language.

Ubuntu Installer - Language

2. If you are informed that there is an installer update available, choose "Continue" without updating to stay on version 20.04. You can always perform the updates later in the Sandbox.

Ubuntu Installer - Update

3. Choose your Keyboard Configuration. Choose "Done" when complete.

Ubuntu Installer - Keyboard Configuration

4. Configure your Network Connections. Choose "Done" when complete.

Ubuntu Installer - Network Connections

5. Leave the Proxy Address field blank and choose "Done" (unless the VM needs to communicate to the Internet using an outbound proxy server).

Ubuntu Installer - Proxy Server

6. Enter in your Archive Mirror address, if you have a preferred option. Choose "Done" when complete.

Ubuntu Installer - Archive Mirror

6. On the Guided storage configuration page, uncheck the Set up this disk as an LVM group option, then choose "Done".

Ubuntu Installer - Guided Storage

7. On the Storage configuration page, choose "Done".

Ubuntu Installer - Storage Configuration

8. Confirm the “destructive action” (wiping/formatting the hard disk).

Ubuntu Installer - Confirm Disk Formatting

9. Provide computer/user information.

Ubuntu Installer - Profile Setup

1. Install OpenSSH server.

Ubuntu Installer - OpenSSH

11. Do not install any add-ons.

Ubuntu Installer - No Add-Ons

12. The installation will now begin.

13. When prompted, let the security updates install.

Ubuntu Installer - Install Complete

14. Reboot when prompted.

Ubuntu Installer - Reboot

15. If prompted, press Enter to eject Ubuntu installation media.

Install Frame Guest Agent

1. Download the Frame Workload Installer (Linux) to your local machine (or within the template VM) from the Downloads page.

2. Unzip the Frame Workload Installer.

3. Untar the Frame Workload Installer tar file.

4. If you need to upload the Frame Workload Installer, use winscp to transfer the Frame Workload Installer file folder (frame_workload_installer_linux-2.0.0 folder) to the template VM. This assumes you have installed and enabled OpenSSH in your Ubuntu VM.

5. Login to the Linux VM using account specified during installation of the operating system. In the Linux VM, ls -al to verify the frame_workload_installer_linux-2.0.0 folder exists. Change directory to the folder.

6. Run sudo bash prepare.sh. Elevate if prompted.

Frame Guest Agent Workload Installer - prepare.sh

7. Upon completion, run sudo bash install.sh.

Frame Guest Agent Workload Installer - install.sh

8. Upon completion, shut down the VM.

Tag Template

You will now need to tag the template VM, image, or snapshot (depending on the infrastructure) in order for Frame control plane to be able to recognize this template image. This process is exactly the same as what is required for tagging Windows template images.

Instructions for performing tagging, by infrastructure are at:

• AHV
• AWS
• Azure
• GCP

Register Template Image

Once you have successfully created and tagged your template image(s) in your infrastructure, you will register your template image.