From bcd829a05ac7eb1fe740e7a592a45c1dd0a1e9a6 Mon Sep 17 00:00:00 2001 From: sheng-liang Date: Fri, 14 Apr 2017 19:37:08 -0700 Subject: [PATCH] Update README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b781ccf..58050e2 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,14 @@ Longhorn is a distributed block storage system built using the idea of associati Longhorn is experimental software. We appreciate your comments as we continue to work on it! -# Requirements +## Requirements Longhorn requires one or more hosts running the following software: 1. We have tested with Ubuntu 16.04. Other Linux distros, including CentOS and RancherOS, will be tested in the future. 2. Make sure `open-iscsi` package is installed on the host. If `open-iscsi` package is installed, the `iscsiadm` executable should be available. Ubuntu Server install by default includes `open-iscsi`. Ubuntu Desktop doesn't. -# Single node setup +## Single node setup You can setup all the components required to run Longhorn on a single Linux host. In this case Longhorn will create multiple replicas for the same volume on the same host. This is therefore not a production-grade setup. @@ -29,7 +29,7 @@ Longhorn is up at port 8080 ``` Congratulations! Now you have Longhorn running on the host and can access the UI at `http://:8080`. -#### Setup a simple NFS server for backup store +### Setup a simple NFS server for storing backups Longhorn's backup feature requires an NFS server or an S3 endpoint. You can setup a simple NFS server on the same host and use that to store backups. ``` # Make sure you have nfs-kernel-server package installed. @@ -45,7 +45,7 @@ nfs://10.0.0.5:/opt/backupstore ``` Open Longhorn UI, go to `Setting`, fill the `Backup Target` field with the URL above, click `Save`. Now you should able to use the backup feature of Longhorn. -# Create Longhorn volume from Docker CLI +## Create Longhorn volume from Docker CLI You can now create a persistent Longhorn volume from Docker CLI using the Longhorn volume driver and use the volume in Docker containers. @@ -57,6 +57,6 @@ docker volume create -d longhorn vol1 docker run -it --volume-driver longhorn -v vol1:/vol1 ubuntu bash ``` -# Multi-host setup +## Multi-host setup Single-host setup is not suitable for production use. You can find instructions for multi-host setup here: https://github.com/rancher/longhorn/wiki/Multi-Host-Setup-Guide