Added a documentation on how to install Simplyblock on a Talos-based Kubernetes cluster#408
Open
noctarius wants to merge 6 commits intosiderolabs:mainfrom
Open
Added a documentation on how to install Simplyblock on a Talos-based Kubernetes cluster#408noctarius wants to merge 6 commits intosiderolabs:mainfrom
noctarius wants to merge 6 commits intosiderolabs:mainfrom
Conversation
…Kubernetes cluster
There was a problem hiding this comment.
Pull request overview
Adds a new Kubernetes CSI guide documenting how to install Simplyblock (control plane, storage plane, and CSI driver) on a Talos-based Kubernetes cluster, and wires it into the docs navigation so it appears in the CSI section.
Changes:
- Added a new MDX guide:
simplyblock-storage.mdxcovering preparation (kernel modules, hugepages, namespace) and installation/cleanup steps. - Updated docs navigation (
public/docs.jsonandkubernetes-guides.yaml) to include the new guide under CSI.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| public/kubernetes-guides/csi/simplyblock-storage.mdx | New Talos-focused Simplyblock installation guide (control plane, storage plane, CSI, cleanup, references). |
| public/docs.json | Adds the Simplyblock guide route to the CSI navigation list. |
| kubernetes-guides.yaml | Adds the Simplyblock guide to the CSI pages list for the docs navigation. |
Comments suppressed due to low confidence (2)
public/kubernetes-guides/csi/simplyblock-storage.mdx:16
- The product name is capitalized inconsistently in this paragraph ("Simplyblock" vs "simplyblock"). For clarity and consistency across the docs, use a single capitalization for the product name (and keep the lowercase form only for things that are explicitly named that way, such as namespaces or CLI flags).
Simplyblock is a highly versatile storage platform that can be deployed on Kubernetes and other platforms. That means that not all components must be installed on Talos. In this guide, we will focus on a full installation of simplyblock into Talos. For all options, see the [simplyblock documentation](https://docs.simplyblock.io/latest/).
public/kubernetes-guides/csi/simplyblock-storage.mdx:235
- The cleanup section uninstalls a release named
simplyblock, but the install sections reference/selectrelease=simplyblock-csiand currently don't clearly define the release name. Once the install commands are fixed, please ensure the uninstall command matches the actual release name users will have installed (and consider uninstalling both CSI and any controller release if applicable).
Uninstall the storage plane and CSI driver chart:
```bash
helm uninstall simplyblock -n simplyblock
</details>
---
💡 <a href="https://github.com/siderolabs/docs/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds a documentation page to explain how simplyblock storage clusters can be installed (fully hypercoverged) into a Talos Kubernetes cluster.
It follows the existing Ceph / Rook style and has a short explanation of the three different simplyblock components that can be installed.