block-storage

Overview

block-storage is a microservice-based storage management system built using the Moleculer framework. It provides functionalities to manage NFS servers, folders, disks, and block storage devices. The system is designed to be highly scalable and flexible, allowing for easy integration with various storage backends and orchestration platforms like Kubernetes. Currently only Kubernetes is supported.

Key features include:

NFS Management: Provision and manage NFS servers for shared v1.storage.
Folder Management: Create, update, and delete storage folders on disks.
Disk Management: Probe, format, mount, and manage storage disks.
Block Storage Management: Provision, format, mount, and manage block storage devices with support for replicas and snapshots.
Configuration Management: Centralized configuration for clusters, namespaces, and other parameters.

Requirements

These services require the following services to be running:

Kubernetes-service
Config-service
Nodes-service

Installation

To run the services, install Docker and run the following command:

docker run -d --name block-storage --restart always -v /path/to/data:/app/db ghcr.io/flybyme/block-storage:main

For Nats as the transporter

docker run -d --name block-storage --restart always -e TRANSPORTER=nats://10.1.10.1:4222 -v /path/to/data:/app/db ghcr.io/flybyme/block-storage:main

Replace /path/to/data with the path to your data directory.

Index

NFS Service
- Actions: createNFS, createPod, deletePod, getPod
- Methods: resolveNFS, resolveNFSPod, createNFS, createNFSPod, deleteNFSPod
Folders Service
- Actions: provision, deprovision, updateUsed, updateAllUsed
- Methods: findByID, provisionFolder, deprovisionFolder, getUsed
Disks Service
- Actions: availableDisks, probe, probeAll, updateUsed, updateAllUsed, mountPoint, setNFS, createFolder, removeFolder, getFolderSize, nfs, getNodeDisks
- Methods: resolveStorageDevice, findBySerial, createFolder, removeFolder, getFolderSize, probeNodeStorage, sizeToMB, processChildren, parseDevice, updateUsed, format, mount, unmount
Blocks Service
- Provisioning: provision, deprovision
- Formatting and Mounting: format, mount, unmount
- Usage and Maintenance: usage, trim, checkPods, balanceBlock
- Replica Management: createReplica, removeReplicaFromBlock, removeReplicaFromFrontend, removeReplicaPod, addReplicaToFrontend, listReplicas, updateReplica, getRebuildStatus, verifyRebuild, updateReplicaMode
- Information and Control: ls, info
- Longhorn Block Controller: createBlockController, startBlockFrontend, shutdownBlockFrontend, getBlockControllerInfo, expandBlockController, deleteBlockController

Services

NFS Service

Manages NFS servers. NFS servers are used to provide shared storage for storage folders.

Actions

createNFS: Creates a new NFS server. Requires a disk ID as a parameter. It checks if the disk exists and if it already has an NFS server. If not, it creates a new NFS server.
createPod: Creates a Kubernetes pod for the NFS server. Requires the NFS server ID as a parameter. It checks if the NFS server exists and if it already has a pod. If not, it creates a new pod.
deletePod: Deletes the Kubernetes pod for the NFS server. Requires the NFS server ID as a parameter. It checks if the NFS server exists and if it has a pod. If so, it deletes the pod.
getPod: Retrieves the Kubernetes pod for the NFS server. Requires the NFS server ID as a parameter. It checks if the NFS server exists and retrieves the pod information.

Methods

resolveNFS: Resolves an NFS server by its ID.
resolveNFSPod: Resolves an NFS pod by its UID.
createNFS: Creates a new NFS server on a node. It generates a unique name, constructs the FQDN, and determines the mount path. It then creates the NFS server entity and updates the disk with the NFS server information.
createNFSPod: Creates a Kubernetes pod for the NFS server. It checks if the NFS server already has a pod. If not, it creates a new pod with the necessary configurations and updates the NFS server entity with the pod information.
deleteNFSPod: Deletes the Kubernetes pod for the NFS server. It checks if the NFS server has a pod. If so, it deletes the pod and updates the NFS server entity to remove the pod information.

Folders Service

Manages storage folders. Folders are used as mount points for the block devices and storage for replicas.

Actions

provision: Provisions a new folder. Requires a prefix for the folder name and a disk ID as parameters. It checks if the disk exists and then creates a new folder on the disk.
deprovision: Deprovisions an existing folder. Requires the folder ID as a parameter. It checks if the folder exists and then removes it from the disk.
updateUsed: Updates the used size of a folder. Requires the folder ID as a parameter. It checks if the folder exists and then updates its used size.
updateAllUsed: Updates the used size of all folders. This action is typically used as a cron job to periodically update the used sizes of all folders.

Methods

findByID: Finds a folder by its ID.
provisionFolder: Provisions a new folder on a disk. It generates a unique folder name, determines the folder path, creates the folder on the disk, and then creates the folder entity in the database.
deprovisionFolder: Deprovisions a folder. It checks if the disk exists, determines the folder path, removes the folder from the disk, and then removes the folder entity from the database.
getUsed: Gets the used size of a folder. It calls the getFolderSize action of the disks service to retrieve the size of the folder and returns the used size.

Disks Service

Manages storage disks.

Actions

availableDisks: Retrieves available disks.
- Params:
  - cluster (string): Cluster name.
  - size (number): Size in MB that should be available on the disk.
  - limit (number, optional): Limit number of disks to return.
  - exclude (array, optional): Array of disk IDs to exclude.
- Example:
```
const disks = await broker.call("v1.storage.disks.availableDisks", {
  cluster: "cluster-1",
  size: 1024,
  limit: 5,
  exclude: ["disk-1", "disk-2"]
});
console.log(disks);
```

probe: Probes a node for storage devices.

Params:
- node (string): Node ID.

Example:

const devices = await broker.call("v1.storage.disks.probe", {
  node: "node-1"
});
console.log(devices);

probeAll: Probes all nodes for storage devices.

Example:

const devices = await broker.call("v1.storage.disks.probeAll");
console.log(devices);

updateUsed: Updates the used size of a disk.

Params:
- id (string): Disk ID.

Example:

const updatedDisk = await broker.call("v1.storage.disks.updateUsed", {
  id: "disk-1"
});
console.log(updatedDisk);

updateAllUsed: Updates the used size of all disks.

Example:

const updatedDisks = await broker.call("v1.storage.disks.updateAllUsed");
console.log(updatedDisks);

mountPoint: Retrieves the mount point of a disk.

Params:
- id (string): Disk ID.

Example:

const mountPoint = await broker.call("v1.storage.disks.mountPoint", {
  id: "disk-1"
});
console.log(mountPoint);

setNFS: Sets the NFS server for a disk.

Params:
- id (string): Disk ID.
- nfs (string): NFS server ID.

Example:

const updatedDisk = await broker.call("v1.storage.disks.setNFS", {
  id: "disk-1",
  nfs: "nfs-1"
});
console.log(updatedDisk);

createFolder: Creates a folder on a disk.

Params:
- id (string): Disk ID.
- path (string): Folder path.

Example:

const folder = await broker.call("v1.storage.disks.createFolder", {
  id: "disk-1",
  path: "/data"
});
console.log(folder);

removeFolder: Removes a folder from a disk.

Params:
- id (string): Disk ID.
- path (string): Folder path.

Example:

const folder = await broker.call("v1.storage.disks.removeFolder", {
  id: "disk-1",
  path: "/data"
});
console.log(folder);

getFolderSize: Retrieves the size of a folder.

Params:
- id (string): Disk ID.
- path (string): Folder path.

Example:

const size = await broker.call("v1.storage.disks.getFolderSize", {
  id: "disk-1",
  path: "/data"
});
console.log(size);

nfs: Resolves the NFS server for a folder on a disk.

Params:
- id (string): Disk ID.
- path (string): Folder path.

Example:

const nfs = await broker.call("v1.storage.disks.nfs", {
  id: "disk-1",
  path: "/data"
});
console.log(nfs);

getNodeDisks: Retrieves disks for a specific node.

Params:
- node (string): Node ID.

Example:

const disks = await broker.call("v1.storage.disks.getNodeDisks", {
  node: "node-1"
});
console.log(disks);

Methods

resolveStorageDevice: Resolves a storage device by its ID.
findBySerial: Finds disks by serial number.
createFolder: Creates a folder on a disk.
removeFolder: Removes a folder from a disk.
getFolderSize: Gets the size of a folder.
probeNodeStorage: Probes a node for storage devices.
sizeToMB: Converts size string to MB.
processChildren: Processes child devices.
parseDevice: Parses a device from the lsblk output.
updateUsed: Updates the used size of a disk.
format: Formats a disk.
mount: Mounts a disk.
unmount: Unmounts a disk.

Blocks Service

Manages block storage devices.

Provisioning

provision: Provisions a new block storage device.
- Params:
  - name (string): Name of the block.
  - size (number): Size of the block in GB.
  - node (string): Node to create the block.
  - replicas (number): Number of replicas.
- Example:
```
await broker.call("v1.storage.blocks.provision", {
  name: "my-block",
  size: 10,
  node: "node-1",
  replicas: 3
});
```
deprovision: Deprovisions an existing block storage device.
- Params:
  - id (string): ID of the block.
- Example:
```
await broker.call("v1.storage.blocks.deprovision", {
  id: "block-id"
});
```

Formatting and Mounting

format: Formats a block storage device.
- Params:
  - id (string): ID of the block.
  - force (boolean, optional): Force format.
- Example:
```
await broker.call("v1.storage.blocks.format", {
  id: "block-id",
  force: true
});
```
mount: Mounts a block storage device.
- Params:
  - id (string): ID of the block.
  - force (boolean, optional): Force mount.
- Example:
```
await broker.call("v1.storage.blocks.mount", {
  id: "block-id",
  force: true
});
```
unmount: Unmounts a block storage device.
- Params:
  - id (string): ID of the block.
  - force (boolean, optional): Force unmount.
- Example:
```
await broker.call("v1.storage.blocks.unmount", {
  id: "block-id",
  force: true
});
```

Usage and Maintenance

usage: Retrieves the usage of a block storage device.

Params:
- id (string): ID of the block.

Example:

const usage = await broker.call("v1.storage.blocks.usage", {
  id: "block-id"
});
console.log(usage);

trim: Trims a block storage device.
- Params:
  - id (string): ID of the block.
- Example:
```
await broker.call("v1.storage.blocks.trim", {
  id: "block-id"
});
```
checkPods: Checks the state of the pods associated with a block storage device.
- Params:
  - id (string): ID of the block.
- Example:
```
await broker.call("v1.storage.blocks.checkPods", {
  id: "block-id"
});
```
balanceBlock: Balances the number of replicas of a block storage device.
- Params:
  - id (string): ID of the block.
- Example:
```
await broker.call("v1.storage.blocks.balanceBlock", {
  id: "block-id"
});
```

Replica Management

createReplica: Creates a new replica for a block storage device.
- Params:
  - id (string): ID of the block.
  - disk (string): Disk ID.
- Example:
```
await broker.call("v1.storage.blocks.createReplica", {
  id: "block-id",
  disk: "disk-id"
});
```
removeReplicaFromBlock: Removes a replica from a block storage device. This action removed the underlying data and the pod.
- Params:
  - id (string): ID of the block.
  - replica (string): Replica ID.
- Example:
```
await broker.call("v1.storage.blocks.removeReplicaFromBlock", {
  id: "block-id",
  replica: "replica-id"
});
```
removeReplicaFromFrontend: Removes a replica from the frontend controller.
- Params:
  - id (string): ID of the block.
  - replica (string): Replica ID.
- Example:
```
await broker.call("v1.storage.blocks.removeReplicaFromFrontend", {
  id: "block-id",
  replica: "replica-id"
});
```
removeReplicaPod: Removes a replica pod from a block storage device. Deletes the pod and updates the block entity to remove the pod information.
- Params:
  - id (string): ID of the block.
  - replica (string): Replica ID.
- Example:
```
await broker.call("v1.storage.blocks.removeReplicaPod", {
  id: "block-id",
  replica: "replica-id"
});
```
addReplicaToFrontend: Adds a replica to a block storage device. Attaches the replica to the frontend controller.
- Params:
  - id (string): ID of the block.
  - replica (string): Replica ID.
- Example:
```
await broker.call("v1.storage.blocks.addReplicaToFrontend", {
  id: "block-id",
  replica: "replica-id"
});
```

listReplicas: Lists replicas of a block storage device.

Params:
- id (string): ID of the block.

Example:

const replicas = await broker.call("v1.storage.blocks.listReplicas", {
  id: "block-id"
});
console.log(replicas);

updateReplica: Updates a replica of a block storage device.
- Params:
  - id (string): ID of the block.
  - replica (string): Replica ID.
  - mode (string): Replica mode.
- Example:
```
await broker.call("v1.storage.blocks.updateReplica", {
  id: "block-id",
  replica: "replica-id",
  mode: "RW"
});
```

getRebuildStatus: Gets the rebuild status of a replica of a block storage device.

Params:
- id (string): ID of the block.
- replica (string): Replica ID.

Example:

const status = await broker.call("v1.storage.blocks.getRebuildStatus", {
  id: "block-id",
  replica: "replica-id"
});
console.log(status);

verifyRebuild: Verifies the rebuild status of a replica of a block storage device.
- Params:
  - id (string): ID of the block.
  - replica (string): Replica ID.
- Example:
```
await broker.call("v1.storage.blocks.verifyRebuild", {
  id: "block-id",
  replica: "replica-id"
});
```
updateReplicaMode: Updates the mode of a replica of a block storage device.
- Params:
  - id (string): ID of the block.
  - mode (string): Replica mode.
- Example:
```
await broker.call("v1.storage.blocks.updateReplicaMode", {
  id: "block-id",
  mode: "RW"
});
```

Information and Control

ls: Lists the contents of a block storage device.

Params:
- id (string): ID of the block.

Example:

const contents = await broker.call("v1.storage.blocks.ls", {
  id: "block-id"
});
console.log(contents);

info: Retrieves information about a block storage device.

Params:
- id (string): ID of the block.

Example:

const info = await broker.call("v1.storage.blocks.info", {
  id: "block-id"
});
console.log(info);

Longhorn Block Controller

createBlockController: Creates a Longhorn block controller.
- Params:
  - id (string): ID of the block.
- Example:
```
await broker.call("v1.storage.blocks.createBlockController", {
  id: "block-id"
});
```
startBlockFrontend: Starts a Longhorn block controller.
- Params:
  - id (string): ID of the block.
- Example:
```
await broker.call("v1.storage.blocks.startBlockFrontend", {
  id: "block-id"
});
```
shutdownBlockFrontend: Shuts down a Longhorn block controller.
- Params:
  - id (string): ID of the block.
- Example:
```
await broker.call("v1.storage.blocks.shutdownBlockFrontend", {
  id: "block-id"
});
```

getBlockControllerInfo: Retrieves information about a Longhorn block controller.

Params:
- id (string): ID of the block.

Example:

const info = await broker.call("v1.storage.blocks.getBlockControllerInfo", {
  id: "block-id"
});
console.log(info);

expandBlockController: Expands a Longhorn block controller.
- Params:
  - id (string): ID of the block.
  - size (number): New block size.
- Example:
```
await broker.call("v1.storage.blocks.expandBlockController", {
  id: "block-id",
  size: 20
});
```
deleteBlockController: Deletes a Longhorn block controller.
- Params:
  - id (string): ID of the block.
- Example:
```
await broker.call("v1.storage.blocks.deleteBlockController", {
  id: "block-id"
});
```

Configuration

The services use configuration settings defined in the config object within each service file. These settings include default values for clusters, namespaces, and other parameters.

Installation

Clone the repository:

git clone https://github.com/FLYBYME/block-v1.storage.git
cd block-storage

Install dependencies:
```
npm install
```
Start the services:
```
npm run dev
```

License

This project is licensed under the MIT License.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

block-storage

Overview

Requirements

Installation

Index

Services

NFS Service

Actions

Methods

Folders Service

Actions

Methods

Disks Service

Actions

Methods

Blocks Service

Provisioning

Formatting and Mounting

Usage and Maintenance

Replica Management

Information and Control

Longhorn Block Controller

Configuration

Installation

License

Files

README.md

Latest commit

History

README.md

File metadata and controls

block-storage

Overview

Requirements

Installation

Index

Services

NFS Service

Actions

Methods

Folders Service

Actions

Methods

Disks Service

Actions

Methods

Blocks Service

Provisioning

Formatting and Mounting

Usage and Maintenance

Replica Management

Information and Control

Longhorn Block Controller

Configuration

Installation

License