App Project

https://longhorn.io/docs/1.12.0/
Admin
This project appears to be a Node.js/TypeScript application containing API services, server logic,...
Tokens:110,171
Snippets:1,417
Trust Score:9.5
Update:2 months ago
Show doc for...
Tokens:
Raw
### Installation output example

Source: https://longhorn.io/docs/1.12.0/deploy/install

Example output showing the results of the preflight installation process.

```text
INFO[2025-03-11T08:17:57+08:00] Initializing preflight installer
INFO[2025-03-11T08:17:57+08:00] Cleaning up preflight installer
INFO[2025-03-11T08:17:57+08:00] Running preflight installer
INFO[2025-03-11T08:17:57+08:00] Installing dependencies with package manager
INFO[2025-03-11T08:18:28+08:00] Installed dependencies with package manager
INFO[2025-03-11T08:18:28+08:00] Cleaning up preflight installer
INFO[2025-03-11T08:18:28+08:00] Completed preflight installer. Use 'longhornctl check preflight' to check the result.
```

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

### Successful Installation Output

Source: https://longhorn.io/docs/1.12.0/deploy/install/install-with-argocd

Example output showing running Longhorn pods.

```text
NAME                                                READY   STATUS    RESTARTS   AGE
longhorn-ui-b7c844b49-w25g5                         1/1     Running   0          2m41s
longhorn-manager-pzgsp                              1/1     Running   0          2m41s
longhorn-driver-deployer-6bd59c9f76-lqczw           1/1     Running   0          2m41s
longhorn-csi-plugin-mbwqz                           2/2     Running   0          100s
csi-snapshotter-588457fcdf-22bqp                    1/1     Running   0          100s
csi-snapshotter-588457fcdf-2wd6g                    1/1     Running   0          100s
csi-provisioner-869bdc4b79-mzrwf                    1/1     Running   0          101s
csi-provisioner-869bdc4b79-klgfm                    1/1     Running   0          101s
csi-resizer-6d8cf5f99f-fd2ck                        1/1     Running   0          101s
csi-provisioner-869bdc4b79-j46rx                    1/1     Running   0          101s
csi-snapshotter-588457fcdf-bvjdt                    1/1     Running   0          100s
csi-resizer-6d8cf5f99f-68cw7                        1/1     Running   0          101s
csi-attacher-7bf4b7f996-df8v6                       1/1     Running   0          101s
csi-attacher-7bf4b7f996-g9cwc                       1/1     Running   0          101s
csi-attacher-7bf4b7f996-8l9sw                       1/1     Running   0          101s
csi-resizer-6d8cf5f99f-smdjw                        1/1     Running   0          101s
instance-manager-b34d5db1fe1e2d52bcfb308be3166cfc   1/1     Running   0          114s
engine-image-ei-df38d2e5-cv6nc                      1/1     Running   0          114s
```

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

### Complete fleet.yaml Example

Source: https://longhorn.io/docs/1.12.0/deploy/install/install-with-fleet

A consolidated example of a fleet.yaml file for Longhorn deployment.

```yaml
defaultNamespace: longhorn-system
helm:
  repo: https://charts.longhorn.io
  chart: longhorn
  version: v1.12.0
  releaseName: longhorn
diff:
  comparePatches:
  - apiVersion: apiextensions.k8s.io/v1
    kind: CustomResourceDefinition
    name: engineimages.longhorn.io
    operations:
    - {"op": "replace", "path": "/status"}
  - apiVersion: apiextensions.k8s.io/v1
    kind: CustomResourceDefinition
    name: nodes.longhorn.io
    operations:
    - {"op": "replace", "path": "/status"}
  - apiVersion: apiextensions.k8s.io/v1
    kind: CustomResourceDefinition
    name: volumes.longhorn.io
    operations:
    - {"op": "replace", "path": "/status"}
```

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

### Install Cryptsetup

Source: https://longhorn.io/docs/1.12.0/deploy/install

Install the cryptsetup utility required for LUKS2 volume encryption.

```bash
apt-get install cryptsetup
```

```bash
yum install cryptsetup
```

```bash
zypper install cryptsetup
```

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

