ivampiresp/longhorn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
sheng-liang 2017-04-14 19:37:08 -07:00 committed by GitHub
parent 1f718f3589
commit bcd829a05a
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -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! 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: 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. 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. 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. 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://<host_ip>:8080`. Congratulations! Now you have Longhorn running on the host and can access the UI at `http://<host_ip>: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. 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. # 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. 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. 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 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 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