LINSTOR

https://linbit.com/drbd-user-guide/linstor-guide-1_0-en
Admin
LINSTOR is a software-defined storage management solution that provides enterprise cluster-wide...
Tokens:192,118
Snippets:1,406
Trust Score:10
Update:19 hours ago
Show doc for...
Tokens:
Raw
### Enable and start linstor-controller service

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Run this command on the host where linstor-controller is installed to enable and start the service.

```bash
# systemctl enable --now linstor-controller
```

--------------------------------

### Install MySQL server on Ubuntu

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Installs the MySQL server package on Ubuntu using apt.

```bash
# apt install -y mysql-server
```

--------------------------------

### Example output of linstor-gateway check-health

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Example output when all required parts are installed. Missing components are acceptable if not using that datastore type.

```text
[✓] LINSTOR
[✓] drbd-reactor
[✓] Resource Agents
[✓] iSCSI
[✓] NVMe-oF
[✓] NFS
```

--------------------------------

### Follow CloudStack initial database setup progress

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Follows the progress of CloudStack's initial database setup by tailing the cloudstack-management service logs.

```bash
# journalctl -u cloudstack-management -f
```

--------------------------------

### Enable and start LINSTOR services

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Enable and start the LINSTOR Controller and Satellite services on your nodes.

```bash
# systemctl enable --now linstor-controller
# systemctl enable --now linstor-satellite
```

--------------------------------

### Install MySQL server on RHEL

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Installs the MySQL server package on RHEL using dnf.

```bash
# dnf install -y mysql-server
```

--------------------------------

### Install linstor-opennebula with apt

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Install the LINSTOR OpenNebula add-on package using apt. Requires access to LINBIT customer repositories.

```bash
# apt install linstor-opennebula
```

--------------------------------

### Enable and start NFS server service

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Enables and starts the NFS server service using systemctl.

```bash
# systemctl enable --now nfs-server
```

--------------------------------

### PostgreSQL database configuration example

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Example environment variables for a PostgreSQL instance: database name, user, and password. These values are used in the Helm connection URL.

```plaintext
POSTGRES_DB: postgresdb
POSTGRES_USER: postgresadmin
POSTGRES_PASSWORD: admin123
```

--------------------------------

### Install NFS server on RHEL

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Installs the NFS utilities package on RHEL using dnf.

```bash
# dnf install -y nfs-utils
```

--------------------------------

### Output of linstor-gateway nfs list for multiple exports

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Example output showing two NFS exports under the resource 'example', with export paths /srv/gateway-exports/example/vol1 and /srv/gateway-exports/example/vol2.

