Storage API
Routers
Section titled “Routers”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.
| Method | Path | Permission |
|---|---|---|
POST | /api/method/shc.storage.add | platform:manage |
POST | /api/method/shc.storage.rm | platform:manage |
POST | /api/method/shc.storage.get | platform:manage |
POST / GET | /api/method/shc.storage.ls | platform:manage |
POST | /api/method/shc.storage.link | platform:manage |
POST | /api/method/shc.storage.unlink | platform:manage |
GET | /api/method/shc.storage.logs.stream | platform:manage |
POST | /api/method/shc.storage.cephfs.enable | platform:manage |
POST | /api/method/shc.storage.cephfs.disable | platform:manage |
POST | /api/method/shc.storage.cephfs.join | platform:manage |
POST | /api/method/shc.storage.cephfs.leave | platform:manage |
POST | /api/method/shc.storage.cephfs.status | platform:manage |
POST | /api/method/shc.storage.cephfs.health | platform:manage |
POST | /api/method/shc.storage.nfs.enable | platform:manage |
POST | /api/method/shc.storage.nfs.disable | platform:manage |
POST | /api/method/shc.storage.nfs.join | platform:manage |
POST | /api/method/shc.storage.nfs.leave | platform:manage |
POST | /api/method/shc.storage.nfs.status | platform:manage |
POST / GET | /api/method/shc.storage.volume.ls | stack:read |
POST | /api/method/shc.storage.volume.rebind | platform:manage |
POST | /api/method/shc.storage.volume.rm | platform:manage |
Internal RPC functions
Section titled “Internal RPC functions”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.
| Function | What the node does |
|---|---|
storage.nfs_status | reports its NFS state (read only) |
storage.nfs_enable_server | installs and starts the NFS kernel server and publishes the export |
storage.nfs_enable_client | mounts the cluster share |
storage.nfs_disable | stops the server or unmounts the share and strips fstab |
storage.cephfs_enable_client | writes the cephx secret, keyring and ceph.conf and kernel-mounts the cephfs |
storage.cephfs_disable | unmounts the cephfs, removes the client secret and strips fstab |
storage.volume_mount | formats an empty device and mounts it, under the caller’s lease generation |
storage.volume_unmount | unmounts and releases the volume root |
POST /api/method/shc.storage.add
Section titled “POST /api/method/shc.storage.add”- source:
modules/storage/router.go
POST /api/method/shc.storage.cephfs.disable
Section titled “POST /api/method/shc.storage.cephfs.disable”- source:
modules/storage/router.go
POST /api/method/shc.storage.cephfs.enable
Section titled “POST /api/method/shc.storage.cephfs.enable”- source:
modules/storage/router.go
POST /api/method/shc.storage.cephfs.join
Section titled “POST /api/method/shc.storage.cephfs.join”- source:
modules/storage/router.go
POST /api/method/shc.storage.cephfs.leave
Section titled “POST /api/method/shc.storage.cephfs.leave”- source:
modules/storage/router.go
POST /api/method/shc.storage.cephfs.status
Section titled “POST /api/method/shc.storage.cephfs.status”- source:
modules/storage/router.go
POST /api/method/shc.storage.rm
Section titled “POST /api/method/shc.storage.rm”- source:
modules/storage/router.go
POST /api/method/shc.storage.get
Section titled “POST /api/method/shc.storage.get”- source:
modules/storage/router.go
POST /api/method/shc.storage.link
Section titled “POST /api/method/shc.storage.link”- source:
modules/storage/router.go
POST /api/method/shc.storage.ls
Section titled “POST /api/method/shc.storage.ls”- source:
modules/storage/router.go
POST /api/method/shc.storage.nfs.disable
Section titled “POST /api/method/shc.storage.nfs.disable”- source:
modules/storage/router.go
POST /api/method/shc.storage.nfs.enable
Section titled “POST /api/method/shc.storage.nfs.enable”- source:
modules/storage/router.go
POST /api/method/shc.storage.nfs.join
Section titled “POST /api/method/shc.storage.nfs.join”- source:
modules/storage/router.go
POST /api/method/shc.storage.nfs.leave
Section titled “POST /api/method/shc.storage.nfs.leave”- source:
modules/storage/router.go
POST /api/method/shc.storage.nfs.status
Section titled “POST /api/method/shc.storage.nfs.status”- source:
modules/storage/router.go
POST /api/method/shc.storage.unlink
Section titled “POST /api/method/shc.storage.unlink”- source:
modules/storage/router.go
shc@docs:~$