apple / apple/container

[Request]: Document --volume's three-part form ("host:guest:opts") and clarify support of other mount options, e.g. nosuid.

Open
#1,940 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Swift
Stars
49.9k
Forks
1.8k
Avg merge
1d 20h
Merged PRs (30d)
22

Description

### Feature or enhancement request details

The parser for the `--volume` flag accepts an undocumented form: `hostpath:guestpath:options`. Is this form part of the stable and supported CLI?

As far as I can tell these options are passed all the way through to the Containerization package's [Sources/ContainerizationOS/Mount/Mount.swift](https://github.com/apple/containerization/blob/2f947e76143c79e94fa5403ac74ff8d9bd9f0319/Sources/ContainerizationOS/Mount/Mount.swift), where they're mapped onto the kernel's `MS_*` flags. However, for virtiofs bind mounts the options are only applied if `ro / MS_RDONLY` is specified. If this form is part of the stable/supported CLI, is it a bug or intended behavior that other mount options, such as `nosuid`, are silently dropped without the `ro` option for virtiofs bind mounts?

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

Research direction

Start at the --volume parser and read the linked Sources/ContainerizationOS/Mount/Mount.swift to trace the three-part form and mount-option handling. Document whether hostpath:guestpath:options is supported, list the supported options, and clarify whether virtiofs dropping options such as nosuid without ro is intended or a bug.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.