```bash
╭──────────────────────────────────────────────────────────────────────────────────────────────────────╮
┊ Resource ┊     Service IP     ┊  Service state   ┊            NFS export             ┊ LINSTOR state ┊
╞══════════════════════════════════════════════════════════════════════════════════════════════════════╡
┊ example  ┊ 172.16.16.99/24    ┊ Started (node-1) ┊ /srv/gateway-exports/example/vol1 ┊ OK            ┊
┊          ┊                    ┊ Started (node-1) ┊ /srv/gateway-exports/example/vol2 ┊ OK            ┊
╰──────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Build and install SCST packages from source

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Clone the SCST repository, build RPM packages with DKMS, and install them on RHEL. The commands assume the build is performed in the home directory.

```bash
git clone https://github.com/SCST-project/scst
cd scst/
make rpm-dkms
cd ~/
dnf install -y /usr/src/packages/RPMS/x86_64/scst*
```

--------------------------------

### Download and install CloudStack system VM template

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Run these commands on the CloudStack management node. The first downloads the system VM template for KVM, and the second runs the cloud-install-sys-tmplt script to install it.

```bash
# CS_VERSION=4.17
# CS_VERSION_PATCH=4.17.1
# wget https://download.cloudstack.org/systemvm/$CS_VERSION/systemvmtemplate-$CS_VERSION_PATCH-kvm.qcow2.bz2
# /usr/share/cloudstack-common/scripts/storage/secondary/cloud-install-sys-tmplt \
-m /export/secondary \
-f systemvmtemplate-$CS_VERSION_PATCH=-kvm.qcow2.bz2 \
-h kvm -o localhost -r cloud -d cloud
```

--------------------------------

### Example LINSTOR Gateway configuration file

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Example TOML configuration specifying a list of LINSTOR controller nodes by IP address. The default config path is /etc/linstor-gateway/linstor-gateway.toml.

```toml
[linstor]
controllers = ["10.10.1.1", "10.10.1.2", "10.10.1.3"]
```

--------------------------------

### Tab completion examples for LINSTOR commands

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

These examples show how tab completion can complete IP addresses and resource names. The comments indicate the expected completion results.

```bash
# linstor node create alpha 1<tab> # completes the IP address if hostname can be resolved
# linstor resource create b<tab> c<tab> # linstor assign-resource backups charlie
```

--------------------------------

### Enable and start DRBD Reactor service

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Run on all LINSTOR satellite nodes after installing DRBD Reactor to start and enable the service.

```bash
systemctl enable --now drbd-reactor
```

--------------------------------

### Prepare thin-provisioned storage with LVM commands

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Create a physical volume, volume group, and thin pool for LINSTOR storage. The example uses /dev/sdX and /dev/sdY as physical devices and drbdpool as the volume group. Set metadata space to a reasonable size to avoid resize difficulties.

```bash
pvcreate /dev/sdX /dev/sdY
vgcreate drbdpool /dev/sdX /dev/sdY
lvcreate -l 95%VG --poolmetadatasize 8g -T /dev/drbdpool/drbdthinpool
```

--------------------------------

### PostgreSQL linstor.toml sample

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Sample [db] section for PostgreSQL external database provider. Requires creating a DB/schema and user for LINSTOR.

```toml
[db]
user = "linstor"
password = "linstor"
connection_url = "jdbc:postgresql://localhost/linstor"
```

--------------------------------

### LDAP search_base example

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Example of the search_base field in the LDAP configuration, specifying the starting point in the LDAP directory tree for the authentication query.

```TOML
search_base = "ou=storage-services"
```

--------------------------------

### Configure storagePools with devicePaths

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

YAML example showing storagePools entries with devicePaths to let LINSTOR automatically prepare devices for LVM and LVM thin pools.

```yaml
  storagePools:
    lvmPools:
    - name: lvm-thick
      volumeGroup: drbdpool
      devicePaths:
      - /dev/vdb
    lvmThinPools:
    - name: lvm-thin
      thinVolume: thinpool
      volumeGroup: linstor_thinpool
      devicePaths:
      - /dev/vdc
      - /dev/vdd

```

--------------------------------

### Install linstor-gui on DEB-based distributions

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Use this command to install the LINBIT GUI package on DEB-based distributions (e.g., Debian, Ubuntu). Run it on the LINSTOR controller node and on any other nodes that can run the controller service in a highly available setup.

```bash
apt install -y linstor-gui
```

--------------------------------

### Install linstor-gui on RPM-based distributions

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Use this command to install the LINBIT GUI package on RPM-based distributions (e.g., RHEL, CentOS). Run it on the LINSTOR controller node and on any other nodes that can run the controller service in a highly available setup.

```bash
dnf install -y linstor-gui
```

--------------------------------

### Reconfigure engine-setup to enable Cinderlib integration

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Run engine-setup with --reconfigure-optional-components and answer 'Yes' when prompted to configure Cinderlib integration (currently in tech preview).

```bash
engine-setup --reconfigure-optional-components
```

```text
--== PRODUCT OPTIONS ==--

Configure Cinderlib integration (Currently in tech preview) (Yes, No) [No]: Yes
```

--------------------------------

### Create CloudStack database configuration file

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Creates /etc/mysql/conf.d/cloudstack.cnf with MySQL settings for CloudStack. The max_connections value is 350 as specified in the CloudStack installation guide.

```ini
[mysqld]
innodb_rollback_on_timeout=1
innodb_lock_wait_timeout=600
max_connections=350 (1)
log-bin=mysql-bin
binlog-format = 'ROW'
```

--------------------------------

### Pass --log-level TRACE as command-line argument

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

When starting the controller or satellite, pass the --log-level argument to set the logging level. The example shows the command for both the controller and satellite.

```bash
java ... com.linbit.linstor.core.Controller ... --log-level TRACE
java ... com.linbit.linstor.core.Satellite  ... --log-level TRACE

```

--------------------------------

### Show package hints with linbit-manage-node.py

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Use this command to review the script's suggested packages and installation commands.

```bash
# ./linbit-manage-node.py --hints
```

--------------------------------

### Create diskless NVMe initiator resource

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Creates the resource on node beta as diskless using --nvme-initiator, allowing network access to the data.

```bash
# linstor resource create beta nvmedata --nvme-initiator
```

--------------------------------

### sp-values.yaml - storage pool configuration

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Common values file used by the Helm installation examples. It defines an LVM thin pool named 'lvm-thin' with device path /dev/sdb. Adjust for your environment.

```yaml
operator:
  satelliteSet:
    storagePools:
      lvmThinPools:
      - name: lvm-thin
        thinVolume: thinpool
        volumeGroup: ""
        devicePaths:
        - /dev/sdb
```

--------------------------------

### Output of linstor-gateway nfs list for single export

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Example output showing a single NFS export named 'nfstest' with service IP 172.16.16.99/32, started on node-1, export path /srv/gateway-exports/nfstest, and LINSTOR state OK.

```bash
╭────────────────────────────────────────────────────────────────────────────────────────────────╮
┊ Resource ┊    Service IP     ┊  Service state   ┊          NFS export          ┊ LINSTOR state ┊
╞════════════════════════════════════════════════════════════════════════════════════════════════╡
┊ nfstest  ┊ 172.16.16.99/32   ┊ Started (node-1) ┊ /srv/gateway-exports/nfstest ┊ OK            ┊
╰────────────────────────────────────────────────────────────────────────────────────────────────╯
```

--------------------------------

### Verify QoS setting by showing sysfs file contents

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Shows the contents of the sysfs file /sys/fs/cgroup/blkio/blkio.throttle.write_bps_device to verify that spawned resources inherited the QoS setting. The output displays the device number and the limit value.

```bash
# cat /sys/fs/cgroup/blkio/blkio.throttle.write_bps_device
252:4 1048576
```

--------------------------------

### Create storage configuration file for helm install

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

YAML file defining storagePools for the operator.satelliteSet, used with helm install to create storage pools at installation time.

```yaml
operator:
  satelliteSet:
    storagePools:
      lvmPools:
      - name: lvm-thick
        volumeGroup: drbdpool

```

--------------------------------

### List supported storage providers and layers with `linstor node info`

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Shows two tables: available storage provider backends and storage layers, with '+' for supported and '-' for not supported.

```bash
# linstor node info

```

--------------------------------

### Start and enable LINSTOR satellite service

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Starts the linstor-satellite service and enables it to start on reboot. After about 10 seconds, the node status in `linstor node list` becomes online.

```bash
# systemctl enable --now  linstor-satellite

```

--------------------------------

### Apply kustomization and wait for pods

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Applies the customized configuration using oc apply -k, waits for all pods to be ready, and lists the pods. The output should eventually show a LINSTOR controller pod running.

```bash
$ oc apply -k . && \
oc wait --for=condition=ready pod --all -n linbit-sds --timeout=5m && \
oc get pods -n linbit-sds
```

```text
NAME                                                   READY   STATUS    RESTARTS   AGE
linstor-operator-controller-manager-59586c7bb5-qlfwb   1/1     Running   0          11s
```

--------------------------------

### Edit LinstorSatelliteSet after installation

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Command to edit the LinstorSatelliteSet configuration on a cluster with the operator already installed.

```bash
$ kubectl edit LinstorSatelliteSet.linstor.linbit.com <satellitesetname>

