
[[about]]
[preface]
= Please Read This First

This guide is intended to serve users of the Software-Defined-Storage Solution
LINSTOR as a definitive reference guide and handbook.

/////
It is being made available to the DRBD community by
https://www.linbit.com/[LINBIT], the project's sponsor company, free of
charge and in the hope that it will be useful. The guide is
constantly being updated.  We try to add information
about new DRBD features simultaneously with the corresponding DRBD
releases. An on-line HTML version of this guide is always available at
https://links.linbit.com/DRBD9-Users-Guide.
/////


IMPORTANT: This guide assumes, throughout, that you are using the latest
version of LINSTOR and related tools.


This guide is organized as follows:

* <<s-administrative-tasks-setup>> deals with LINSTOR's basic functionality and
  gives you an insight in using common administrative tasks. Apart of that you can use this
  chapter as a step-by-step instruction guide to deploy LINSTOR in its basic setup.

* In <<s-more-about-linstor>> a variety of advanced and important LINSTOR tasks as well as configurations
  is provided to configure LINSTOR in a more complex way.

* The chapters <<ch-kubernetes>>, <<ch-proxmox-linstor>>, <<ch-opennebula-linstor>>, <<ch-openstack-linstor>>,
  <<ch-docker-linstor>> illustrate how to implement a LINSTOR based storage
  with Kubernetes, PROXMOX, OpenNebula, Openstack and Docker by using LINSTOR's API.
