Skip to content

QUICKSTART.md

Latest commit

 

History

History
102 lines (63 loc) · 2.46 KB

QUICKSTART.md

File metadata and controls

102 lines (63 loc) · 2.46 KB
layout default
title NVMe-TCP on Debian/Ubuntu - Quick Start Guide

NVMe-TCP on Debian/Ubuntu - Quick Start Guide

This guide provides a streamlined path to configure NVMe-TCP storage on Debian and Ubuntu systems.

📘 For detailed explanations, alternative configurations, and troubleshooting: See NVMe-TCP Best Practices

{% include quickstart/disclaimer.md %}

Prerequisites

  • Debian 11+ or Ubuntu 20.04 LTS+
  • NVMe-TCP storage array with portal IPs and subsystem NQN
  • Dedicated storage network interfaces
  • Root or sudo access

{% include quickstart/glossary-link-nvme.md %}

Step 1: Install NVMe Tools

sudo apt update
sudo apt install -y nvme-cli
nvme version

{% include quickstart/nvme-enable-multipath.md %}

Step 3: Configure Network Interfaces

{% include quickstart/network-debian.md %}

{% include quickstart/arp-warning.md %}

Step 4: Configure Firewall

{% include quickstart/firewall-debian.md %}

Alternative: For port filtering options, see Best Practices - Firewall Configuration.

Step 5: Generate Host NQN

{% include quickstart/nvme-generate-hostnqn.md %}

Step 6: Connect to Storage

{% include quickstart/nvme-connect-storage.md %}

Step 7: Configure IO Policy

{% include quickstart/nvme-io-policy.md %}

Step 8: Configure Persistent Connections

{% include quickstart/nvme-persistent-connections.md %}

Step 9: Create LVM Storage

{% include quickstart/nvme-lvm-storage.md %}

# Format and mount (Debian/Ubuntu: ext4 recommended)
sudo mkfs.ext4 /dev/nvme-storage/data
sudo mkdir -p /mnt/nvme-storage
sudo mount /dev/nvme-storage/data /mnt/nvme-storage

# Add to fstab
echo '/dev/nvme-storage/data /mnt/nvme-storage ext4 defaults,_netdev 0 0' | sudo tee -a /etc/fstab

Step 10: Verify

{% include quickstart/nvme-verify.md %}

{% include quickstart/nvme-quick-reference.md %}

Next Steps

For production deployments, see NVMe-TCP Best Practices for:

  • Network design and VLAN configuration
  • Performance tuning
  • Security best practices (AppArmor, firewall options)
  • Monitoring and troubleshooting
  • Netplan and interfaces alternatives

Additional Resources:

  • [Common Network Concepts]({{ site.baseurl }}/common/network-concepts.html)
  • [Troubleshooting Guide]({{ site.baseurl }}/common/troubleshooting-common.html)
  • [Storage Terminology Glossary]({{ site.baseurl }}/common/glossary.html)