Add a talm.discovered.system_disk_nvme_id helper

[wasd171]

Closes #64

Summary by CodeRabbit

• New Features
  • Added a helper to reliably identify and return a stable NVMe disk path for the system disk, improving disk identification and stability during deployments.

[coderabbitai]

"""

Walkthrough

A new Helm template helper, talm.discovered.system_disk_nvme_id, was introduced in the _helpers.tpl file. This helper locates the system NVMe disk using its stable /dev/disk/by-id/nvme-<wwid> path, based on matching device name, transport type, and WWID. It includes fallback logic returning the original disk name if no suitable NVMe disk is found.

Changes

File(s)	Change Summary
charts/talm/templates/_helpers.tpl	Added talm.discovered.system_disk_nvme_id helper to find stable NVMe disk path by matching system disk name, transport "nvme", and WWID, with fallback to original disk name.

Sequence Diagram(s)

sequenceDiagram
    participant HelmTemplate as Helm Template
    participant SystemDiskNameHelper as talm.discovered.system_disk_name
    participant DiskLookup as Discovered Disks

    HelmTemplate->>SystemDiskNameHelper: Get system disk name
    SystemDiskNameHelper-->>HelmTemplate: Return disk name
    HelmTemplate->>DiskLookup: Iterate over disks
    alt Disk matches name, is NVMe, and has WWID
        HelmTemplate-->>HelmTemplate: Construct '/dev/disk/by-id/nvme-<wwid>' path
        HelmTemplate-->>Caller: Return stable NVMe disk path
    else No matching disk found
        HelmTemplate-->>Caller: Return original disk name with fallback comment
    end

Loading

Estimated code review effort

1 (<30 minutes)

Possibly related PRs

• Better system_disk discovery function #43: Modifies the logic of the existing talm.discovered.system_disk_name helper, which is closely related to the new helper for stable NVMe disk identification.
• Fix filter to show QEMU disks #47: Broadens disk selection criteria in system disk discovery, complementing the new helper that depends on system disk name resolution.

Poem

A helper was born in the Helm rabbit den,
To find NVMe disks with a stable ID pen.
It hops through the disks, checks WWID with care,
And if none is found, it falls back with flair!
Now templates are stable, with paths that won’t roam—
The rabbit’s new helper finds every disk’s home!
🐇✨
"""

---

📜 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 094dd2e and b0869f8.

📒 Files selected for processing (1)

• charts/talm/templates/_helpers.tpl (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• charts/talm/templates/_helpers.tpl

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[NickVolynkin]

@wasd171 thank you for your contribution!