Skip to content

Commit cf1d454

Browse files
docs(storage): note that the replicated class requires DRBD
The StorageClass examples in the two install guides and in the disk encryption page are copied verbatim by operators, and nothing beside them says that `layerList: "drbd storage"` is served by a kernel module that may not be present. On a substrate without DRBD the class is created successfully and then every PVC bound to it stays Pending, so the failure surfaces several steps away from the file that caused it. Say it where the class is written, and name the flag that goes with it. The `linstor` package needs `drbd.enabled: false` on such a substrate, and without that the satellite pod never becomes Ready, so LINSTOR registers no nodes and nothing binds at all -- not only the replicated class. LUKS is orthogonal and is called out as such on the encryption page. The flag works on Talos only, so platform.md and disk-encryption.md say so, and "loadable" now also requires that each node has its own kernel, which is the case the flag was added for. Assisted-By: LLM Signed-off-by: Myasnikov Daniil <[email protected]>
1 parent 98c8fd5 commit cf1d454

3 files changed

Lines changed: 6 additions & 0 deletions

File tree

‎content/en/docs/next/getting-started/install-cozystack.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,8 @@ Finally, we can create a couple of storage classes, one of which will be the def
329329
allowVolumeExpansion: true
330330
```
331331

332+
The `replicated` class requires DRBD: `layerList: "drbd storage"` is served by the DRBD layer inside the LINSTOR satellite, so it works only where the `drbd` kernel module is loadable and each node has its own kernel. On a substrate that cannot provide that, such as Talos nodes running as containers on a shared kernel, install the `linstor` package with `drbd.enabled: false` (without it the satellite pod never becomes Ready, LINSTOR registers no nodes at all and every PVC stays Pending) and omit `replicated` from this file. What remains is `local`: storage-only volumes, pinned to the node that provisioned them, kept in a single copy with no replication and no remote access.
333+
332334
1. Apply the storage class configuration
333335

334336
```bash

‎content/en/docs/next/install/cozystack/platform.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,8 @@ Create storage classes, one of which should be the default class.
361361
allowVolumeExpansion: true
362362
```
363363

364+
The `replicated` class requires DRBD: `layerList: "drbd storage"` is served by the DRBD layer inside the LINSTOR satellite, so it works only where the `drbd` kernel module is loadable and each node has its own kernel. On Talos nodes that cannot provide that, such as nodes running as containers on a shared kernel, install the `linstor` package with `drbd.enabled: false` (without it the satellite pod never becomes Ready, LINSTOR registers no nodes at all and every PVC stays Pending) and omit `replicated` from this file. The flag works on Talos only, the chart refuses it on other distributions. There the DRBD module has to be loadable on the host, support for other substrates is tracked in [cozystack/cozystack#4092](https://github.com/cozystack/cozystack/issues/4092). What remains is `local`: storage-only volumes, pinned to the node that provisioned them, kept in a single copy with no replication and no remote access.
365+
364366
1. Apply the storage class configuration
365367

366368
```bash

‎content/en/docs/next/storage/disk-encryption.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,7 @@ volumeBindingMode: Immediate
7070
allowVolumeExpansion: true
7171
```
7272
73+
`replicated-encrypted` requires DRBD: the `drbd` layer in `layerList: "drbd luks storage"` is served inside the LINSTOR satellite, so it works only where the `drbd` kernel module is loadable and each node has its own kernel. On Talos nodes that cannot provide that, where the `linstor` package is installed with `drbd.enabled: false`, create only `local-encrypted`. The flag works on Talos only, on other distributions the DRBD module has to be loadable on the host. LUKS encryption itself is independent of DRBD and works either way.
74+
7375
Now you can use the `StorageClass` to create `PersistentVolumeClaims` (PVCs) for encrypted storage.
7476

0 commit comments

Comments
 (0)