Add run and serve arguments for --device and --privileged #809

cgruver · 2025-02-13T18:48:25Z

Removed RAMALAMA_DEVICE for --device override in favor of a --device argument.

Added --privileged argument to satisfy the desired outcome of #572

Added the ability to pass multiple instances of --device /dev/some/device to allow users to explicitly define which devices to leak into the container.

--device and --privileged are arguments of ramalama run|serve

Summary by Sourcery

Add the --device and --privileged options to the run and serve commands. Allow multiple devices to be passed to the --device argument. Replace the RAMALAMA_DEVICE environment variable with the new --device argument.

New Features:

Add --device and --privileged arguments to the ramalama run and ramalama serve commands. The --device argument allows for passing multiple device paths to expose to the container. The --privileged argument grants extended privileges to the container.
Replace the RAMALAMA_DEVICE environment variable with the --device argument for specifying devices to make available within the container during model serving or running. Multiple --device arguments can be provided to specify multiple devices

Signed-off-by: Charro Gruver <[email protected]>

sourcery-ai · 2025-02-13T18:48:30Z

Reviewer's Guide by Sourcery

This pull request introduces the --device and --privileged arguments to the run and serve subcommands. The --device argument allows users to specify devices to be leaked into the container, replacing the previous environment variable method. The --privileged argument grants extended privileges to the container.

Sequence diagram for container setup with device argument

sequenceDiagram
    participant CLI as Command Line Interface
    participant Model as Model
    participant ContainerManager as Container Manager

    CLI->>Model: run(args)
    Model->>Model: setup_container(args)
    alt args.device is present
        loop for each device in args.device
            Model->>ContainerManager: Add --device device_arg to container arguments
        end
    else args.device is not present
        alt System is MacOS or /dev/dri exists
            Model->>ContainerManager: Add --device /dev/dri to container arguments
        end
    end
    Model->>ContainerManager: Create and start container

Updated class diagram for CLI arguments

classDiagram
    class ArgumentParser {
        +add_argument(name: str, dest: str, action: str, type: str, help: str)
    }

    class _run {
        +--device: str[]
        +--privileged: bool
    }

    ArgumentParser -- _run : Adds arguments to

    note for _run "Added --device and --privileged arguments"

File-Level Changes

Change	Details	Files
Introduced the `--device` argument to specify devices to be leaked into the container.	Added `--device` argument to the `run` and `serve` subcommands. The `--device` argument accepts multiple instances, allowing users to specify multiple devices. Replaced the environment variable `RAMALAMA_DEVICE` with the `--device` argument for device specification.	`ramalama/cli.py` `ramalama/model.py`
Added the `--privileged` argument to grant extended privileges to the container.	Added `--privileged` argument to the `run` and `serve` subcommands. The `--privileged` argument is a boolean flag that enables privileged mode for the container.	`ramalama/cli.py`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @cgruver - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding the --privileged argument to the serve subcommand as well.
It might be helpful to include a brief example of how to use the --device argument in the help text.

Here's what I looked at during the review

🟢 General issues: all looks good
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

cgruver · 2025-02-13T18:50:11Z

@ericcurtin Here's my attempt to complete #572 and add --device

@rhatdan I satisfied your ask to make the arguments part of the subcommands run and serve rather than global.

I will add docs for these if we like this approach.

cgruver · 2025-02-13T18:59:12Z

Looks like I broke the tests. Need to update the appropriate .md docs.

Signed-off-by: Charro Gruver <[email protected]>

rhatdan · 2025-02-13T19:32:16Z

docs/ramalama-run.1.md

@@ -43,6 +46,9 @@ name of the container to run the Model in
 #### **--network**=*none*
 set the network mode for the container

+#### **--privileged**
+give extended privileges to container


By default, RamaLama containers are unprivileged (=false) and cannot, for example, modify parts of the operating system. This is because by de‐ fault a container is only allowed limited access to devices. A "privi‐ leged" container is given the same access to devices as the user launch‐ ing the container, with the exception of virtual consoles (/dev/tty\d+) when running in systemd mode (--systemd=always). A privileged container turns off the security features that isolate the container from the host. Dropped Capabilities, limited devices, read- only mount points, Apparmor/SELinux separation, and Seccomp filters are all disabled. Due to the disabled security features, the privileged field should almost never be set as containers can easily break out of confinement. Containers running in a user namespace (e.g., rootless containers) can‐ not have more privileges than the user that launched them.

