Skip to content

Fix container image detection for aarch64#5898

Merged
frenck merged 2 commits intomainfrom
fix-aarch64-container-image-attach
May 20, 2025
Merged

Fix container image detection for aarch64#5898
frenck merged 2 commits intomainfrom
fix-aarch64-container-image-attach

Conversation

@agners
Copy link
Copy Markdown
Member

@agners agners commented May 19, 2025

Proposed change

It seems that on newer Docker (e.g. 28.0.4) the container image built on the local system on an 64-bit Arm systems returns the architecture variant just like on 32-bit Arm (but v8 in this case). This is not expected by the current code. To make Supervisor detect the image correctly on new and old Docker versions, use substring matching.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionality to the supervisor)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • The code has been formatted using Ruff (ruff format supervisor tests)
  • Tests have been added to verify that the new code works.

If API endpoints or add-on configuration are added/changed:

Summary by CodeRabbit

  • Bug Fixes
    • Improved compatibility with newer Docker image architectures, including support for variant forms (e.g., arm64/v8).
    • Added logging to notify users when an image architecture mismatch is detected and the image will be reinstalled.

@agners agners added the bugfix A bug fix label May 19, 2025
@agners agners requested a review from sairon May 19, 2025 20:20
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 19, 2025

📝 Walkthrough

"""

Walkthrough

The change modifies the logic in the Docker image architecture check to better accommodate Docker versions that append variant suffixes (such as "linux/arm64/v8"). It also adds a logging statement to notify when an image architecture mismatch is detected and a reinstall is triggered. No public interfaces were changed.

Changes

File(s) Change Summary
supervisor/docker/interface.py Updated architecture comparison logic in check_image to handle variant suffixes; added logging.

Assessment against linked issues

Objective Addressed Explanation
Ensure add-ons with "Start on boot" and "Watchdog" are automatically restarted after Supervisor updates (#5886) The change only modifies Docker image architecture checking and logging, not restart logic.
"""

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between b2d2ba6 and e7d160c.

📒 Files selected for processing (1)
  • supervisor/docker/interface.py (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • supervisor/docker/interface.py
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build armv7 supervisor
  • GitHub Check: Build armhf supervisor
  • GitHub Check: Build aarch64 supervisor
  • GitHub Check: Run tests Python 3.13.3
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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
Copy Markdown
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: 2

🧹 Nitpick comments (1)
supervisor/docker/interface.py (1)

481-483: Add comments explaining ARM architecture variant handling

The comments added are helpful but could be more informative about the specific issue being fixed.

Consider enhancing the comment to include more context:

-            # It seems that newer Docker version return a variant for arm64 images.
-            # Make sure we match linux/arm64 and linux/arm64/v8.
+            # Newer Docker versions (e.g., 28.0.4) return a variant suffix for ARM64 images 
+            # (e.g., "linux/arm64/v8" instead of just "linux/arm64").
+            # Use startswith() to ensure we match both formats for compatibility.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 406348c and fc03872.

📒 Files selected for processing (1)
  • supervisor/docker/interface.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build armv7 supervisor
  • GitHub Check: Build armhf supervisor
  • GitHub Check: Build aarch64 supervisor
  • GitHub Check: Run tests Python 3.13.3
🔇 Additional comments (1)
supervisor/docker/interface.py (1)

485-490: Well-placed logging for architecture mismatch

Good addition of logging to indicate when an architecture mismatch is detected, providing clear information about what's happening and why reinstallation is triggered.

It seems that on newer Docker (e.g. 28.0.4) the container image built
on the local system on an 64-bit Arm systems returns the architecture
variant just like on 32-bit Arm (but v8 in this case). This is not
expected by the current code. To make Supervisor detect the image
correctly on new and old Docker versions, use substring matching.
@agners agners force-pushed the fix-aarch64-container-image-attach branch from fc03872 to b2d2ba6 Compare May 19, 2025 20:45
@agners
Copy link
Copy Markdown
Member Author

agners commented May 20, 2025

This really seems a BuildKit vs classic builder behavior difference, see moby/buildkit#4039 (comment).

Along with the comment:

runtimes should generally be ok with either when pulling

So this essentially changes Supervisor to be more forgiving if the Docker architecture get normalized (as in, stripping variant if the variant isn't returned normalized).

Copy link
Copy Markdown
Member

@sairon sairon left a comment

Choose a reason for hiding this comment

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

Nice find!

@frenck frenck merged commit bac7c21 into main May 20, 2025
22 checks passed
@frenck frenck deleted the fix-aarch64-container-image-attach branch May 20, 2025 08:24
@github-actions github-actions bot locked and limited conversation to collaborators May 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Not all add-ons are automatically restarted after Supervisor updates itself

3 participants