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.

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

Inconsistent use of container and instance in instance configuration devices documentation #14451

Open
kadinsayani opened this issue Nov 12, 2024 · 1 comment · May be fixed by #14454
Open
Assignees
Labels
Documentation Documentation needs updating

Comments

@kadinsayani
Copy link
Contributor

The nouns container and instance are used interchangeably and inconsistently for the following device types:

unix-char
unix-block
usb
unix-hotplug

The usb device type is supported for both containers and VM's, implying that instance should be used when describing the device options. However, container is used for options such as gid, uid, and mode where the container condition is present.

The unix-char, unix-block, and unix-hotplug device types are only supported for containers, implying that container should be used when describing the device options. However, the word instance is used for all device options.

I think the best approach is to consistently use container for devices that are only supported for containers, and use instance for devices that are supported by both containers and VMs. For device options with the container condition present, the word instance should still be used.

@kadinsayani kadinsayani added the Documentation Documentation needs updating label Nov 12, 2024
Copy link

Heads up @mionaalex - the "Documentation" label was applied to this issue.

@kadinsayani kadinsayani changed the title Inconsistent use of container and instance in device options Inconsistent use of container and instance in instance configuration->devices documentation Nov 12, 2024
@kadinsayani kadinsayani changed the title Inconsistent use of container and instance in instance configuration->devices documentation Inconsistent use of container and instance in instance configuration devices documentation Nov 12, 2024
@kadinsayani kadinsayani self-assigned this Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Documentation needs updating
Projects
None yet
1 participant