[daemon] add MULTIPASS_STORAGE support (Fixes #1215) #1789

Saviq · 2020-10-07T10:54:02Z

No description provided.

ricab

I need to look a bit deeper, but some things I can ask already: how do you see users interfacing with this on Windows and macOS? Would we just communicate it as a stop-gap measure and give them a recipe to manually edit how the daemon is launched? Ask them to launch manually? Or would we do something in installers? How did you test it in each platform?

Saviq · 2020-10-07T12:21:38Z

how do you see users interfacing with this on Windows and macOS? Would we just communicate it as a stop-gap measure and give them a recipe to manually edit how the daemon is launched? Ask them to launch manually? Or would we do something in installers? How did you test it in each platform?

Yes, we'd document how to set this variable on each platform. System variables on Windows, launchd on macOS and systemd on Linux.

I'll write down exactly what needs doing on each platform later today.

ricab

Some questions about robustness in error cases and a couple of suggestions for portability.

src/daemon/daemon_config.cpp

Saviq

Some questions about robustness in error cases and a couple of suggestions for portability.

I kinda beat two chickens with the same stone now.

src/daemon/daemon_config.cpp

codecov · 2020-10-07T14:53:57Z

Codecov Report

Merging #1789 into master will increase coverage by 0.04%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1789      +/-   ##
==========================================
+ Coverage   76.70%   76.74%   +0.04%     
==========================================
  Files         229      229              
  Lines        8464     8472       +8     
==========================================
+ Hits         6492     6502      +10     
+ Misses       1972     1970       -2

Impacted Files	Coverage Δ
include/multipass/process/qemuimg_process_spec.h	`100.00% <ø> (ø)`
src/daemon/daemon.cpp	`32.99% <100.00%> (ø)`
src/daemon/daemon_config.cpp	`65.38% <100.00%> (+5.11%)`	⬆️
...c/platform/backends/shared/linux/backend_utils.cpp	`83.14% <100.00%> (ø)`
src/process/qemuimg_process_spec.cpp	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d9a7264...f2456c7. Read the comment docs.

Saviq · 2020-10-07T14:54:19Z

I'll write down exactly what needs doing on each platform later today.

For snap:

# as root
$ snap stop multipass
$ snap connect multipass:removable-media  # for /mnt /media https://snapcraft.io/docs/removable-media-interface
$ snap connect multipass:all-home  # for /home/* https://snapcraft.io/docs/home-interface
$ mkdir -p <path>
$ mkdir /etc/systemd/system/snap.multipass.multipassd.service.d/
$ tee /etc/systemd/system/snap.multipass.multipassd.service.d/override.conf <<EOF
[Service]
Environment=MULTIPASS_STORAGE=<path>
EOF
$ systemctl daemon-reload
$ snap start multipass

Saviq · 2020-10-08T07:43:34Z

I'll write down exactly what needs doing on each platform later today.

for macOS:

# as root
$ launchctl stop /Library/LaunchDaemons/com.canonical.multipassd.plist
$ tee /Library/LaunchDaemons/setenv.MULTIPASS_STORAGE.plist <<\EOF
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
  <key>Label</key>
  <string>setenv.MULTIPASS_STORAGE</string>
  <key>ProgramArguments</key>
  <array>
    <string>/bin/sh</string>
    <string>-c</string>
    <string>
      if [ -z "$( /bin/launchctl getenv MULTIPASS_STORAGE )" ]; then
        /bin/launchctl setenv MULTIPASS_STORAGE "<path>"
        /bin/launchctl unload /Library/LaunchDaemons/com.canonical.multipassd.plist
        /bin/launchctl load /Library/LaunchDaemons/com.canonical.multipassd.plist
      fi
    </string>
  </array>
  <key>RunAtLoad</key>
  <true/>
</dict>
</plist>
EOF
$ launchctl load /Library/LaunchDaemons/setenv.MULTIPASS_STORAGE.plist

Saviq · 2020-10-08T08:04:25Z

I'll write down exactly what needs doing on each platform later today.

for Windows:

# In Administrator's PowerShell
PS> Stop-Service Multipass
PS> Set-ItemProperty -Path "HKLM:System\CurrentControlSet\Control\Session Manager\Environment" -Name MULTIPASS_STORAGE -Value "<path>"
PS> Start-Service Multipass

Saviq · 2020-10-08T08:10:48Z

macOS build available: multipass-1.5.0-dev.358.pr1789+g3b3183e9.mac-Darwin.pkg
Linux build available: snap refresh multipass --channel edge/pr1789
Windows build available: multipass-1.5.0-dev.358.pr1789+g3b3183e9.win-win64.exe

ricab

Thanks for clarifications and updates. I am still testing, so far it looks good. Meanwhile just a suggestion for a small tweak.

src/daemon/daemon_config.cpp

Co-authored-by: Ricardo Abreu <[email protected]>

townsend2010

Would it require a lot of effort to test the changes in daemon_config.cpp to increase the coverage?

ricab

Nice, thanks for the fixmes and tests. I'm proposing a little cleanup batch for the copy-pasta in tests, but approving already.

It may be worth mentioning somewhere that uninstallers won't remove data in folders configured this way. And the command to revert the windows var:

Remove-ItemProperty -Path "HKLM:System\CurrentControlSet\Control\Session Manager\Environment" -Name MULTIPASS_STORAGE

Successfully tested with a home dir on:

linux: qemu, libvirt
macOS: hyperkit, virtualbox
windows: hyperv, virtualbox

bors d+

tests/test_qemuimg_process_spec.cpp

bors · 2020-10-08T17:52:29Z

✌️ Saviq can now approve this pull request. To approve and merge a pull request, simply reply with bors r+. More detailed instructions are available here.

Co-authored-by: Ricardo Abreu <[email protected]>

Saviq · 2020-10-08T17:55:23Z

bors r+

bors · 2020-10-08T18:19:17Z

Build failed:

macOS

fsevenm · 2021-02-23T22:47:30Z

I'll write down exactly what needs doing on each platform later today.

For snap:

# as root
$ snap stop multipass
$ snap connect multipass:removable-media  # for /mnt /media https://snapcraft.io/docs/removable-media-interface
$ snap connect multipass:all-home  # for /home/* https://snapcraft.io/docs/home-interface
$ mkdir -p <path>
$ mkdir /etc/systemd/system/snap.multipass.multipassd.service.d/
$ tee /etc/systemd/system/snap.multipass.multipassd.service.d/override.conf <<EOF
[Service]
Environment=MULTIPASS_STORAGE=<path>
EOF
$ systemctl daemon-reload
$ snap start multipass

I got errors after trying this on Ubuntu 18.04. Snapcraft cannot find the socket.

❯ snapcraft 
Launching a VM.
Build environment is in unknown state, cleaning first.
info failed: cannot connect to the multipass socket
Please ensure multipassd is running and '/var/snap/multipass/common/multipass_socket' is accessible
launch failed: cannot connect to the multipass socket                           
Please ensure multipassd is running and '/var/snap/multipass/common/multipass_socket' is accessible
An error occurred with the instance when trying to launch with 'multipass': returned exit code 2.
Ensure that 'multipass' is setup correctly and try again.

❯ ls /var/snap/multipass/common/multipass_socket
ls: cannot access '/var/snap/multipass/common/multipass_socket': No such file or directory

❯ sudo systemctl status snap.multipass.multipassd
● snap.multipass.multipassd.service - Service for snap application multipass.multipassd
   Loaded: loaded (/etc/systemd/system/snap.multipass.multipassd.service; enabled; vendor preset: enabled)
  Drop-In: /etc/systemd/system/snap.multipass.multipassd.service.d
           └─override.conf
   Active: failed (Result: exit-code) since Wed 2021-02-24 06:45:45 WITA; 26s ago
  Process: 623 ExecStart=/usr/bin/snap run multipass.multipassd (code=exited, status=1/FAILURE)
 Main PID: 623 (code=exited, status=1/FAILURE)

Feb 24 06:45:45 fsevenm systemd[1]: snap.multipass.multipassd.service: Service hold-off time over, scheduling restart.
Feb 24 06:45:45 fsevenm systemd[1]: snap.multipass.multipassd.service: Scheduled restart job, restart counter is at 5.
Feb 24 06:45:45 fsevenm systemd[1]: Stopped Service for snap application multipass.multipassd.
Feb 24 06:45:45 fsevenm systemd[1]: snap.multipass.multipassd.service: Start request repeated too quickly.
Feb 24 06:45:45 fsevenm systemd[1]: snap.multipass.multipassd.service: Failed with result 'exit-code'.
Feb 24 06:45:45 fsevenm systemd[1]: Failed to start Service for snap application multipass.multipassd.

Any help?

valentinmk · 2021-05-05T14:03:38Z

@fsevenm
First check logs with journalctl -au snap.multipass*
In my case I had
multipassd[3453]: Caught an unhandled exception: unable to create directory '/media/sdb1/multipass-volumes/cache'
Reason:
I created this directory and chown'ed it with current user. After I revert chown to root user I was able to start Multipass w/o errors.

fsevenm · 2021-05-06T04:22:14Z

@valentinmk Ok, noted. Thanks. Btw I ended up building multipass from source and it was working.

jj-owens · 2022-09-06T14:09:22Z

I ran into an issue with this as posted here: https://stackoverflow.com/q/71506189/7834131, but was able to figure out the reason the instance generation was failing. Hope this helps anyone who runs into the same issue, and apologies if this should be better shared somewhere else. If so please let me know. Thanks!

pacozaa · 2022-11-20T02:24:04Z

Can anyone write a manual/official documentation/article about using MULTIPASS_STORAGE and some explanation, please? I read through this issue but don't understand what concrete action I need to take to set VM location path to my external harddisk.

erlangparasu · 2022-11-23T09:05:11Z

Can anyone write a manual/official documentation/article about using MULTIPASS_STORAGE and some explanation, please? I read through this issue but don't understand what concrete action I need to take to set VM location path to my external harddisk.

any info? @Saviq

ricab · 2022-11-23T10:01:06Z

Hi @pacozaa, @erlangparasu, we haven't got around to writing "official" documentation for MULTIPASS_STORAGE yet because we regard it rather as a temporary measure, until we implement a proper setting. That is probably going to take a while though, so you are right that we should put something up in the docs. In the meantime, you can find instructions for each of the platforms buried above in this thread: Linux, macOS, Windows.

pacozaa · 2022-11-24T13:27:08Z

@ricab Hi, thank you so much for replying with such kindness. I really appreciate it.

Just for confirmation, I can do
export MULTIPASS_STORAGE=[absolute path to the location]

and follow the thread above? Is that correct?

ricab · 2022-11-24T13:38:29Z

Hey @pacozaa, you're welcome!

Just for confirmation, I can do
export MULTIPASS_STORAGE=[absolute path to the location]

Not exactly. That would set the variable only in the shell you entered it in, along with its children. You need it to be set in the environment that the Multipass daemon gets when it is started. That is what the recipes above are for. So you don't need to set the variable in a shell.

pacozaa · 2022-11-24T13:56:49Z

@ricab Ahh for macOS, it's the line /bin/launchctl setenv MULTIPASS_STORAGE "<path>".

I will change "<path>" to the location I want then. Thank you so much.

Saviq · 2022-11-24T16:37:36Z

it's the line /bin/launchctl setenv MULTIPASS_STORAGE "<path>".

I will change "<path>" to the location I want then. Thank you so much.

@pacozaa note this doesn't survive reboots, which is why there's the plist service that sets it on boot.

pacozaa · 2022-11-26T02:40:11Z

macOS build available: multipass-1.5.0-dev.358.pr1789+g3b3183e9.mac-Darwin.pkg Linux build available: snap refresh multipass --channel edge/pr1789 Windows build available: multipass-1.5.0-dev.358.pr1789+g3b3183e9.win-win64.exe

I can't download this from the link for macOS. I got XML <Code>AccessDenied</Code> from aws s3.

@Saviq Is it available for the public yet?

Saviq · 2022-11-26T07:19:17Z

@Saviq Is it available for the public yet?

It's on stable.

pacozaa · 2022-11-26T14:36:50Z

@Saviq How do I download it? I tried to switch the branch to stable and here https://github.com/canonical/multipass/releases
I still can't find a way to download it. Or Do I need to build stable from the source on my machine?

Saviq · 2022-11-26T14:38:02Z

@Saviq How do I download it? I tried to switch the branch to stable and here https://github.com/canonical/multipass/releases
I still can't find a way to download it. Or Do I need to build stable from the source on my machine?

https://multipass.run/docs/installing-on-macos

pacozaa · 2022-11-27T06:27:38Z

@Saviq How do I download it? I tried to switch the branch to stable and here https://github.com/canonical/multipass/releases
I still can't find a way to download it. Or Do I need to build stable from the source on my machine?

https://multipass.run/docs/installing-on-macos

I tried this one but it doesn't install 1.5.0 version for me.

Here is a list of what I tried
brew install --cask [email protected]
brew install --cask [email protected]
brew install --cask multipass@stable

All of them don't work for me. Maybe @ricab Would you mind helping out? Thank you guys a lot.

Saviq · 2022-11-27T07:26:44Z

@pacozaa why are you trying to install an old version? Just use the latest. It didn't lose support for the storage variable…

pacozaa · 2022-11-27T07:51:23Z

@Saviq Sorry I thought 1.5.0 is newer than 1.10.0. All good now. Thanks again.

Saviq requested a review from ricab October 7, 2020 10:54

ricab reviewed Oct 7, 2020

View reviewed changes

ricab requested changes Oct 7, 2020

View reviewed changes

src/daemon/daemon_config.cpp Outdated Show resolved Hide resolved

src/daemon/daemon_config.cpp Outdated Show resolved Hide resolved

src/daemon/daemon_config.cpp Outdated Show resolved Hide resolved

Saviq changed the title ~~[daemon] add MULTIPASS_STORAGE support (Fixes #1215)~~ [daemon] add MULTIPASS_STORAGE support (Fixes: #1215) Oct 7, 2020

Saviq changed the title ~~[daemon] add MULTIPASS_STORAGE support (Fixes: #1215)~~ [daemon] add MULTIPASS_STORAGE support (Fixes #1215) Oct 7, 2020

Saviq force-pushed the support-multipass-storage branch from 1939cbb to d1511c7 Compare October 7, 2020 14:23

Saviq commented Oct 7, 2020

View reviewed changes

src/daemon/daemon_config.cpp Outdated Show resolved Hide resolved

src/daemon/daemon_config.cpp Outdated Show resolved Hide resolved

[daemon] add MULTIPASS_STORAGE support (Fixes #1215)

8d1a034

Saviq force-pushed the support-multipass-storage branch from d1511c7 to 8d1a034 Compare October 7, 2020 14:36

Saviq mentioned this pull request Oct 8, 2020

Add configure option to use different vault location #1215

Closed

ricab reviewed Oct 8, 2020

View reviewed changes

src/daemon/daemon_config.cpp Outdated Show resolved Hide resolved

src/daemon/daemon_config.cpp Outdated Show resolved Hide resolved

src/daemon/daemon_config.cpp Outdated Show resolved Hide resolved

src/daemon/daemon_config.cpp Outdated Show resolved Hide resolved

[daemon] only ::fromUtf8 once

51d21da

Co-authored-by: Ricardo Abreu <[email protected]>

Saviq force-pushed the support-multipass-storage branch from 19cfd19 to dc256bb Compare October 8, 2020 12:03

[apparmor] explicitly allow qemu-img image paths

97a70c3

Saviq force-pushed the support-multipass-storage branch from dc256bb to 97a70c3 Compare October 8, 2020 12:57

townsend2010 reviewed Oct 8, 2020

View reviewed changes

[tests] add DaemonConfig tests for data/cache

365cb77

ricab approved these changes Oct 8, 2020

View reviewed changes

[tests] leftover cleanup

f2456c7

Co-authored-by: Ricardo Abreu <[email protected]>

Saviq merged commit 0e74ed7 into master Oct 8, 2020

bors bot deleted the support-multipass-storage branch October 8, 2020 19:12

ricab mentioned this pull request Nov 30, 2020

Add check for available disk space on launch #1854

Merged

ricab mentioned this pull request Jan 4, 2021

[FEATURE] Choose disk location and change size of instance + cache apt/apt-get + change method install multipass on ubuntu #1898

Closed

Saviq mentioned this pull request Jan 29, 2021

[macOS] Can't multipass launch behind CNTLM proxy #1947

Open

This was referenced Feb 24, 2021

[linux] daemon fails to start after setting MULTIPASS_STORAGE #1981

Closed

How to use VM that was created with hyperkit after switch to virtualbox driver? #1984

Closed

Saviq mentioned this pull request Mar 23, 2021

Multipass doesn't find the file multipass_cert_key.pem #2023

Closed

Saviq mentioned this pull request Jul 19, 2021

Multipass ignores configured hypervisor settings and defaults to hyper-v on windows #2179

Closed

shabiel mentioned this pull request Jul 23, 2021

Multipass snap cannot store data in mounted folder #2184

Closed

Saviq mentioned this pull request Jan 11, 2022

Consider a different location for Multipass files on macOS #566

Open

msojocs mentioned this pull request Feb 7, 2022

软件包构建与发布 msojocs/wechat-web-devtools-linux#5

Closed

14 tasks

wolfenstein87 mentioned this pull request Aug 17, 2022

Caught an unhandled exception: unable to create directory '/data/cache' #2709

Closed

sharder996 mentioned this pull request Dec 1, 2022

I want to know how multipass can change the storage directory where the instance is created #2843

Closed

[daemon] add MULTIPASS_STORAGE support (Fixes #1215) #1789

[daemon] add MULTIPASS_STORAGE support (Fixes #1215) #1789

Uh oh!

Conversation

Saviq commented Oct 7, 2020

Uh oh!

ricab left a comment

Choose a reason for hiding this comment

Uh oh!

Saviq commented Oct 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ricab left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Saviq left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Oct 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Saviq commented Oct 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Saviq commented Oct 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Saviq commented Oct 8, 2020

Uh oh!

Saviq commented Oct 8, 2020

Uh oh!

ricab left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

townsend2010 left a comment

Choose a reason for hiding this comment

Uh oh!

ricab left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bors bot commented Oct 8, 2020

Uh oh!

Saviq commented Oct 8, 2020

Uh oh!

bors bot commented Oct 8, 2020

Uh oh!

fsevenm commented Feb 23, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

valentinmk commented May 5, 2021

Uh oh!

fsevenm commented May 6, 2021

Uh oh!

jj-owens commented Sep 6, 2022

Uh oh!

pacozaa commented Nov 20, 2022

Uh oh!

erlangparasu commented Nov 23, 2022

Uh oh!

ricab commented Nov 23, 2022

Uh oh!

pacozaa commented Nov 24, 2022

Uh oh!

ricab commented Nov 24, 2022

Saviq commented Oct 7, 2020 •

edited

Loading

codecov bot commented Oct 7, 2020 •

edited

Loading

Saviq commented Oct 7, 2020 •

edited

Loading

Saviq commented Oct 8, 2020 •

edited

Loading

fsevenm commented Feb 23, 2021 •

edited

Loading