Documentation

Install, operate and understand blockstor.

Blockstor is a Kubernetes control plane for LVM and ZFS storage with DRBD replication. It speaks a LINSTOR-compatible REST API, so linstor-csi, piraeus-operator, ha-controller and golinstor keep working unchanged, and it ships its own blockstor command-line tool.

New here

The Quickstart takes an empty cluster to a replicated PersistentVolumeClaim. Then read the Overview for what works today and what does not.

Quickstart

Setting up a cluster

Installation covers requirements, the manifests, nodes and pools. CSI connects it to StorageClasses, Networking lists the ports.

Installation

Running it day to day

Operations for node maintenance, resize, snapshots and upgrades, Troubleshooting when something is off, and the CLI reference.

Operations

Coming from LINSTOR

Migrating from LINSTOR takes over a cluster in place. Compatibility lists what the API answers differently.

Migration

To understand how it works, read Architecture, Resources and Layer stack. If you want to work on blockstor itself, see the Developer guide.

All pages


Overview

What blockstor is, what it does today, and when to use it.

Quickstart

From an empty cluster to a pod writing to a replicated volume.

Installation

Prepare the nodes, deploy blockstor, and check that it is up.

Provisioning volumes with CSI

Connect linstor-csi to blockstor and provision PersistentVolumes.

Architecture

How blockstor turns a volume request into replicas on disk.

Networking and ports

Every listener blockstor opens, who connects to it, and what a firewall must allow.

Resources

The blockstor custom resources, with examples.

Layer stack

Combine replication, encryption and plain local storage.

Using the CLI

Manage nodes, pools, volumes and snapshots with the blockstor command.

Day-2 operations

Reading health, adding and removing nodes, growing and moving volumes, snapshots, backups and upgrades.

Migrating from LINSTOR

Take over an existing LINSTOR cluster in place, without copying data.

Troubleshooting

Symptoms, where to look, what they mean, and what to do.

Compatibility with LINSTOR

Where blockstor behaves differently from LINSTOR, and what is not there.