LINSTOR Gateway

LINSTOR Gateway manages highly available iSCSI targets, NFS exports, and NVMe-oF targets by leveraging LINSTOR and drbd-reactor.

Getting started

Refer to the Understanding LINSTOR Gateway user guide which outlines some of the basic knowledge needed to effectively operate and administer a storage cluster that relies on LINSTOR Gateway. This guide also provides some insight into the design decisions that were made while implementing LINSTOR Gateway, and gives an overview of how its internals work.

Installation

For a step-by-step tutorial on setting up a LINSTOR Gateway cluster, refer to this blog post: Create a Highly Available iSCSI Target Using LINSTOR Gateway.

Requirements

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

Simply enter the following command, and follow any suggestions that the command output might show:

linstor-gateway check-health

Documentation

If you want to learn more about LINSTOR Gateway, here are some pointers for further reading.

Command line

Help for the command line interface is available by running:

linstor-gateway help

The same information can also be browsed in Markdown format here.

Configuration

LINSTOR Gateway takes a configuration file. Refer to its documentation here.

Internals

The LINSTOR Gateway command line client communicates with the server by using a REST API, which is documented here.

It also exposes a Go client for the REST API:

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
make