linstor-gateway

README

LINSTOR Gateway

LINSTOR Gateway manages highly available iSCSI targets, NFS exports, and NVMe-oF targets by leveraging LINSTOR and drbd-reactor. A working LINSTOR cluster with drbd-reactor are a prerequisite to use this tool.

Quick Start

1. Set up a LINSTOR cluster. Ensure you have a storage pool with enough space for your data.
2. Set up drbd-reactor. The daemon should be configured to reload automatically when the configuration changes – follow the steps from the drbd-reactor README.
3. LINSTOR Gateway is packaged as a single binary. Download one of the releases and copy it to /usr/local/bin.
4. Start the LINSTOR Gateway server:

   linstor-gateway server
   

   This repository also includes linstor-gateway.service which can be used to start the server via systemd.

Requirements

LINSTOR Gateway provides a built-in health check that automatically tests whether all requirements are correctly met on the current host.

Simply execute

linstor-gateway check-health

and follow any suggestions that may come up.

Documentation

Start by browsing the documentation for the linstor-gateway command line utility.

LINSTOR Gateway also takes a configuration file. See its documentation here

Internals

The REST API documentation can be found here.

Building

If you want to test the latest unstable version of LINSTOR Gateway, you can build the git version from sources:

git clone https://github.com/LINBIT/linstor-gateway
cd linstor-gateway
go build .