```

--------------------------------

### Install NFS server on Ubuntu

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Installs the NFS kernel server package on Ubuntu using apt.

```bash
# apt install -y nfs-kernel-server
```

--------------------------------

### Create multiple NFS exports with one command

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Creates an NFS service with two exports by specifying multiple volume sizes (20G and 40G). The resource is named 'example' and uses service IP 172.16.16.99/24.

```bash
linstor-gateway nfs create example 172.16.16.99/24 20G 40G
```

--------------------------------

### Output of resource-group list-properties

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Example output from the resource-group list-properties command, showing the configured file system properties.

```text
╭─────────────────────────────────────╮
┊ Key                   ┊ Value       ┊
╞═════════════════════════════════════╡
┊ FileSystem/Group      ┊ nobody      ┊
┊ FileSystem/Type       ┊ xfs         ┊
┊ FileSystem/User       ┊ nobody      ┊
╰─────────────────────────────────────╯
```

--------------------------------

### Install LINSTOR Operator v2 with Helm

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Installs the LINSTOR Operator v2 using Helm, specifying the namespace and image credentials from the environment variables set earlier. The --wait flag ensures the installation completes before proceeding.

```bash
$ helm install linstor-operator linstor/linstor-operator \
  --namespace linbit-sds \
  --create-namespace \
  --set imageCredentials.username=$MY_LINBIT_USER \
  --set imageCredentials.password=$MY_LINBIT_PASSWORD \
  --wait
```

--------------------------------

### Install linstor-cinder package on engine host

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Install the linstor-cinder package using dnf with the ovirt repository enabled.

```bash
$ dnf install -y --enablerepo=ovirt linstor-cinder
```

--------------------------------

### Run helm install with storage configuration file

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Command to pass the storage configuration file to Helm installation.

```bash
helm install -f <file> linstor-op linstor/linstor

```

--------------------------------

### Configure controllers in linstor-client.conf

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Create /etc/linstor/linstor-client.conf with a controllers= line in the global section. Multiple controllers can be specified as a comma-separated list.

```ini
[global]
controllers=alice
```

--------------------------------

### Find Cinder installation paths

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Likely paths to the Cinder installation on the system, used to locate the directory where the LINSTOR driver resides.

```bash
/usr/lib/python*/dist-packages/cinder/
/usr/lib/python*/site-packages/cinder/
```

--------------------------------

### Equivalent resource-connection command for setting peer options

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Shows the equivalent command using 'resource-connection' instead of 'resource' for the same peer option setting.

```bash
# linstor resource-connection drbd-peer-options --max-buffers 8192 node-0 node-1 backups
```

--------------------------------

### Install linstor-opennebula with yum

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Install the LINSTOR OpenNebula add-on package using yum. Requires access to LINBIT customer repositories.

```bash
# yum install linstor-opennebula
```

--------------------------------

### --x-replicas-on-different argument syntax

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Shows the command-line syntax for the --x-replicas-on-different argument, which takes an auxiliary property name and a positive integer. The integer is the maximum number of replicas that can be placed on nodes sharing the same auxiliary property value.

```text
--x-replicas-on-different <auxiliary-property-name> <positive-integer>
```

--------------------------------

### Set auxiliary node properties and create resource group with placement constraint

Source: https://linbit.com/drbd-user-guide/linstor-guide-1_0-en/

Commands to set auxiliary node property testProperty on nodes 0, 1, and 2, create a resource group testRscGrp with place-count 2 and --replicas-on-same testProperty=1, create a volume group, and spawn a resource. Output is omitted for simplicity.

```bash
# for i in {0,2}; do linstor node set-property --aux node-$i testProperty 1; done
# linstor node set-property --aux node-1 testProperty 0
# linstor resource-group create testRscGrp --place-count 2 --replicas-on-same testProperty=1
# linstor volume-group create testRscGrp
# linstor resource-group spawn-resources testRscGrp testResource 100M
```
Tokens:
Raw