README
¶
LINSTOR Gateway
LINSTOR Gateway manages highly available iSCSI targets, NFS exports, and NVMe-oF targets by leveraging LINSTOR and drbd-reactor.
Getting Started
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 execute
linstor-gateway check-health
and follow any suggestions that may come up.
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. See 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
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
iscsi
Package iscsi combines LINSTOR operations and the CRM operations to create highly available iSCSI targets.
|
Package iscsi combines LINSTOR operations and the CRM operations to create highly available iSCSI targets. |
|
linstorcontrol
Package linstorcontrol allows creating and deleting LINSTOR resources/volumes.
|
Package linstorcontrol allows creating and deleting LINSTOR resources/volumes. |
|
rest
Package rest provides the REST API to create highly-available iSCSI targets.
|
Package rest provides the REST API to create highly-available iSCSI targets. |
|
upgrade
Package upgrade migrates existing resources to the latest version.
|
Package upgrade migrates existing resources to the latest version. |