Skip to content

Update multipass install guide #1312

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

Merged
merged 1 commit into from
Oct 11, 2024
Merged

Update multipass install guide #1312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
Binary file added content/install-guides/_images/multipass-gui.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/install-guides/_images/multipass-tray.png
View file
Open in desktop
Binary file not shown.
73 changes: 21 additions & 52 deletions content/install-guides/multipass.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,20 +49,20 @@ Multipass uses the terms virtual machine and instance synonymously.
Download Multipass for macOS.

```console
wget https://github.com/canonical/multipass/releases/download/v1.13.1/multipass-1.13.1+mac-Darwin.pkg
wget https://github.com/canonical/multipass/releases/download/v1.14.1-rc1/multipass-1.14.1-rc1+mac.14+gf2381bfe9.mac-Darwin.pkg
```

### Install

Install the download using the package command.

```console
sudo installer -pkg multipass-1.13.1+mac-Darwin.pkg -target /
sudo installer -pkg multipass-1.14.1-rc1+mac.14+gf2381bfe9.mac-Darwin.pkg -target /
```

The getting started instructions below use the command line interface. Multipass installs a tray icon for those who want to access basic features from the user interface.
The getting started instructions below use the command line interface. If you perfer to use the graphical interface start it from the macOS Launchpad, the initial screen is shown below. You can use the UI to create, start, and stop virtual machines.

![Connect #center](/install-guides/_images/multipass-tray.png)
![Connect #center](/install-guides/_images/multipass-gui.png)

Multipass is now installed. Proceed to [Get Started with Multipass](#getstarted).

Expand Down Expand Up @@ -168,10 +168,10 @@ The output from `find` will be similar to the below.

```output
Image Aliases Version Description
20.04 focal 20240626 Ubuntu 20.04 LTS
22.04 jammy 20240701 Ubuntu 22.04 LTS
23.10 mantic 20240701 Ubuntu 23.10
24.04 noble,lts 20240702 Ubuntu 24.04 LTS
20.04 focal 20240821 Ubuntu 20.04 LTS
22.04 jammy 20241002 Ubuntu 22.04 LTS
24.04 noble,lts 20241004 Ubuntu 24.04 LTS
daily:24.10 oracular,devel 20241009 Ubuntu 24.10

Blueprint Aliases Version Description
anbox-cloud-appliance latest Anbox Cloud Appliance
Expand Down Expand Up @@ -223,61 +223,30 @@ The `uname` output will look similar to:
Linux m1u 6.8.0-36-generic #36-Ubuntu SMP PREEMPT_DYNAMIC Mon Jun 10 13:20:23 UTC 2024 aarch64 aarch64 aarch64 GNU/Linux
```

### Run an application

It's helpful to demonstrate a few other common commands by downloading and installing an application. To demonstrate file copy, the download is done from macOS and the file is copied into the instance.

Download and install [OpenVSCode Server](/install-guides/openvscode-server/).

On the macOS host computer use `wget` for the download.

```console
wget https://github.com/gitpod-io/openvscode-server/releases/download/openvscode-server-v1.90.0/openvscode-server-v1.90.0-linux-arm64.tar.gz
```

To copy a file to the instance

```console
multipass transfer openvscode-server-v1.90.0-linux-arm64.tar.gz m1u:/home/ubuntu
```

Now switch to the instance and extract the download and run the application.

If you don't already have an open shell run.

```console
multipass shell m1u
```

Extract the download.

```console
tar xvfz openvscode-server-v1.90.0-linux-arm64.tar.gz
```

Run the application.

```console
./openvscode-server-v1.90.0-linux-arm64/bin/openvscode-server --host=0.0.0.0 --without-connection-token
```

Connect to OpenVSCode Server using a browser. From the macOS host computer use the `info` command to get the IP address of the instance.
### Print information

The `info` command prints information about the instance, including the IP address.

```console
multipass info m1u
```

Copy the IP address from the info output and paste it into a browser with port 3000.
The output is similar to:

Modify the IP address to use your information, for example:
```output
http://192.168.64.39:3000
Name: m1u
State: Running
Snapshots: 0
IPv4: 192.168.73.29
Release: Ubuntu 24.04.1 LTS
Image hash: e380b683b0c4 (Ubuntu 24.04 LTS)
CPU(s): 4
Load: 0.00 0.03 0.01
Disk usage: 2.0GiB out of 15.4GiB
Memory usage: 355.3MiB out of 3.8GiB
Mounts: --
```

You now have a running VS Code Server in your Multipass instance with Ubuntu 22.04 running on Arm.

### Mount a host directory

To access a large number of files on the host machine without copying or transferring them into the instance use the `mount` command. This command makes a host directory visible in the instance and all files can be accessed. Modifications made from inside the instance will directly change the files on the host.
Expand Down