### Install open-iscsi on RHEL, CentOS, and AmazonLinux2

Source: https://longhorn.io/docs/1.12.0/deploy/install

Installs iscsi-initiator-utils, configures the initiator name, and starts the iscsid daemon.

```bash
yum --setopt=tsflags=noscripts install iscsi-initiator-utils
echo "InitiatorName=$(/sbin/iscsi-iname)" > /etc/iscsi/initiatorname.iscsi
systemctl enable iscsid
systemctl start iscsid
```

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

### Longhorn service output example

Source: https://longhorn.io/docs/1.12.0/deploy/accessing-the-ui

Example output showing the ClusterIP for the longhorn-frontend service.

```text
NAME                TYPE        CLUSTER-IP      EXTERNAL-IP   PORT(S)    AGE
longhorn-backend    ClusterIP   10.20.248.250   <none>        9500/TCP   58m
longhorn-frontend   ClusterIP   10.20.245.110   <none>        80/TCP     58m
```

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

### Example CLI Execution and Output

Source: https://longhorn.io/docs/1.12.0/advanced-resources/data-integrity/on-demand-snapshot-data-integrity

Example command to trigger checksums for all volumes and the corresponding log output.

```bash
./longhornctl-linux-amd64 checksum volume --all=true
```

```text
INFO[2026-03-18T17:04:27+08:00] Triggering on-demand snapshot checksum calculation 
INFO[2026-03-18T17:04:27+08:00] Requested on-demand checksum calculation for volume tmp1  volume=tmp1
INFO[2026-03-18T17:04:27+08:00] Requested on-demand checksum calculation for volume tmp2  volume=tmp2
INFO[2026-03-18T17:04:27+08:00] Snapshot checksum calculation may take some time. You can check the snapshot checksum via kubectl. 
INFO[2026-03-18T17:04:27+08:00] Checksum request submitted                   
INFO[2026-03-18T17:04:27+08:00] Cleaning volume on-demand checksum requester 
INFO[2026-03-18T17:04:27+08:00] Completed volume on-demand checksum requester 
```

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

### Install the binary

Source: https://longhorn.io/docs/1.12.0/advanced-resources/longhornctl/install-longhornctl

Moves the binary to a system directory for global access.

```bash
sudo install longhornctl-linux-${ARCH} /usr/local/bin/longhornctl
```

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

### Backup Configuration Example

Source: https://longhorn.io/docs/1.12.0/advanced-resources/data-recovery/recover-without-system

Example content of a backup.cfg file used to identify backup and volume names.

```json
{"Name":"backup-72bcbdad913546cf","VolumeName":"volume_1","SnapshotName":"79758033-a670-4724-906f-41921f53c475"}
```

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

### Install Device Mapper Tool

Source: https://longhorn.io/docs/1.12.0/deploy/install

Install the device mapper userspace tool for block device management.

```bash
apt-get install dmsetup
```

```bash
yum install device-mapper
```

```bash
zypper install device-mapper
```

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

### Updated Deployment Manifest Example

Source: https://longhorn.io/docs/1.12.0/deploy/install/airgap

Full example of a Deployment manifest updated with private registry image paths.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: longhorn-ui
  name: longhorn-ui
  namespace: longhorn-system
spec:
  replicas: 1
  selector:
    matchLabels:
      app: longhorn-ui
  template:
    metadata:
      labels:
        app: longhorn-ui
    spec:
      containers:
      - name: longhorn-ui
        image: <REGISTRY_URL>/longhorn-ui:<LONGHORN_UI_IMAGE_TAG>   ## Add image name and tag here
        ports:
        - containerPort: 8000
        env:
          - name: LONGHORN_MANAGER_IP
            value: "http://longhorn-backend:9500"
      imagePullSecrets:
      - name: <SECRET_NAME>
      serviceAccountName: longhorn-service-account
