Add information on configuring the libkrun machine provider

[rhatdan]

Summary by Sourcery

Add documentation for configuring Podman machine on MacOS with libkrun for GPU acceleration

New Features:

• Introduce comprehensive documentation for MacOS users on configuring Podman machine with libkrun

Enhancements:

• Improve user guidance for GPU configuration on MacOS
• Add more detailed instructions for setting up GPU acceleration in Podman

Documentation:

• Create a new MacOS-specific manual page (ramalama-macos.7.md) detailing how to configure Podman machine with libkrun for GPU support
• Update existing documentation to reference the new MacOS-specific manual page and clarify GPU configuration instructions

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds documentation and guidance for configuring the libkrun machine provider on macOS to enable GPU acceleration within VMs. It introduces a new man page, ramalama-macos.7.md, detailing the configuration process and updates existing documentation to reference the new page and provide relevant warnings. The changes involve modifications to the ramalama.1.md man page and the common.py script.

Sequence Diagram for GPU Support Warning

sequenceDiagram
  participant User
  participant ramalama
  participant common.py

  User->>ramalama: Executes ramalama command
  ramalama->>common.py: Calls confirm_no_gpu(name, provider)
  common.py->>User: Displays warning about missing GPU support with current provider
  User->>common.py: Responds with 'yes' or 'no'
  alt User responds with 'yes'
    common.py->>ramalama: Continues execution without GPU
  else User responds with 'no'
    common.py->>ramalama: Exits
  end

Loading

File-Level Changes

Change	Details	Files
Added a new man page, ramalama-macos.7.md, to provide instructions on configuring Podman machines on macOS to use the libkrun provider for GPU acceleration.	Created a new man page ramalama-macos.7.md. Documented methods for configuring the libkrun provider using containers.conf, environment variables, and ramalama.conf. Added instructions for creating a Podman Machine with libkrun via Podman Desktop. Included important notes about using libkrun on macOS and links to relevant documentation.	docs/ramalama-macos.7.md
Updated the ramalama.1.md man page to reference the new ramalama-macos.7.md man page and clarify the libkrun requirement for GPU usage on macOS with Podman.	Replaced the reference to krunkit VM Type with libkrun machine provider. Added a link to the new ramalama-macos.7.md man page. Added ramalama-macos.7.md to the SEE ALSO section.	docs/ramalama.1.md
Modified common.py to include a reference to the ramalama-macos man page in the warning message when a VM without GPU support is detected.	Added the sentence "See man ramalama-macos for more information." to the warning message.	ramalama/common.py

Possibly linked issues

• Resolve undefined errors in huggingface.py and model.py #123: The PR adds documentation related to libkrun, which is relevant to the issue about podman machine detection.
• Resolve undefined errors in huggingface.py and model.py #123: The PR adds documentation guiding users on how to configure libkrun, addressing the lack of clear error reported in the issue.

---

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!

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 @rhatdan - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding a link to the libkrun documentation in ramalama-macos.7.md.
• The new man page ramalama-macos.7.md has an incorrect date in the HISTORY section.

Here's what I looked at during the review

• 🟡 General issues: 2 issues found
• 🟢 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

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

[ericcurtin]

maybe "arm-based macOS" or something like this sounds better

[rhatdan]

@ericcurtin PTANL