https://github.com/linbit/linstor-gateway
Manages Highly-Available iSCSI targets, NVMe-oF targets, and NFS exports via LINSTOR
https://github.com/linbit/linstor-gateway
drbd high-availability iscsi linstor nfs nvme-over-fabrics
Last synced: about 1 year ago
JSON representation
Manages Highly-Available iSCSI targets, NVMe-oF targets, and NFS exports via LINSTOR
- Host: GitHub
- URL: https://github.com/linbit/linstor-gateway
- Owner: LINBIT
- License: gpl-3.0
- Created: 2019-08-22T11:07:48.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-18T08:49:54.000Z (almost 2 years ago)
- Last Synced: 2024-07-18T11:01:53.751Z (almost 2 years ago)
- Topics: drbd, high-availability, iscsi, linstor, nfs, nvme-over-fabrics
- Language: Go
- Homepage:
- Size: 827 KB
- Stars: 24
- Watchers: 11
- Forks: 6
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# LINSTOR Gateway
LINSTOR Gateway manages highly available **iSCSI targets**, **NFS exports**, and
**NVMe-oF targets** by leveraging [LINSTOR](https://github.com/LINBIT/linstor-server)
and [drbd-reactor](https://github.com/LINBIT/drbd-reactor).
## Getting started
Refer to the [_Understanding LINSTOR Gateway_](https://linbit.com/drbd-user-guide/linstorgateway-guide-1_0-en/) 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.
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](https://linbit.com/blog/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](./docs/md/linstor-gateway.md).
### Configuration
LINSTOR Gateway takes a configuration file. Refer to its documentation [here](./docs/config.md).
### Internals
The LINSTOR Gateway command line client communicates with the server by using a REST API, which is
documented [here](https://app.swaggerhub.com/apis-docs/Linstor/linstor-gateway/).
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
```