shc storage

The shc storage commands manage storage providers, the backends that hold deployment state (compose files, persistent volumes, generated files, and app definitions). SHC supports three provider kinds:

Every deployment pins exactly one storage provider via shc install --storage <name> or defaults to the tenant/environment default.

• Managed providers are brought up and torn down by SHC. There is at most one of each kind (nfs, cephfs) per cluster, and their names are reserved.
• External providers are local-kind entries that point at an existing mount. They are the only kind you create with shc storage add.
• Links associate a provider with specific nodes. Managed providers link themselves; external providers are linked via shc storage link.

List all storage providers known to the cluster.

shc storage ls
shc storage ls --type cephfs
shc storage ls --node node01
shc storage ls --managed
shc storage ls --external

Options:

Default columns are name, type, filesystem, managed, quota, snapshot, nodes (count of linked nodes), and path. Output format follows the global -o/--output flag (tty|text|json|yaml).

Show full details for one provider.

shc storage show local-ssd

Returns the provider id, path, filesystem, quota and snapshot capability, config blob, and the list of linked nodes.

Register an existing mount as an external local-kind provider.

shc storage add local-ssd --path /var/lib/shc-ssd
shc storage add local-ssd --path /var/lib/shc-ssd --node node01

Options:

Rules:

• The name must not be one of the reserved managed-provider names local, nfs, cephfs.
• For managed providers, use shc storage nfs enable or shc storage cephfs enable instead.

Remove a provider from the inventory.

shc storage rm local-ssd
shc storage rm local-ssd --force

By default the delete is refused if any stack still uses the provider. --force skips that check.

Attach or detach an external provider to one or more nodes.

shc storage link local-ssd node01 node02
shc storage unlink local-ssd node01

Both commands take the provider name followed by one or more node ids. Managed providers manage their own links.

Managed NFS is a single kernel NFS server exported from one cluster node, mounted by every other node at /mnt/shc/nfs. It is created and torn down by SHC.

Bring up managed NFS on the cluster.

shc storage nfs enable
shc storage nfs enable --export-path /mnt/shc/nfs --network 10.42.0.0/24

Options:

Tear down managed NFS. Fails if stacks still reference it.

shc storage nfs disable

Show NFS server role, export path, and per-node mount state.

shc storage nfs status
shc storage nfs status -v

Pin the NFS server role onto a node.

shc storage nfs join                 # pin local node
shc storage nfs join --node node02   # pin a specific node

Release the NFS server role from the pinned node. SHC will re-elect another voter as server.

shc storage nfs leave
shc storage nfs leave --node node02

Managed CephFS gives the cluster a replicated, distributed filesystem mounted at /mnt/shc/cephfs. Each node that contributes capacity runs one or more Ceph OSDs backed by a block device. Monitors and the MDS are placed on voter nodes.

Enable CephFS across the cluster. Requires at least one voter node.

shc storage cephfs enable

Note: multi-node enable (key distribution, monmap bootstrap, MDS/MGR deployment) is not yet automated — the command is wired up end-to-end and will succeed once the deployment path lands.

Tear down CephFS, stopping local monitors, MDS, and OSDs and removing the mount.

shc storage cephfs disable

Show cluster health, OSD counts, and per-node daemon state.

shc storage cephfs status

Contribute a local block device as a new OSD.

shc storage cephfs join --device /dev/sdb
shc storage cephfs join --device /dev/sdb --node node03

Options:

Remove an OSD from the cluster, waiting for rebalance by default.

shc storage cephfs leave --osd-id 3
shc storage cephfs leave --osd-id 3 --force

Options:

shc node leave automatically drains and removes every local OSD before the node exits the cluster, so manual cephfs leave is only needed for capacity management.

Pin a storage provider at install time:

shc install nextcloud --storage cephfs
shc install nextcloud --storage local-ssd
shc install nextcloud --storage nfs --stack cloud --environment prod

If --storage is omitted, SHC picks the tenant/environment default. Swarm-mode stacks require a shared provider (nfs or cephfs); local is rejected for Swarm.

• File Locations — where provider data lives on disk
• App Commands — --storage flag on shc install
• Node Commands — join/leave and OSD drain behavior
• Data Model — deployment state layout