Please add this, from Podman man pages.

rhatdan · 2025-02-13T19:39:16Z

docs/ramalama-serve.1.md

@@ -46,6 +46,9 @@ The default is TRUE. The --nocontainer option forces this option to False.

 Use the `ramalama stop` command to stop the container running the served ramalama Model.

+#### **--device**
+declare host device to leak into the container 


Add something like.

Add a host device to the container. Optional permissions parameter can be used to specify device permissions by combining r for read, w for write, and m for mknod(2). Example: --device=/dev/sdc:/dev/xvdc:rwm. The device specifiaction is passed directly to the underlying container engine. See documentation of the supported container engine for more information.

rhatdan · 2025-02-13T19:39:25Z

docs/ramalama-serve.1.md

@@ -70,6 +73,9 @@ set the network mode for the container
 #### **--port**, **-p**
 port for AI Model server to listen on

+#### **--privileged**
+give extended privileges to container


rhatdan · 2025-02-13T19:39:50Z

ramalama/model.py

-        if device_override != 1:
+        if args.device:
+            for device_arg in args.device:
+                print(device_arg)


This looks like debug line.

Oops... yes it is... :-)

rhatdan · 2025-02-13T19:40:46Z

ramalama/cli.py

@@ -233,6 +233,12 @@ def configure_arguments(parser):
        help="store AI Models in the specified directory",
    )
    parser.add_argument("-v", "--version", dest="version", action="store_true", help="show RamaLama version")
+    # parser.add_argument("--device",


Either turn this code on or delete it.

Signed-off-by: Charro Gruver <[email protected]>

rhatdan · 2025-02-13T20:38:46Z

LGTM

Add run and serve arguments for --device and --privileged

b396ef8

Signed-off-by: Charro Gruver <[email protected]>

cgruver requested review from rhatdan, ericcurtin, bmahabirbu, maxamillion, swarajpande5, jhjaggars, slp and engelmi as code owners February 13, 2025 18:48

sourcery-ai bot reviewed Feb 13, 2025

View reviewed changes

Add --privileged and --device args to the appropriate docs

483f229

Signed-off-by: Charro Gruver <[email protected]>

rhatdan reviewed Feb 13, 2025

View reviewed changes

Changes to satisfy code review

07bc341

Signed-off-by: Charro Gruver <[email protected]>

cgruver requested a review from rhatdan February 13, 2025 19:58

rhatdan merged commit 33fef31 into containers:main Feb 13, 2025
16 checks passed

cgruver deleted the arg-parse branch February 13, 2025 20:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add run and serve arguments for --device and --privileged #809

Add run and serve arguments for --device and --privileged #809

cgruver commented Feb 13, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 13, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

cgruver commented Feb 13, 2025

cgruver commented Feb 13, 2025

rhatdan Feb 13, 2025

rhatdan Feb 13, 2025

rhatdan Feb 13, 2025

rhatdan Feb 13, 2025

rhatdan Feb 13, 2025

cgruver Feb 13, 2025

rhatdan Feb 13, 2025

rhatdan commented Feb 13, 2025

Add run and serve arguments for --device and --privileged #809

Add run and serve arguments for --device and --privileged #809

Conversation

cgruver commented Feb 13, 2025 • edited by sourcery-ai bot Loading

Summary by Sourcery

sourcery-ai bot commented Feb 13, 2025 • edited Loading

Reviewer's Guide by Sourcery

Sequence diagram for container setup with device argument

Updated class diagram for CLI arguments

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

cgruver commented Feb 13, 2025

cgruver commented Feb 13, 2025

rhatdan Feb 13, 2025

Choose a reason for hiding this comment

rhatdan Feb 13, 2025

Choose a reason for hiding this comment

rhatdan Feb 13, 2025

Choose a reason for hiding this comment

rhatdan Feb 13, 2025

Choose a reason for hiding this comment

rhatdan Feb 13, 2025

Choose a reason for hiding this comment

cgruver Feb 13, 2025

Choose a reason for hiding this comment

rhatdan Feb 13, 2025

Choose a reason for hiding this comment

rhatdan commented Feb 13, 2025

cgruver commented Feb 13, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 13, 2025 •

edited

Loading