docs(storage): add LINSTOR disk preparation guide#411
docs(storage): add LINSTOR disk preparation guide#411IvanHunters wants to merge 1 commit intomainfrom
Conversation
Add comprehensive guide for preparing physical disks for LINSTOR storage pools. Covers cleaning disk metadata, using talm for disk operations, and creating ZFS storage pools with troubleshooting section. Uses simplified LINSTOR alias commands for better readability. Signed-off-by: ohotnikov.ivan <ohotnikov.ivan@e-queo.net>
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
Summary of ChangesHello @IvanHunters, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new documentation page focused on preparing physical disks for LINSTOR storage pools. The guide aims to help users overcome challenges posed by residual metadata on disks, providing a structured approach to diagnose, clean, and configure storage. It integrates Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds a comprehensive guide for preparing disks for LINSTOR. The documentation is well-written and covers the process from diagnosis to troubleshooting. I've provided a couple of suggestions to improve clarity and consistency, such as making a command more explicit and ensuring command names are consistent throughout the document. Overall, this is a great addition to the documentation.
| # List LINSTOR satellite pods | ||
| kubectl get pod -n cozy-linstor -l app.kubernetes.io/component=linstor-satellite | ||
|
|
||
| # Check disk state | ||
| kubectl exec -n cozy-linstor <satellite-pod-name> -c linstor-satellite -- \ | ||
| lsblk -f |
There was a problem hiding this comment.
The command kubectl get pod -n cozy-linstor -l app.kubernetes.io/component=linstor-satellite lists all satellite pods, but it doesn't show which node each pod is running on. This makes it difficult for the user to select the correct pod for the node they want to inspect. Adding the -o wide flag will display the node information, making the process clearer and less error-prone.
| # List LINSTOR satellite pods | |
| kubectl get pod -n cozy-linstor -l app.kubernetes.io/component=linstor-satellite | |
| # Check disk state | |
| kubectl exec -n cozy-linstor <satellite-pod-name> -c linstor-satellite -- \ | |
| lsblk -f | |
| # List LINSTOR satellite pods and the nodes they run on | |
| kubectl get pod -n cozy-linstor -l app.kubernetes.io/component=linstor-satellite -o wide | |
| # From the output, find the pod name on the node you want to inspect. | |
| # Then, check disk state using that pod name: | |
| kubectl exec -n cozy-linstor <satellite-pod-name> -c linstor-satellite -- \ | |
| lsblk -f |
| | Command | Description | | ||
| |---------|-------------| | ||
| | `linstor sp l` | List storage pools | | ||
| | `linstor ps l` | List available physical storage | | ||
| | `linstor ps cdp zfs <node> <disks> --pool-name <name> --storage-pool <name>` | Create ZFS storage pool | | ||
| | `talm -f nodes/<node>.yaml wipe disk <disks>` | Wipe disk metadata | | ||
| | `talm -f nodes/<node>.yaml get disks` | List disks on node | |
There was a problem hiding this comment.
The quick reference table uses abbreviated linstor commands (e.g., sp l), while the rest of the guide uses full command names (e.g., storage-pool list). This inconsistency can be confusing for users. For better clarity and consistency, it's recommended to use the full command names in the table as well.
| | Command | Description | | |
| |---------|-------------| | |
| | `linstor sp l` | List storage pools | | |
| | `linstor ps l` | List available physical storage | | |
| | `linstor ps cdp zfs <node> <disks> --pool-name <name> --storage-pool <name>` | Create ZFS storage pool | | |
| | `talm -f nodes/<node>.yaml wipe disk <disks>` | Wipe disk metadata | | |
| | `talm -f nodes/<node>.yaml get disks` | List disks on node | | |
| | Command | Description | | |
| |---------|-------------| | |
| | `linstor storage-pool list` | List storage pools | | |
| | `linstor physical-storage list` | List available physical storage | | |
| | `linstor physical-storage create-device-pool zfs <node> <disks> --pool-name <name> --storage-pool <name>` | Create ZFS storage pool | | |
| | `talm -f nodes/<node>.yaml wipe disk <disks>` | Wipe disk metadata | | |
| | `talm -f nodes/<node>.yaml get disks` | List disks on node | |
1 participant
Summary
Adds comprehensive guide for preparing physical disks for LINSTOR storage pools when they contain old metadata that prevents automatic detection.
The guide covers:
This documentation helps users resolve disk detection issues during initial cluster setup or when adding new storage nodes to an existing cluster.
Documentation Location
content/en/docs/storage/disk-preparation.mdThe guide appears as the first item in the Storage section menu (weight: 5), as it's a prerequisite for other storage operations.
Key Features
linstorinstead of full kubectl exec)Related Documentation
Checklist