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

Add support for CAP_CHECKPOINT_RESTORE privileges #2455

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

Conversation

alexander-akhmetov
Copy link

@alexander-akhmetov alexander-akhmetov commented Nov 17, 2024

Proposed change

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Removed stale or deprecated documentation

Additional information

Summary by CodeRabbit

  • Documentation
    • Updated the configuration options for add-ons, including the addition of CHECKPOINT_RESTORE as a new access privilege in the privileged key.
    • Maintained clarity and structure in the documentation for user guidance on configuration options.

Copy link
Contributor

coderabbitai bot commented Nov 17, 2024

📝 Walkthrough

Walkthrough

The changes involve updates to the docs/add-ons/configuration.md document, specifically regarding the configuration options for add-ons. The privileged key in the optional configuration options has been modified to include CHECKPOINT_RESTORE as a new access privilege. This update enhances the capabilities of add-ons related to hardware and system access. The overall structure and content of the document remain consistent, with no other significant changes made to the configuration schema or descriptions.

Changes

File Change Summary
docs/add-ons/configuration.md Updated privileged key to include CHECKPOINT_RESTORE as an available access privilege. No other significant changes made to the document structure or content.
config.yaml Configuration option updated to include CHECKPOINT_RESTORE under privileged.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AddOn
    participant Configuration

    User->>Configuration: Request configuration options
    Configuration-->>User: Provide current options
    User->>AddOn: Configure with CHECKPOINT_RESTORE
    AddOn->>Configuration: Validate configuration
    Configuration-->>AddOn: Confirm valid configuration
    AddOn-->>User: Configuration successful
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 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)
docs/add-ons/configuration.md (1)

158-158: Fix table formatting: Add trailing pipe

The table row is missing a trailing pipe character, which should be consistent with the table's style.

Apply this change:

-| `privileged` | list | | Privilege for access to hardware/system. Available access: `BPF`, `CHECKPOINT_RESTORE`, `DAC_READ_SEARCH`, `IPC_LOCK`, `NET_ADMIN`, `NET_RAW`, `PERFMON`, `SYS_ADMIN`, `SYS_MODULE`, `SYS_NICE`, `SYS_PTRACE`, `SYS_RAWIO`, `SYS_RESOURCE` or `SYS_TIME`.
+| `privileged` | list | | Privilege for access to hardware/system. Available access: `BPF`, `CHECKPOINT_RESTORE`, `DAC_READ_SEARCH`, `IPC_LOCK`, `NET_ADMIN`, `NET_RAW`, `PERFMON`, `SYS_ADMIN`, `SYS_MODULE`, `SYS_NICE`, `SYS_PTRACE`, `SYS_RAWIO`, `SYS_RESOURCE` or `SYS_TIME`. |
🧰 Tools
🪛 Markdownlint

158-158: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style

(MD055, table-pipe-style)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2e3b065 and bbd43f1.

📒 Files selected for processing (1)
  • docs/add-ons/configuration.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
docs/add-ons/configuration.md

158-158: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style

(MD055, table-pipe-style)

🔇 Additional comments (1)
docs/add-ons/configuration.md (1)

158-158: LGTM: Addition of CHECKPOINT_RESTORE privilege

The addition of CHECKPOINT_RESTORE to the privileged capabilities list is well-documented and aligns with the PR objectives. This capability allows processes to use checkpoint/restore features, which can be useful for add-ons that need to save and restore process state.

🧰 Tools
🪛 Markdownlint

158-158: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style

(MD055, table-pipe-style)

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.

1 participant