```

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

### Apply HelmChart Configuration

Source: https://longhorn.io/docs/1.12.0/deploy/install/install-with-helm-controller

Apply the created YAML file to initiate the installation process.

```bash
$ kubectl apply -f helmchart_repo_install.yaml
helmchart.helm.cattle.io/longhorn-install created
```

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

### Preflight check output example

Source: https://longhorn.io/docs/1.12.0/deploy/install

Example output showing the results of a preflight check operation.

```text
./longhornctl check preflight
```

```text
INFO[2024-01-01T00:00:01Z] Initializing preflight checker
INFO[2024-01-01T00:00:01Z] Cleaning up preflight checker
INFO[2024-01-01T00:00:01Z] Running preflight checker
INFO[2024-01-01T00:00:02Z] Retrieved preflight checker result:
worker1:
  info:
  - Service iscsid is running
  - NFS4 is supported
  - Package nfs-common is installed
  - Package open-iscsi is installed
  warn:
  - multipathd.service is running. Please refer to https://longhorn.io/kb/troubleshooting-volume-with-multipath/ for more information.
worker2:
  info:
  - Service iscsid is running
  - NFS4 is supported
  - Package nfs-common is not installed
  - Package open-iscsi is installed
```

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

### Longhornctl Installation Commands

Source: https://longhorn.io/docs/1.12.0/advanced-resources/longhornctl

Commands used for preparing the environment and installing Longhorn dependencies.

```bash
longhornctl install preflight
```

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

### Install NFSv4 Client

Source: https://longhorn.io/docs/1.12.0/deploy/install

Install the necessary NFSv4 client utilities based on the Linux distribution.

```bash
apt-get install nfs-common
```

```bash
yum install nfs-utils
```

```bash
zypper install nfs-client
```

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

### Simple Pod and PVC Configuration

Source: https://longhorn.io/docs/1.12.0/references/examples

Basic examples for a standard Pod and its associated PersistentVolumeClaim.

```yaml
    apiVersion: v1
    kind: Pod
    metadata:
      name: longhorn-simple-pod
      namespace: default
    spec:
      restartPolicy: Always
      containers:
        - name: volume-test
          image: nginx:stable-alpine
          imagePullPolicy: IfNotPresent
          livenessProbe:
            exec:
              command:
                - ls
                - /data/lost+found
            initialDelaySeconds: 5
            periodSeconds: 5
          volumeMounts:
            - name: volv
              mountPath: /data
          ports:
            - containerPort: 80
      volumes:
        - name: volv
          persistentVolumeClaim:
            claimName: longhorn-simple-pvc
```

```yaml
    apiVersion: v1
    kind: PersistentVolumeClaim
    metadata:
      name: longhorn-simple-pvc
    spec:
      accessModes:
        - ReadWriteOnce
      storageClassName: longhorn
      resources:
        requests:
          storage: 1Gi
```

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

### Example values.yaml configuration

Source: https://longhorn.io/docs/1.12.0/advanced-resources/deploy/customizing-default-settings

A sample snippet showing how to define defaultSettings within a values.yaml file.

```yaml
defaultSettings:
  backupTarget: s3://backupbucket@us-east-1/backupstore
  backupTargetCredentialSecret: minio-secret
  createDefaultDiskLabeledNodes: true
  defaultDataPath: /var/lib/longhorn-example/
  replicaSoftAntiAffinity: false
  storageOverProvisioningPercentage: 600
  storageMinimalAvailablePercentage: 15
  upgradeChecker: false
  defaultReplicaCount: 2
  defaultDataLocality: disabled
  defaultLonghornStaticStorageClass: longhorn-static-example
  backupstorePollInterval: 500
  taintToleration: key1=value1:NoSchedule; key2:NoExecute
  systemManagedComponentsNodeSelector: "label-key1:label-value1"
  priorityClass: high-priority
  autoSalvage: false
  disableSchedulingOnCordonedNode: false
  replicaZoneSoftAntiAffinity: false
  replicaDiskSoftAntiAffinity: false
  volumeAttachmentRecoveryPolicy: never
  nodeDownPodDeletionPolicy: do-nothing
  guaranteedInstanceManagerCpu: 15
  orphanResourceAutoDeletion: ""
  orphanResourceAutoDeletionGracePeriod: 300
```

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

### Install prerequisites

Source: https://longhorn.io/docs/1.12.0/deploy/install

Install required dependencies for V1 or V2 Data Engine using the longhornctl tool.

```bash
longhornctl --kubeconfig ~/.kube/config --image longhornio/longhorn-cli:v1.12.0 install preflight
```

```bash
longhornctl --kubeconfig ~/.kube/config --image longhornio/longhorn-cli:v1.12.0 install preflight --enable-spdk
```

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

### Install Argo CD

Source: https://longhorn.io/docs/1.12.0/deploy/install/install-with-argocd

Commands to create the argocd namespace and install the core Argo CD components.

```bash
kubectl create namespace argocd
kubectl apply -n argocd -f https://raw.githubusercontent.com/argoproj/argo-cd/stable/manifests/core-install.yaml
```

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

### Install open-iscsi on Debian and Ubuntu

Source: https://longhorn.io/docs/1.12.0/deploy/install

Installs the open-iscsi package on Debian and Ubuntu systems.

```bash
apt-get install open-iscsi
```

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

### Monitor Longhorn Installation

Source: https://longhorn.io/docs/1.12.0/advanced-resources/os-distro-specific/okd-support

Watch the status of pods in the longhorn-system namespace to verify the installation progress.

```bash
  oc get pods \
  --namespace longhorn-system \
  --watch
```

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

### Install Longhorn via Helm

Source: https://longhorn.io/docs/1.12.0/deploy/install/airgap

Command to deploy Longhorn using the configured chart.

```bash
helm install longhorn ./chart --namespace longhorn-system --create-namespace
```

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

### Verify Ingress Configuration

Source: https://longhorn.io/docs/1.12.0/deploy/accessing-the-ui/longhorn-ingress-traefik

Example commands to verify the Ingress status and test authentication.

```bash
$ USER=foo; PASSWORD=bar; echo "${USER}:$(openssl passwd -stdin -apr1 <<< ${PASSWORD})" > auth
$ kubectl -n longhorn-system create secret generic basic-auth --from-file=auth
secret/basic-auth created

# (After applying middlewares and ingress manifests)

$ kubectl -n longhorn-system get ingress
NAME               CLASS     HOSTS   ADDRESS      PORTS   AGE
longhorn-ingress   traefik   * 10.0.2.15    80      15s

$ curl -I http://10.0.2.15/
HTTP/1.1 401 Unauthorized
Www-Authenticate: Basic realm="traefik"

$ curl -u foo:bar -I http://10.0.2.15/
HTTP/1.1 200 OK
```

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

### Configure VirtIO Disk

Source: https://longhorn.io/docs/1.12.0/nodes-and-volumes/nodes/multidisk

Example configuration for a VirtIO disk using its BDF.

```yaml
virtio-disk:
  allowScheduling: true
  diskType: block
  diskDriver: auto
  evictionRequested: false
  path: 0000:07:00.0
  storageReserved: 0
  tags: []
```

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

### Install open-iscsi on SUSE and openSUSE

Source: https://longhorn.io/docs/1.12.0/deploy/install

Installs the open-iscsi package and enables the iscsid daemon on SUSE-based systems.

```bash
zypper install open-iscsi
systemctl enable iscsid
systemctl start iscsid
```

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

### Configure NVMe Disk

Source: https://longhorn.io/docs/1.12.0/nodes-and-volumes/nodes/multidisk

Example configuration for an NVMe disk using its BDF.

```yaml
nvme-disk:
  allowScheduling: true
  diskType: block
  diskDriver: auto
  evictionRequested: false
  path: 0000:05:00.0
  storageReserved: 0
  tags: []
```

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

### Example Output for VirtIO Device Identification

Source: https://longhorn.io/docs/1.12.0/nodes-and-volumes/nodes/multidisk

Sample output showing symlinks for VirtIO devices.

```text
lrwxrwxrwx  1 root root 0 Feb 22 14:04 vda -> ../devices/pci0000:00/0000:00:02.3/0000:04:00.0/virtio2/block/vda
lrwxrwxrwx  1 root root 0 Feb 22 14:24 vdb -> ../devices/pci0000:00/0000:00:02.6/0000:07:00.0/virtio5/block/vdb
```

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

### Example longhorn-manager logs

Source: https://longhorn.io/docs/1.12.0/advanced-resources/system-backup-restore/restore-to-a-new-cluster-using-velero

Example of warning logs generated in longhorn-manager pods when old instance manager pods are present after restoration.

```text
[longhorn-manager-q6n7x] time="2021-12-20T10:42:49Z" level=warning msg="Can't find instance manager for pod instance-manager-r-1f19ecb0, may be deleted"
[longhorn-manager-q6n7x] time="2021-12-20T10:42:49Z" level=warning msg="Can't find instance manager for pod instance-manager-e-6c3be222, may be deleted"
[longhorn-manager-ldlvw] time="2021-12-20T10:42:55Z" level=warning msg="Can't find instance manager for pod instance-manager-e-bbf80f76, may be deleted"
[longhorn-manager-ldlvw] time="2021-12-20T10:42:55Z" level=warning msg="Can't find instance manager for pod instance-manager-r-3818fdca, may be deleted"
```

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

### Example Output for NVMe Device Identification

Source: https://longhorn.io/docs/1.12.0/nodes-and-volumes/nodes/multidisk

Sample output showing symlinks for NVMe devices.

```text
lrwxrwxrwx  1 root root 0 Jul 30 12:20 loop0 -> ../devices/virtual/block/loop0
lrwxrwxrwx  1 root root 0 Jul 30 12:20 nvme0n1 -> ../devices/pci0000:00/0000:00:01.2/0000:02:00.0/nvme/nvme0/nvme0n1
lrwxrwxrwx  1 root root 0 Jul 30 12:20 nvme1n1 -> ../devices/pci0000:00/0000:00:01.2/0000:05:00.0/nvme/nvme1/nvme1n1
```

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

### Define a Backing Image via YAML

Source: https://longhorn.io/docs/1.12.0/advanced-resources/backing-image/backing-image-backup

Example configuration for a BackingImage custom resource.

```yaml
apiVersion: longhorn.io/v1beta2
kind: BackingImage
metadata:
  name: parrot
  namespace: longhorn-system
spec:
  sourceType: download
  sourceParameters:
    url: https://longhorn-backing-image.s3-us-west-1.amazonaws.com/parrot.raw
  checksum: 304f3ed30ca6878e9056ee6f1b02b328239f0d0c2c1272840998212f9734b196371560b3b939037e4f4c2884ce457c2cbc9f0621f4f5d1ca983983c8cdf8cd9a
```

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

### Install Fleet via Helm

Source: https://longhorn.io/docs/1.12.0/deploy/install/install-with-fleet

Adds the Fleet Helm repository and installs the CRD and Fleet components into the cattle-fleet-system namespace.

```bash
helm repo add fleet https://rancher.github.io/fleet-helm-charts/
helm -n cattle-fleet-system install --create-namespace --wait fleet-crd fleet/fleet-crd
helm -n cattle-fleet-system install --create-namespace --wait fleet fleet/fleet
```

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

### Install Longhorn via kubectl

Source: https://longhorn.io/docs/1.12.0/deploy/install/install-with-kubectl

Applies the Longhorn manifest directly from the official repository.

```bash
kubectl apply -f https://raw.githubusercontent.com/longhorn/longhorn/v1.12.0/deploy/longhorn.yaml
```

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

### Check agent pod logs

Source: https://longhorn.io/docs/1.12.0/advanced-resources/os-distro-specific/container-optimized-os-support

Confirm the installation status by inspecting the logs of the agent pod.

```text
Completed!
Keep the container running for iscsi daemon
```

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

### Backup Backing Image Metrics

Source: https://longhorn.io/docs/1.12.0/monitoring/metrics

Examples of metrics for tracking the size and state of backup backing images.

```text
longhorn_backup_backing_image_actual_size_bytes{backup_backing_image=“parrot”} 3.3554432e+07
```

```text
longhorn_backup_backing_image_state{backup_backing_image=“parrot”} 3
```

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

### Restore a Backing Image via YAML

Source: https://longhorn.io/docs/1.12.0/advanced-resources/backing-image/backing-image-backup

Example configuration for restoring a backing image from a backupstore.

```yaml
apiVersion: longhorn.io/v1beta2
kind: BackingImage
metadata:
    name: parrot-restore
    namespace: longhorn-system
spec:
    sourceType: restore
    sourceParameters:
        # change to your backup URL
        # backup-url: nfs://longhorn-test-nfs-svc.default:/opt/backupstore?backingImage=parrot
        backup-url: s3://backupbucket@us-east-1/?backingImage=parrot
        concurrent-limit: "2"
    checksum: 304f3ed30ca6878e9056ee6f1b02b328239f0d0c2c1272840998212f9734b196371560b3b939037e4f4c2884ce457c2cbc9f0621f4f5d1ca983983c8cdf8cd9a
```

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

### Example output of successful cleanup

Source: https://longhorn.io/docs/1.12.0/deploy/uninstall

This output shows the expected result after successfully deleting the webhook configurations.

```text
Warning: Detected changes to resource pvc-279e8c3e-bfb0-4233-8899-77b5b178c08c which is currently being deleted.
volumeattachment.longhorn.io/pvc-279e8c3e-bfb0-4233-8899-77b5b178c08c configured
No resources found
customresourcedefinition.apiextensions.k8s.io "volumeattachments.longhorn.io" deleted
```

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

### Verify installation

Source: https://longhorn.io/docs/1.12.0/advanced-resources/longhornctl/install-longhornctl

Checks the installed version of longhornctl to confirm successful installation.

```bash
longhornctl version
```

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

### Deploy Credentials and Service

Source: https://longhorn.io/docs/1.12.0/snapshots-and-backups/backup-and-restore/set-backup-target

Apply the generated Kustomize overlay to the cluster.

```bash
kubectl apply -k deploy/backupstores/overlays/generated-credentials/minio
```

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

### Deploy Credentials and Service

Source: https://longhorn.io/docs/1.12.0/snapshots-and-backups/backup-and-restore/set-backup-target

Apply the generated Kustomize overlay to the cluster.

```bash
kubectl apply -k deploy/backupstores/overlays/generated-credentials/azurite
```

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

### Install Longhorn with custom values.yaml

Source: https://longhorn.io/docs/1.12.0/advanced-resources/deploy/customizing-default-settings

Apply a modified values.yaml file during the Helm installation process.

```bash
helm install longhorn longhorn/longhorn \
  --namespace longhorn-system \
  --create-namespace \
  --values values.yaml
```

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

### Deploy SMB/CIFS Credentials

Source: https://longhorn.io/docs/1.12.0/snapshots-and-backups/backup-and-restore/set-backup-target

Set environment variables and use Kustomize to deploy the generated credentials.

```bash
export CIFS_USERNAME="example-cifs-username"
export CIFS_PASSWORD="example-cifs-password"
```

```bash
./scripts/generate-backupstore-credentials.sh cifs
```

```bash
kubectl apply -k deploy/backupstores/overlays/generated-credentials/cifs
```

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

### Create a Backup of a Backing Image via YAML

Source: https://longhorn.io/docs/1.12.0/advanced-resources/backing-image/backing-image-backup

Example configuration for a BackupBackingImage custom resource to initiate a backup.

```yaml
apiVersion: longhorn.io/v1beta2
kind: BackupBackingImage
metadata:
  name: parrot-backup
  namespace: longhorn-system
spec:
  backingImage: parrot
  backupTargetName: default
  userCreated: true
  labels:
    usecase: test
    type: raw
```

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

### Install Linux Kernel Extra Modules

Source: https://longhorn.io/docs/1.12.0/deploy/install

Install additional kernel modules required for Debian and Ubuntu systems.

```bash
apt install -y linux-modules-extra-`uname -r`
```

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

### Install Longhorn with HTTPRoute via Helm

Source: https://longhorn.io/docs/1.12.0/deploy/accessing-the-ui/longhorn-httproute

Deploy Longhorn with basic HTTPRoute configuration using command-line flags.

```bash
helm install longhorn longhorn/longhorn \
  --namespace longhorn-system \
  --create-namespace \
  --set "httproute.enabled=true" \
  --set "httproute.parentRefs[0].name=my-gateway" \
  --set "httproute.parentRefs[0].namespace=default" \
  --set "httproute.hostnames[0]=longhorn.example.com"
```

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

### Generate Kustomize Credentials

Source: https://longhorn.io/docs/1.12.0/snapshots-and-backups/backup-and-restore/set-backup-target

Create the Kustomize overlay directory for MinIO credentials.

```bash
./scripts/generate-backupstore-credentials.sh minio --no-encode
```

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

### VolumeAttachment CR Example Output

Source: https://longhorn.io/docs/1.12.0/advanced-resources/volumeattachment

Example YAML output showing the structure of a VolumeAttachment resource, including attachmentTickets and their statuses.

```yaml
apiVersion: v1
...
  spec:
    attachmentTickets:
      csi-f0471a334f0b249f964cd1dec461a5eb94c8d268cbbc904c1a8e9a37e2045208:
        generation: 0
        id: csi-f0471a334f0b249f964cd1dec461a5eb94c8d268cbbc904c1a8e9a37e2045208
        nodeID: rancher60-master
        parameters:
          disableFrontend: "false"
          lastAttachedBy: ""
        type: csi-attacher
    volume: pvc-b26e9514-aafd-46e0-b70c-4e3f187c7977
  status:
    attachmentTicketStatuses:
      csi-f0471a334f0b249f964cd1dec461a5eb94c8d268cbbc904c1a8e9a37e2045208:
        conditions:
        - lastProbeTime: ""
          lastTransitionTime: "2025-07-05T09:17:27Z"
          message: ""
          reason: ""
          status: "True"
          type: Satisfied
        generation: 0
        id: csi-f0471a334f0b249f964cd1dec461a5eb94c8d268cbbc904c1a8e9a37e2045208
        satisfied: true
...
```

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

### Update Individual Node Selectors After Installation

Source: https://longhorn.io/docs/1.12.0/advanced-resources/deploy/node-selector

Override global settings by specifying node selectors for individual user-deployed components after installation.

```yaml
longhornManager:
  nodeSelector:
    label-key1: "label-value1"
longhornDriver:
  nodeSelector:
    label-key1: "label-value1"
longhornUI:
  nodeSelector:
    label-key1: "label-value1"
```

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

### Create Pod with Longhorn Volume via kubectl

Source: https://longhorn.io/docs/1.12.0/nodes-and-volumes/volumes/create-volumes

Deploys a test Pod and associated PVC using the provided example manifest.

```bash
kubectl create -f https://raw.githubusercontent.com/longhorn/longhorn/v1.12.0/examples/pod_with_pvc.yaml
```

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

### Troubleshoot System Restore Logs

Source: https://longhorn.io/docs/1.12.0/advanced-resources/system-backup-restore/restore-longhorn-system

Inspect the logs of the rollout pod to diagnose issues with a hanging system restore.

```bash
> kubectl -n longhorn-system logs --selector=job-name=longhorn-system-rollout-<SYSTEM-RESTORE-NAME>
```

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

### Handle Linux Kernel Module Installation Errors

Source: https://longhorn.io/docs/1.12.0/troubleshoot/troubleshooting

Troubleshoot missing installation candidates for Linux kernel modules by identifying valid package versions.

```bash
apt install -y linux-modules-extra-`uname -r`
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done
Package linux-modules-extra-5.15.0-67-generic is not available, but is referred to by another package.
This may mean that the package is missing, has been obsoleted, or
is only available from another source

E: Package 'linux-modules-extra-5.15.0-67-generic' has no installation candidate
```

```bash
apt update -y
apt install -y linux-modules-extra-5.15.0-76-generic
```

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

### Kubernetes Version Check Output

Source: https://longhorn.io/docs/1.12.0/deploy/install

Example output showing the client and server version information returned by the kubectl version command.

```text
Client Version: version.Info{Major:"1", Minor:"26", GitVersion:"v1.26.10", GitCommit:"b8609d4dd75c5d6fba4a5eaa63a5507cb39a6e99", GitTreeState:"clean", BuildDate:"2023-10-18T11:44:31Z", GoVersion:"go1.20.10", Compiler:"gc", Platform:"linux/amd64"}
Server Version: version.Info{Major:"1", Minor:"26", GitVersion:"v1.26.10+k3s2", GitCommit:"cb5cb5557f34e240e38c68a8c4ca2506c68b1d86", GitTreeState:"clean", BuildDate:"2023-11-08T03:21:46Z", GoVersion:"go1.20.10", Compiler:"gc", Platform:"linux/amd64"}
```

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

### Configure fleet.yaml Namespace

Source: https://longhorn.io/docs/1.12.0/deploy/install/install-with-fleet

Sets the default namespace for the Longhorn installation.

```yaml
defaultNamespace: longhorn-system
```

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

### View script help options

Source: https://longhorn.io/docs/1.12.0/deploy/install/airgap

Display help information for the image management scripts.

```bash
./save-images.sh --help
./load-images.sh --help
```

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

### Download Longhorn Manifest

Source: https://longhorn.io/docs/1.12.0/deploy/install/airgap

Fetches the official Longhorn deployment manifest file.

```bash
wget https://raw.githubusercontent.com/longhorn/longhorn/v1.12.0/deploy/longhorn.yaml
```

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

### Configure ImagePullSecrets in Deployment

Source: https://longhorn.io/docs/1.12.0/deploy/install/airgap

Example of adding imagePullSecrets to a Kubernetes Deployment manifest.

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: longhorn-ui
  name: longhorn-ui
  namespace: longhorn-system
spec:
  replicas: 1
  selector:
    matchLabels:
      app: longhorn-ui
  template:
    metadata:
      labels:
        app: longhorn-ui
    spec:
      containers:
      - name: longhorn-ui
        image: longhornio/longhorn-ui:v0.8.0
        ports:
        - containerPort: 8000
        env:
          - name: LONGHORN_MANAGER_IP
            value: "http://longhorn-backend:9500"
      imagePullSecrets:
      - name: <SECRET_NAME>                          ## Add SECRET_NAME here
      serviceAccountName: longhorn-service-account
```

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

### Enable Longhorn FlexVolume logging

Source: https://longhorn.io/docs/1.12.0/troubleshoot/troubleshooting

Create the log file to capture detailed output for the FlexVolume driver.

```bash
touch /var/log/longhorn_driver.log
```

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

### Apply GRUB Configuration

Source: https://longhorn.io/docs/1.12.0/deploy/install

Commands to apply GRUB changes based on the system type.

```bash
sudo update-grub
```

```bash
sudo grub2-mkconfig -o /boot/grub2/grub.cfg
```

```bash
sudo grub2-mkconfig -o /boot/efi/EFI/<distro>/grub.cfg
```

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

### Install Longhorn via Helm

Source: https://longhorn.io/docs/1.12.0/deploy/install/install-with-helm

Deploy Longhorn version 1.12.0 into the longhorn-system namespace.

```bash
helm install longhorn longhorn/longhorn --namespace longhorn-system --create-namespace --version 1.12.0
```

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

### V2 StorageClass Configuration

Source: https://longhorn.io/docs/1.12.0/nodes-and-volumes/volumes/create-volumes

Example definition for a StorageClass with the dataEngine parameter set to v2.

```yaml
kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: longhorn-v2-data-engine
provisioner: driver.longhorn.io
allowVolumeExpansion: true
reclaimPolicy: Delete
volumeBindingMode: Immediate
parameters:
  numberOfReplicas: "3"
  staleReplicaTimeout: "2880"
  fsType: "ext4"
  dataEngine: "v2"
```

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

### Longhornctl Help Command

Source: https://longhorn.io/docs/1.12.0/advanced-resources/longhornctl

Displays help information for available commands.

```bash
longhornctl help
```

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

### Manual xfs filesystem resize commands

Source: https://longhorn.io/docs/1.12.0/nodes-and-volumes/volumes/expansion

Commands to mount, grow, and unmount an xfs filesystem.

```bash
mount /dev/longhorn/<volume name> <arbitrary mount directory>
xfs_growfs <the mount directory>
umount /dev/longhorn/<volume name>
```
Tokens:
Raw