Skip to content
SHC Docs

Storage API

  • method_router → prefix /api/method

Hand-maintained notes against modules/storage/router.go. Route inventory (generated): routes.md. Response models (generated): response-models/storage.md.

MethodPathPermission
POST/api/method/shc.storage.addplatform:manage
POST/api/method/shc.storage.rmplatform:manage
POST/api/method/shc.storage.getplatform:manage
POST / GET/api/method/shc.storage.lsplatform:manage
POST/api/method/shc.storage.linkplatform:manage
POST/api/method/shc.storage.unlinkplatform:manage
GET/api/method/shc.storage.logs.streamplatform:manage
POST/api/method/shc.storage.cephfs.enableplatform:manage
POST/api/method/shc.storage.cephfs.disableplatform:manage
POST/api/method/shc.storage.cephfs.joinplatform:manage
POST/api/method/shc.storage.cephfs.leaveplatform:manage
POST/api/method/shc.storage.cephfs.statusplatform:manage
POST/api/method/shc.storage.cephfs.healthplatform:manage
POST/api/method/shc.storage.nfs.enableplatform:manage
POST/api/method/shc.storage.nfs.disableplatform:manage
POST/api/method/shc.storage.nfs.joinplatform:manage
POST/api/method/shc.storage.nfs.leaveplatform:manage
POST/api/method/shc.storage.nfs.statusplatform:manage
POST / GET/api/method/shc.storage.volume.lsstack:read
POST/api/method/shc.storage.volume.rebindplatform:manage
POST/api/method/shc.storage.volume.rmplatform:manage

Node-to-node storage provisioning rides internal RPC (POST /internal/rpc/{function} on the internal listener). Each mutating function refuses a caller whose verified certificate does not name the target_node it declares.

FunctionWhat the node does
storage.nfs_statusreports its NFS state (read only)
storage.nfs_enable_serverinstalls and starts the NFS kernel server and publishes the export
storage.nfs_enable_clientmounts the cluster share
storage.nfs_disablestops the server or unmounts the share and strips fstab
storage.cephfs_enable_clientwrites the cephx secret, keyring and ceph.conf and kernel-mounts the cephfs
storage.cephfs_disableunmounts the cephfs, removes the client secret and strips fstab
storage.volume_mountformats an empty device and mounts it, under the caller’s lease generation
storage.volume_unmountunmounts and releases the volume root

POST /api/method/shc.storage.cephfs.disable

Section titled “POST /api/method/shc.storage.cephfs.disable”

POST /api/method/shc.storage.cephfs.enable

Section titled “POST /api/method/shc.storage.cephfs.enable”

POST /api/method/shc.storage.cephfs.status

Section titled “POST /api/method/shc.storage.cephfs.status”