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

Remove existing rauc.db from a data disk on the first boot #3737

Merged
merged 1 commit into from
Dec 12, 2024

Conversation

sairon
Copy link
Member

@sairon sairon commented Dec 12, 2024

If data disk is adopted on Yellow using the mechanism added in #3686, it contains RAUC version information that is very likely invalid. In such case, remove the file on first boot and have it recreated by the raucdb-update service.

Summary by CodeRabbit

  • New Features

    • Introduced a new systemd service for one-time operations during the first boot of the system.
  • Bug Fixes

    • Ensures the removal of the specified file on first boot if it exists.

If data disk is adopted on Yellow using the mechanism added in #3686, it
contains RAUC version information that is very likely invalid. In such case,
remove the file on first boot and have it recreated by the raucdb-update
service.
@sairon sairon added the board/yellow Home Assistant Yellow label Dec 12, 2024
@sairon sairon requested a review from agners December 12, 2024 15:04
Copy link

coderabbitai bot commented Dec 12, 2024

📝 Walkthrough

Walkthrough

A new systemd service file named raucdb-first-boot.service has been added to the project. This service is intended to perform a one-time operation during the system's first boot, specifically removing the file located at /mnt/data/rauc.db if it exists. It is configured to start after the rauc.service and before the raucdb-update.service, with dependencies ensuring that it runs only when the mount point is available and the system is in the first boot state.

Changes

File Path Change Summary
buildroot-external/rootfs-overlay/usr/lib/systemd/system/ Added new service file raucdb-first-boot.service to execute a one-time operation during the first boot, removing /mnt/data/rauc.db if it exists.

Sequence Diagram(s)

sequenceDiagram
    participant System
    participant raucService as RAUC Service
    participant raucdbFirstBoot as RAUC DB First Boot Service
    participant raucdbUpdate as RAUC DB Update Service

    System->>raucService: Start RAUC Service
    raucService-->>System: Service Running
    System->>raucdbFirstBoot: Start RAUC DB First Boot Service
    raucdbFirstBoot-->>System: Check /mnt/data/rauc.db
    alt File Exists
        raucdbFirstBoot->>System: Remove /mnt/data/rauc.db
    end
    System->>raucdbUpdate: Start RAUC DB Update Service
Loading

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. (Experiment)
  • @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

@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 (2)
buildroot-external/rootfs-overlay/usr/lib/systemd/system/raucdb-first-boot.service (2)

1-8: Consider adding additional conditions for robustness

The unit configuration looks good, but consider adding these conditions for extra safety:

  • ConditionPathIsMountPoint=/mnt/data - Explicitly verify the mount point is active
  • OnFailure=emergency.target - Handle critical failures appropriately
 [Unit]
 Description=Remove adopted rauc.db on first boot
 After=rauc.service
 Before=raucdb-update.service
 RequiresMountsFor=/mnt/data
 ConditionFirstBoot=yes
 ConditionFileNotEmpty=/mnt/data/rauc.db
+ConditionPathIsMountPoint=/mnt/data
+OnFailure=emergency.target

9-11: Enhance service configuration with status tracking and logging

Consider adding these improvements to the service configuration:

  • RemainAfterExit=yes - Helps track service completion status
  • Logging to capture operation result
 [Service]
 Type=oneshot
-ExecStart=/bin/rm -f /mnt/data/rauc.db
+RemainAfterExit=yes
+ExecStart=/bin/sh -c 'rm -f /mnt/data/rauc.db && echo "Successfully removed rauc.db" || echo "Failed to remove rauc.db"'
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7031870 and 7bb063e.

📒 Files selected for processing (1)
  • buildroot-external/rootfs-overlay/usr/lib/systemd/system/raucdb-first-boot.service (1 hunks)
🔇 Additional comments (2)
buildroot-external/rootfs-overlay/usr/lib/systemd/system/raucdb-first-boot.service (2)

13-14: Installation target looks good

The multi-user.target is appropriate for this system service.


1-14: Verify service integration in the build system

The service implementation looks correct, but let's verify its integration:

  1. Ensure the service is properly enabled in the build system
  2. Check for any conflicting services
✅ Verification successful

Service integration looks correct with proper sequencing

The service implementation and integration appear to be well-designed:

  • raucdb-first-boot.service runs after rauc.service and before raucdb-update.service
  • raucdb-update.service handles the subsequent database updates
  • Both services have proper mount requirements and target dependencies
  • No conflicting services found, the two services work together in sequence

The service ordering ensures that:

  1. On first boot, raucdb-first-boot.service removes the existing database
  2. Then raucdb-update.service creates a fresh database with version information
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if service is enabled in build system and look for potential conflicts

# Look for service enablement in build files
rg -l "raucdb-first-boot.service" buildroot-external/

# Check for other services that might interact with rauc.db
rg -l "rauc.db" buildroot-external/rootfs-overlay/usr/lib/systemd/system/

Length of output: 289


Script:

#!/bin/bash
# Let's check the content of raucdb-update.service to understand the interaction
cat buildroot-external/rootfs-overlay/usr/lib/systemd/system/raucdb-update.service

# Check if these services are enabled in any package configurations
rg -l "enable.*raucdb" buildroot-external/package/

Length of output: 379

@@ -0,0 +1,14 @@
[Unit]
Description=Remove adopted rauc.db on first boot
After=rauc.service
Copy link
Member

Choose a reason for hiding this comment

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

Why is this actually After? I see that this is the case for raucdb-update.service as well, but I am wondering? 🤔

@sairon sairon merged commit c7a9a0b into dev Dec 12, 2024
3 checks passed
@sairon sairon deleted the raucdb-first-boot branch December 12, 2024 19:44
This was referenced Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
board/yellow Home Assistant Yellow cla-signed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants