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

Fix OTBR addon does not start after updating containerd.io to 1.7.24-1 #3864

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

nodamnway
Copy link

@nodamnway nodamnway commented Dec 14, 2024

Issue

OTBR Addon fails to load with platformConfigureTunDevice() at netif.cpp:2022: Operation not permitted

I upgraded containerd.io to 1.7.24-1 on Debian 12 and this started to happen preventing the container from starting.

Logs are available here:
home-assistant/core#132124
#3826 (comment)

As a temporary solution, I downgraded to containerd.io=1.7.23-1, which worked for me and some other users.

Reason and solution

containerd/containerd#11078 (comment)

so the recommended solution is to enable the /dev/net/tun device:

devices:
  - /dev/net/tun

Testing

I only did local testing on my Home Assistant Supervised machine, such as:

  • Uninstalled OTBR addon
  • Modified /usr/share/hassio/addons/core/openthread_border_router/config.yaml by adding the /dev/net/tun to devices (and didn't bump the version, as OTBR addon won't install then)
  • Checked for updates in Add-on Store
  • installed OTBR addon again, restored config and ran it

Not sure if this is the right way to test, but it was the fastest for me and it solved my issue.

Summary by CodeRabbit

  • New Features
    • Updated configuration to include a new section for device entries.
  • Bug Fixes
    • Resolved an issue preventing the OTBR addon from starting after a specific update.
  • Chores
    • Updated the changelog to reflect the new version.

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @nodamnway

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@home-assistant home-assistant bot marked this pull request as draft December 14, 2024 07:02
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Copy link
Contributor

coderabbitai bot commented Dec 14, 2024

📝 Walkthrough

Walkthrough

The pull request updates the OpenThread Border Router (OTBR) addon configuration to version 2.12.3. The changelog highlights a resolution for an issue where the OTBR addon fails to start after a containerd.io update. The configuration file has been modified to update the version number and add a new device entry for /dev/net/tun, ensuring compatibility and potentially addressing the startup problem.

Changes

File Change Summary
openthread_border_router/CHANGELOG.md Added entry for version 2.12.3, documenting a fix for addon startup issues
openthread_border_router/config.yaml - Updated version from 2.12.2 to 2.12.3
- Added devices section with /dev/net/tun entry

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. This feature will be included in our Pro Plan when released.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
openthread_border_router/CHANGELOG.md (1)

3-6: Enhance changelog entry with implementation details

While the changelog entry correctly identifies the issue, it would be helpful to include the actual fix implemented (addition of /dev/net/tun device access). This helps users and maintainers understand the solution.

Consider updating to:

 ## 2.12.3
 
-Fix OTBR addon does not start after updating containerd.io to 1.7.24-1
+Fix OTBR addon not starting after containerd.io 1.7.24-1 update by adding /dev/net/tun device access
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f0cbc23 and 8c29088.

📒 Files selected for processing (2)
  • openthread_border_router/CHANGELOG.md (1 hunks)
  • openthread_border_router/config.yaml (2 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
openthread_border_router/CHANGELOG.md (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

openthread_border_router/config.yaml (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

🔇 Additional comments (2)
openthread_border_router/config.yaml (2)

2-2: LGTM: Version bump follows semantic versioning

Appropriate patch version increment for a configuration fix.


23-24: LGTM: Device access configuration addresses the root cause

The addition of /dev/net/tun device access is the correct fix for the OTBR startup issue with containerd.io 1.7.24-1. This aligns with the containerd GitHub issue recommendation.

Let's verify if this device is required by other addons for similar functionality:

✅ Verification successful

Device access configuration is unique to OpenThread Border Router

The verification confirms that /dev/net/tun device access is only configured in the OpenThread Border Router addon and not used by other addons in the repository, making this a targeted fix specific to OTBR's networking requirements.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for other addons that might use tun device
rg -l "/dev/net/tun" --type yaml

Length of output: 69

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant