Skip to content

Latest commit

 

History

History
193 lines (146 loc) · 4.88 KB

README.md

File metadata and controls

193 lines (146 loc) · 4.88 KB

ZFS-Resty

ZFS Resty Logo

Disclaimer

This software is provided "as is," without any warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose, and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages, or other liability, whether in an action of contract, tort, or otherwise, arising from, out of, or in connection with the software or the use or other dealings in the software.

Usage and Responsibility:

The user assumes full responsibility for the usage of this software and the potential risks it may pose to their systems or data. This software interacts with ZFS, a powerful filesystem, and misconfiguration or misuse may lead to data loss or system instability.

Recommendations:

It is strongly recommended to test this software in a controlled, non-production environment before deploying it to critical systems. Regular backups should be made to mitigate potential risks associated with using this software. By using this software, you agree to these terms and absolve the authors and contributors of any liability.

Overview

ZFS-Resty is a RESTful API for managing ZFS pools and devices. The application provides endpoints for authentication, creating pools, managing disks, and retrieving ZFS status information.

Note: This application requires root privileges for certain operations, such as managing ZFS pools.

Table of Contents

Endpoints

Authentication

Authenticate and retrieve a JWT token for subsequent requests.

  • Endpoint: /auth
  • Method: POST
  • Parameters:
    • username (string): System username
    • password (string): User password

Pool Management

Create a ZFS Pool

  • Endpoint: /create-pool
  • Method: POST
  • Parameters:
    • name (string): Pool name
    • raid (string, optional): RAID type
    • devices (list): Device paths (e.g., /dev/sda)

Delete a Pool

  • Endpoint: /delete-pool
  • Method: POST
  • Parameters:
    • name (string): Pool name

Add Disk to Pool

  • Endpoint: /add-disk
  • Method: POST
  • Parameters:
    • pool (string): Pool name
    • device (string): Device path (e.g., /dev/sdx)

Add Spare Disk

  • Endpoint: /add-spare-disk
  • Method: POST
  • Parameters:
    • pool (string): Pool name
    • device (string): Device path (e.g., /dev/sdx)

Replace a Disk

  • Endpoint: /replace-disk
  • Method: POST
  • Parameters:
    • pool (string): Pool name
    • old_device (string): Path of the old device
    • new_device (string): Path of the replacement device

Set Mountpoint

  • Endpoint: /mountpoint
  • Method: POST
  • Parameters:
    • mountpoint (string): Mountpoint path (e.g., /mnt/pool)
    • pool (string): Pool name

Status and Information

Get Available Devices

  • Endpoint: /devices
  • Method: GET

Get ZFS Pool Status

  • Endpoint: /status
  • Method: GET

Get I/O Status

  • Endpoint: /io-status
  • Method: GET

Authentication

ZFS-Resty uses JWT for authentication. To authenticate:

  1. Send a POST request to /auth with your system username and password.
  2. A token will be returned in the response.
  3. Include this token in the Authorization header of all subsequent requests: 
    Authorization: <token>

Arguments

The application supports the following command-line arguments:

  • -p, --port: Set the HTTP port (default: 8089).
  • -s, --safe: Restrict access to local network IPs (default: false).

Installation

Using the Install Script

  1. Run the installation script: 
    chmod +x install.sh
./install.sh

Manual Installation

  1. Clone the repository:

    git clone https://github.com/jersobh/zfs-resty.git
cd zfs-resty

  2. Install requirements:

    pip install -r requirements.txt

  3. Run the application:

    sudo python zfs-resty.py

Examples

Authenticate

Request:

curl -X POST http://localhost:8089/auth -H "Content-Type: application/json" -d '{"username": "admin", "password": "admin"}'

Response:

{
  "token": "your-jwt-token"
}

Create a Pool

Request:

curl -X POST http://localhost:8089/create-pool -H "Authorization: <token>" -H "Content-Type: application/json" -d '{"name": "mypool", "raid": "mirror", "devices": ["/dev/sda", "/dev/sdb"]}'

Response:

{
  "success": "Pool 'mypool' created successfully"
}

License

This project is licensed under the MIT License.