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

Add --network-mode option #734

Merged
merged 1 commit into from
Feb 4, 2025
Merged

Add --network-mode option #734

merged 1 commit into from
Feb 4, 2025

Conversation

rhatdan
Copy link
Member

@rhatdan rhatdan commented Feb 4, 2025

Summary by Sourcery

New Features:

  • Added a --network-mode option to the bench, convert, push, run, and serve commands. This option allows users to specify the network mode for the container, such as host, bridge, or none.

Signed-off-by: Joshua Stone <[email protected]>
Signed-off-by: Daniel J Walsh <[email protected]>
Copy link
Contributor

sourcery-ai bot commented Feb 4, 2025

Reviewer's Guide by Sourcery

This pull request adds a --network-mode option to the CLI, allowing users to configure the network mode of the container. The default network mode is "none", effectively disabling network access. This option is added to the bench, convert, push, run, and serve subcommands. The oci.py file is modified to pass the network mode to the podman build command, and the model.py file is modified to pass the network mode to the podman run command. Documentation is updated to reflect the new option.

Sequence diagram for container execution with network mode

sequenceDiagram
    participant User
    participant CLI
    participant Model
    participant Container
    User->>CLI: Execute command with --network-mode
    CLI->>Model: setup_container(args)
    Model->>Container: Create container with network mode
    Note over Container: Network access controlled by<br/>specified network mode
    Container-->>Model: Container created
    Model-->>CLI: Setup complete
    CLI-->>User: Command execution result
Loading

Class diagram showing CLI argument changes

classDiagram
    class ArgumentParser {
        +add_argument()
    }
    class SubParsers {
        bench_parser
        convert_parser
        push_parser
        run_parser
        serve_parser
    }
    class NetworkModeOption {
        --network-mode: str
        default: str
        help: str
    }
    SubParsers --> ArgumentParser
    ArgumentParser --> NetworkModeOption
    note for NetworkModeOption "Added to all subcommands\nDefaults:\n- 'none' for most commands\n- '' for serve command"
Loading

File-Level Changes

Change Details Files
Added --network-mode argument to multiple subcommands.
  • Added --network-mode argument to the bench subcommand.
  • Added --network-mode argument to the convert subcommand.
  • Added --network-mode argument to the push subcommand.
  • Added --network-mode argument to the run subcommand.
  • Added --network-mode argument to the serve subcommand.
ramalama/cli.py
Pass the network mode to the podman build command.
  • Modified the build function to include the --network option when calling podman build.
ramalama/oci.py
Pass the network mode to the podman run command.
  • Modified the setup_container function to include the --network option when calling podman run.
ramalama/model.py
Updated documentation to reflect the new --network-mode option.
  • Added documentation for the --network-mode option in ramalama-bench.1.md.
  • Added documentation for the --network-mode option in ramalama-convert.1.md.
  • Added documentation for the --network-mode option in ramalama-push.1.md.
  • Added documentation for the --network-mode option in ramalama-run.1.md.
  • Added documentation for the --network-mode option in ramalama-serve.1.md.
docs/ramalama-bench.1.md
docs/ramalama-convert.1.md
docs/ramalama-push.1.md
docs/ramalama-run.1.md
docs/ramalama-serve.1.md

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

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

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

Overall Comments:

  • The --network-mode default value is inconsistently set to an empty string for the serve command while all other commands use 'none'. Consider changing serve to also default to 'none' for consistency.
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.

@@ -188,6 +188,8 @@ def setup_container(self, args):
if k == "CUDA_VISIBLE_DEVICES":
conman_args += ["--device", "nvidia.com/gpu=all"]
conman_args += ["-e", f"{k}={v}"]
if args.network_mode != "":
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice and simple fix :)

@ericcurtin ericcurtin merged commit 5b48748 into containers:main Feb 4, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants