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

Update README.md #3630

Merged
merged 6 commits into from
Aug 20, 2024
Merged

Update README.md #3630

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f806b15
Update README.md
giuliazanchi Aug 8, 2024
344cef6
Update README.md
giuliazanchi Aug 12, 2024
7cbc41d
Update README.md
giuliazanchi Aug 12, 2024
9abcca2
Update README.md
giuliazanchi Aug 12, 2024
a803b4e
Update README.md
giuliazanchi Aug 12, 2024
350db15
Update README.md
giuliazanchi Aug 12, 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
86 changes: 46 additions & 40 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,33 +42,39 @@ Here are some pointers to get started with Multipass. For a more comprehensive l
$ multipass find

Image Aliases Version Description
core core16 20200213 Ubuntu Core 16
core18 20200210 Ubuntu Core 18
16.04 xenial 20200721 Ubuntu 16.04 LTS
18.04 bionic,lts 20200717 Ubuntu 18.04 LTS
20.04 focal 20200720 Ubuntu 20.04 LTS
daily:20.10 devel,groovy 20200721 Ubuntu 20.10
20.04 focal 20240731 Ubuntu 20.04 LTS
22.04 jammy 20240808 Ubuntu 22.04 LTS
24.04 noble,lts 20240806 Ubuntu 24.04 LTS

Blueprint Aliases Version Description
anbox-cloud-appliance latest Anbox Cloud Appliance
charm-dev latest A development and testing environment for charmers
docker 0.4 A Docker environment with Portainer and related tools
jellyfin latest Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media.
minikube latest minikube is local Kubernetes
ros-noetic 0.1 A development and testing environment for ROS Noetic.
ros2-humble 0.1 A development and testing environment for ROS 2 Humble.
```

## Launch a fresh instance of the current Ubuntu LTS

```
$ multipass launch ubuntu
$ multipass launch lts

Launching dancing-chipmunk...
Downloading Ubuntu 18.04 LTS..........
Launched: dancing chipmunk
Launched: dancing-chipmunk
```

## Check out the running instances

```
$ multipass list

Name State IPv4 Release
dancing-chipmunk RUNNING 10.125.174.247 Ubuntu 18.04 LTS
live-naiad RUNNING 10.125.174.243 Ubuntu 18.04 LTS
snapcraft-asciinema STOPPED -- Ubuntu Snapcraft builder for Core 18
Name State IPv4 Image
dancing-chipmunk Running 192.168.64.8 Ubuntu 24.04 LTS
giuliazanchi marked this conversation as resolved.
Show resolved Hide resolved
10.1.23.64 Ubuntu 24.04 LTS
phlegmatic-bluebird Stopped -- Ubuntu 22.04 LTS
docker Running 192.168.64.11 Ubuntu 22.04 LTS
172.17.0.1
```

## Learn more about an instance
Expand All @@ -77,22 +83,24 @@ snapcraft-asciinema STOPPED -- Ubuntu Snapcraft buil
$ multipass info dancing-chipmunk

Name: dancing-chipmunk
State: RUNNING
IPv4: 10.125.174.247
Release: Ubuntu 18.04.1 LTS
Image hash: 19e9853d8267 (Ubuntu 18.04 LTS)
Snapshots: 0
giuliazanchi marked this conversation as resolved.
Show resolved Hide resolved
IPv4: 192.168.64.8
10.1.23.64
Release: Ubuntu 24.04 LTS
Image hash: e2608bfdbc44 (Ubuntu 24.04 LTS)
CPU(s): 1
Load: 0.97 0.30 0.10
Disk usage: 1.1G out of 4.7G
Memory usage: 85.1M out of 985.4M
Load: 5.70 4.58 2.63
Disk usage: 3.3GiB out of 4.8GiB
Memory usage: 769.0MiB out of 953.0MiB
Mounts: --
```

## Connect to a running instance

```
$ multipass shell dancing-chipmunk

Welcome to Ubuntu 18.04.1 LTS (GNU/Linux 4.15.0-42-generic x86_64)
Welcome to Ubuntu 24.04 LTS (GNU/Linux 6.8.0-39-generic aarch64)
...
```

Expand All @@ -104,10 +112,10 @@ Don't forget to logout (or Ctrl-D) or you may find yourself heading all the way
$ multipass exec dancing-chipmunk -- lsb_release -a

No LSB modules are available.
Distributor ID: Ubuntu
Description: Ubuntu 18.04.1 LTS
Release: 18.04
Codename: bionic
Distributor ID: Ubuntu
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we make the 2nd column left aligned like the text before?

Copy link
Contributor Author

@giuliazanchi giuliazanchi Aug 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK I checked the alignment, please see if it looks correct now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now, it looks good.

Description: Ubuntu 24.04 LTS
Release: 24.04
Codename: noble
```

## Stop an instance to save resources
Expand All @@ -124,11 +132,14 @@ $ multipass delete dancing-chipmunk

The instance will now show up as deleted:

```$ multipass list
```
$ multipass list

Name State IPv4 Release
snapcraft-asciinema STOPPED -- Ubuntu Snapcraft builder for Core 18
dancing-chipmunk DELETED -- Not Available
Name State IPv4 Image
dancing-chipmunk Deleted -- Ubuntu 24.04 LTS
phlegmatic-bluebird Stopped -- Ubuntu 22.04 LTS
docker Running 192.168.64.11 Ubuntu 22.04 LTS
172.17.0.1
```

If you want to completely get rid of it:
Expand All @@ -144,17 +155,17 @@ multipass help
multipass help <command>
```

# Make your own build
# Start developing Multipass

giuliazanchi marked this conversation as resolved.
Show resolved Hide resolved
Here's a set of steps to make and run your own build of Multipass.
Here's a set of steps to build the Multipass source code on Linux.

Please note that the following instructions are for building Multipass for Linux only. These instructions do not support building packages for macOS or Windows systems.
Please note that these instructions do not support building packages for macOS or Windows systems.

## Build dependencies

```
cd <multipass>
apt install devscripts equivs
sudo apt install devscripts equivs
mk-build-deps -s sudo -i
```

Expand Down Expand Up @@ -202,12 +213,7 @@ Optionally, enable auto-complete in Bash:
source <multipass>/completions/bash/multipass
```

Finally, launch the Multipass clients:

```
<multipass>/build/bin/multipass launch --name foo # CLI client
<multipass>/build/bin/multipass.gui # GUI client
```
Now you can use the `multipass` command from your terminal (for example `<multipass>/build/bin/multipass launch --name foo`) or launch the GUI client with the command `<multipass>/build/bin/multipass.gui`.

# Contributing guidelines

Expand Down
Loading