Skip to content

Migrate add-on data out of Home Assitant config dir #556

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

felipecrs
Copy link

@felipecrs felipecrs commented Mar 16, 2025

Proposed Changes

(Describe the changes and rationale behind them)

This PR adds support for addon config to Glances, and migrates the config out of Home Assistant config dir into the addon config dir.

Related Issues

Closes #543

Refs home-assistant/supervisor#4650

Summary by CodeRabbit

  • New Features
    • Updated configuration mapping to streamline settings management.
    • Introduced an automated migration process that relocates configuration files from the Home Assistant setup to the Glances add-on configuration, ensuring a smoother transition and improved consistency for users.

Copy link

coderabbitai bot commented Mar 16, 2025

Walkthrough

The changes update the configuration mapping by renaming an entry and adding a new one to support configuration migration. Additionally, a new migration routine in the startup script checks for legacy configuration files and, when needed, moves them from the Home Assistant directory to the add-on configuration directory with error handling. These modifications ensure that configuration files are updated and migrated without altering the existing core functionality.

Changes

File Change Summary
glances/config.yaml Renamed config:rw to addon_config:rw; added homeassistant_config:rw to facilitate migration.
glances/rootfs/etc/cont-init.d/glances.sh Introduced migration logic to move configuration files from /homeassistant/glances/ to /config/ with error handling.

Sequence Diagram(s)

sequenceDiagram
    participant S as Startup Script
    participant HA as Home Assistant Config
    participant ADDON as Addon Config
    S->>HA: Check for /homeassistant/glances/glances.conf
    S->>ADDON: Check if /config/glances.conf exists
    alt Legacy config exists and no target file
      S->>HA: Enable dotglob and move files from HA to ADDON
      ADDON-->>S: Migration successful
    else
      S-->>S: Skip migration
    end
Loading

Assessment against linked issues

Objective Addressed Explanation
Migrate addon configuration to /addon_configs/ (#543)

Poem

I'm a rabbit on a coding spree,
Hopping through changes merrily.
Configs are renamed and files migrate,
A joyful leap—vintage to innovate!
Carrots and code, all in harmony.
🥕💻

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bf01cae and 2d30489.

📒 Files selected for processing (1)
  • glances/rootfs/etc/cont-init.d/glances.sh (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • glances/rootfs/etc/cont-init.d/glances.sh

🪧 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.
  • @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 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: 1

🧹 Nitpick comments (1)
glances/config.yaml (1)

25-29: Mapping Updates for Configuration Migration

You've updated the mapping by replacing the previous config:rw with addon_config:rw and added a new entry homeassistant_config:rw # to enable migration to addon_config. This clearly indicates the new structure and supports the migration process.
Please ensure that the mount points specified here match the filesystem paths used later in the migration script.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6c66945 and 1a11dae.

📒 Files selected for processing (2)
  • glances/config.yaml (1 hunks)
  • glances/rootfs/etc/cont-init.d/glances.sh (1 hunks)

Copy link

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

@github-actions github-actions bot added the stale There has not been activity on this issue or PR for quite some time. label Apr 16, 2025
@dm82m
Copy link

dm82m commented Apr 16, 2025

@frenck what about integrating this one? Also commenting to prevent it from getting stale.

@github-actions github-actions bot removed the stale There has not been activity on this issue or PR for quite some time. label Apr 17, 2025
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.

Migrate addon configuration to /addon_configs/
2 participants