summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPrasanna Kumar Kalever <pkalever@redhat.com>2016-12-26 18:34:06 +0530
committerGitHub <noreply@github.com>2016-12-26 18:34:06 +0530
commitbcea2a6f26ac7090f2dcf995b99a9865d354b32a (patch)
treef420dd1e4c0c22e253edd9dda5d5ed2f4158ff7c
parent33cace67e15253d34c72d05cdfb58cccebf0fe64 (diff)
Add README doc
-rw-r--r--README.md252
1 files changed, 252 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d90db6b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,252 @@
+# gluster-block
+gluster-block is a CLI utility, which aims at making gluster backed block storage creation and maintenance as simple as possible.
+
+## License
+gluster-block is licensed to you under your choice of the GNU Lesser General Public License, version 3 or any later version ([LGPLv3](https://opensource.org/licenses/lgpl-3.0.html) or later), or the GNU General Public License, version 2 ([GPLv2](https://opensource.org/licenses/GPL-2.0)), in all cases as published by the Free Software Foundation.
+
+## Gluster
+[Gluster](http://gluster.readthedocs.io/en/latest/) is a well known scale-out distributed storage system, flexible in its design and easy to use. One of its key goals is to provide high availability of data. Despite its distributed nature, Gluster is very easy to setup and use. Addition and removal of storage servers from a Gluster cluster is very easy. These capabilities along with other data services that Gluster provides makes it a reliable software defined storage platform.
+
+We can access glusterfs via [FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace) module. However to perform a single filesystem operation various context switches are required which leads to performance issues. [Libgfapi](http://blog.gluster.org/2014/04/play-with-libgfapi-and-its-python-bindings/) is a userspace library for accessing data in Glusterfs. It can perform IO on gluster volumes without the FUSE module, kernel VFS layer and hence requires no context switches. It exposes a filesystem like API for accessing gluster volumes. Samba, NFS-Ganesha, QEMU and now the tcmu-runner all use libgfapi to integrate with Glusterfs.
+
+> A unique distributed storage solution build on traditional filesystems
+
+### How we achieve block storage in gluster ?
+======
+
+![untitled diagram](https://cloud.githubusercontent.com/assets/12432241/21478518/235e533c-cb72-11e6-9c5a-e351513a34b7.png)
+
+1. Create a file in the gluster volume
+2. We expose the file in the gluster volume as tcmu backstore using tcmu-runner, exporting the target file as iSCSI LUN and
+3. From the initiator we login to the exported LUN and play with the block device
+
+#### Background
+The [SCSI](http://searchstorage.techtarget.com/definition/SCSI) subsystem uses a sort of client-server model. The Client/Initiator request IO happen through target which is a storage device. The SCSI target subsystem enables a computer node to behave as a SCSI storage device, responding to storage requests by other SCSI initiator nodes.
+
+In simple terms SCSI is a set of standards for physically connecting and transferring data between computers and peripheral devices.
+
+The most common implementation of the SCSI target subsystem is an iSCSIserver, [iSCSI](http://searchstorage.techtarget.com/definition/iSCSI) transports block level data between the iSCSI initiator and the target which resides on the actual storage device. iSCSi protocol wraps up the SCSI commands and sends it over TCP/IP layer. Up on receiving the packets at the other end it disassembles them to form the same SCSI commands, hence on the OS’es it seen as local SCSI device.
+
+> In other words iSCSI is SCSI over TCP/IP.
+
+The [LIO](http://linux-iscsi.org/wiki/LIO) project began with the iSCSI design as its core objective, and created a generic SCSI target subsystem to support iSCSI. LIO is the SCSI target in the Linux kernel. It is entirely kernel code, and allows exported SCSI logical units (LUNs) to be backed by regular files or block devices.
+
+> LIO is Linux IO target, is an implementation of iSCSI target.
+
+[TCM](https://www.kernel.org/doc/Documentation/target/tcmu-design.txt) is another name for LIO, an in-kernel iSCSI target (server). As we know existing TCM targets run in the kernel. TCMU (TCM in Userspace) allows userspace programs to be written which act as iSCSI targets. These enables wider variety of backstores without kernel code. Hence the TCMU userspace-passthrough backstore allows a userspace process to handle requests to a LUN. TCMU utilizes the traditional UIO subsystem, which is designed to allow device driver development in userspace.
+
+> One such backstore with best clustered network storage capabilities is GlusterFS
+
+Any TCMU userspace-passthrough can utilize the TCMU framework handling the messy details of the TCMU interface.
+One such passthrough is [Tcmu-runner](https://github.com/open-iscsi/tcmu-runner) (Thanks to Andy Grover). Tcmu-runner has a glusterfs handler that can interact with the backed file in gluster volume over gluster libgfapi interface and can show it as a target (over network).
+
+Some responsibilities of userspace-passthrough include,
+
+Discovering and configuring TCMU UIO devices
+waiting for the events on the device and
+managing the command ring buffers
+
+[TargetCli](https://github.com/Datera/targetcli) is the general management platform for the LIO/TCM/TCMU. TargetCli with its shell interface is used to configure LIO.
+> Think it like a shell which makes life easy in configuring LIO core
+
+### Install
+------
+<pre>
+# git clone https://github.com/pkalever/gluster-block.git
+# cd gluster-block/
+# dnf install libssh-devel libuuid-devel glusterfs-api-devel tcmu-runner targetcli (on fedora)
+# make -j install
+</pre>
+
+### Usage
+------
+**Prerequisites:** *this guide assume we already have*
+- [x] *A volume with name 'sampleVol'*
+- [x] *In all block nodes tcmu-runner.service is running*
+- [x] *There is passwordless access between the node that run gluster-block and nodes running tcmu-runner (ssh-copy-id)*
+
+```script
+# gluster-block --help
+gluster-block (Version 0.1)
+ -c, --create <name> Create the gluster block
+ -v, --volume <vol> gluster volume name
+ -h, --host <gluster-node> node addr from gluster pool
+ -s, --size <size> block storage size in KiB|MiB|GiB|TiB..
+ -l, --list List available gluster blocks
+ -i, --info <name> Details about gluster block
+ -m, --modify <resize|auth> Modify the metadata
+ -d, --delete <name> Delete the gluster block
+[-b, --block-host <IP1,IP2,IP3...>] block servers, clubbed with any option
+```
+
+#### Example 1. Choose to run tcmu-runner on the same node (gluster-block node)
+======
+*192.168.1.11: Node where gluster volume exist<br>
+192.168.1.12: Node where gluster-block installed as well as tcmu-runner.service is running<br>
+192.168.1.13: Initiator, iSCSI client*
+
+<pre>
+Create 2G gluster block storage
+<b># gluster-block --create TARGET1 --volume sampleVol --host 192.168.1.11 --size 2GiB</b>
+[OnHost: localhost]
+Created user-backed storage object TARGET1 size 2147483648.
+Created target iqn.2016-12.org.gluster-block:localhost-a1903cba-7556-4074-8031-530bb35c4236.
+Created TPG 1.
+Global pref auto_add_default_portal=true
+Created default portal listening on all IPs (0.0.0.0), port 3260.
+Created LUN 0.
+Parameter demo_mode_write_protect is now '0'.
+Parameter generate_node_acls is now '1'.
+Last 10 configs saved in /etc/target/backup.
+Configuration saved to /etc/target/saveconfig.json
+
+List available block devices
+<b># gluster-block --list</b>
+BlockName Volname Host Size Status
+[OnHost: localhost]
+ TARGET1 sampleVol 192.168.1.11 2 GiB Online
+
+Info about given block storage
+<b># gluster-block --info TARGET1</b>
+[OnHost: localhost]
+config: glfs/sampleVol@192.168.1.11/a1903cba-7556-4074-8031-530bb35c4236
+name: TARGET1
+plugin: user
+size: 2147483648
+wwn: a1903cba-7556-4074-8031-530bb35c4236
+</pre>
+
+##### On the Initiator machine
+<pre>
+# dnf install iscsi-initiator-utils
+# lsblk (note the available devices)
+# iscsiadm -m discovery -t st -p 192.168.1.12 -l
+# lsblk (note the new device, lets say sdb)
+# mkfs.xfs /dev/sdb
+# mount /dev/sdb /mnt
+</pre>
+
+##### Delete the targets
+<pre>
+On initiator node
+# umount /mnt
+# iscsiadm -m node -u
+
+On the gluster-block node
+<b># gluster-block --delete TARGET1</b>
+[OnHost: localhost]
+Deleted storage object TARGET1.
+Deleted Target iqn.2016-12.org.gluster-block:localhost-a1903cba-7556-4074-8031-530bb35c4236.
+</pre>
+
+#### Example 2. Choose to run tcmu-runner on the multiple different nodes
+======
+*192.168.1.11: Node where gluster volume exist<br>
+192.168.1.12: Node where gluster-block installed<br>
+192.168.1.13, 192.168.1.14, 192.168.1.15: All nodes run tcmu-runner.service (three nodes to achieve mutipath for HA)<br>
+192.168.1.16: Initiator, iSCSI client*
+
+<pre>
+Create 1G gluster block storage
+<b># gluster-block --create TARGET1 --volume sampleVol --host 192.168.1.11 --size 1GiB --block-host 192.168.1.13,192.168.1.14,192.168.1.15</b>
+[OnHost: <b>192.168.1.13</b>]
+Created user-backed storage object TARGET1 size 1073741824.
+Created target iqn.2016-12.org.gluster-block:192.168.1.13-91b990b6-952c-4ded-b42a-dd238bce21b6.
+Created TPG 1.
+Global pref auto_add_default_portal=true
+Created default portal listening on all IPs (0.0.0.0), port 3260.
+Created LUN 0.
+Parameter demo_mode_write_protect is now '0'.
+Parameter generate_node_acls is now '1'.
+Last 10 configs saved in /etc/target/backup.
+Configuration saved to /etc/target/saveconfig.json
+
+[OnHost: <b>192.168.1.14</b>]
+Created user-backed storage object TARGET1 size 1073741824.
+Created target iqn.2016-12.org.gluster-block:192.168.1.14-91b990b6-952c-4ded-b42a-dd238bce21b6.
+Created TPG 1.
+Global pref auto_add_default_portal=true
+Created default portal listening on all IPs (0.0.0.0), port 3260.
+Created LUN 0.
+Parameter demo_mode_write_protect is now '0'.
+Parameter generate_node_acls is now '1'.
+Last 10 configs saved in /etc/target/backup.
+Configuration saved to /etc/target/saveconfig.json
+
+[OnHost: <b>192.168.1.15</b>]
+Created user-backed storage object TARGET1 size 1073741824.
+Created target iqn.2016-12.org.gluster-block:192.168.1.15-91b990b6-952c-4ded-b42a-dd238bce21b6.
+Created TPG 1.
+Global pref auto_add_default_portal=true
+Created default portal listening on all IPs (0.0.0.0), port 3260.
+Created LUN 0.
+Parameter demo_mode_write_protect is now '0'.
+Parameter generate_node_acls is now '1'.
+Last 10 configs saved in /etc/target/backup.
+Configuration saved to /etc/target/saveconfig.json
+
+<b># gluster-block --list --block-host 192.168.1.13,192.168.1.14,192.168.1.15</b>
+BlockName Volname Host Size Status
+[OnHost: <b>192.168.1.13</b>]
+ TARGET1 sampleVol 192.168.1.11 1 GiB Online
+[OnHost: <b>192.168.1.14</b>]
+ TARGET1 sampleVol 192.168.1.11 1 GiB Online
+[OnHost: <b>192.168.1.15</b>]
+ TARGET1 sampleVol 192.168.1.11 1 GiB Online
+
+<b># gluster-block --info TARGET1 --block-host 192.168.1.13,192.168.1.14,192.168.1.15</b>
+[OnHost: <b>192.168.1.13</b>]
+config: glfs/sampleVol@192.168.1.11/91b990b6-952c-4ded-b42a-dd238bce21b6
+name: TARGET1
+plugin: user
+size: 1073741824
+wwn: 91b990b6-952c-4ded-b42a-dd238bce21b6
+
+[OnHost: <b>192.168.1.14</b>]
+config: glfs/sampleVol@192.168.1.11/91b990b6-952c-4ded-b42a-dd238bce21b6
+name: TARGET1
+plugin: user
+size: 1073741824
+wwn: 91b990b6-952c-4ded-b42a-dd238bce21b6
+
+[OnHost: <b>192.168.1.15</b>]
+config: glfs/sampleVol@192.168.1.11/91b990b6-952c-4ded-b42a-dd238bce21b6
+name: TARGET1
+plugin: user
+size: 1073741824
+wwn: 91b990b6-952c-4ded-b42a-dd238bce21b6
+</pre>
+
+##### On the Initiator machine
+<pre>
+# dnf install iscsi-initiator-utils
+# lsblk (note the available devices)
+
+Make sure you have multipathd running and configured
+# iscsiadm -m discovery -t st -p 192.168.1.13 -l
+# iscsiadm -m discovery -t st -p 192.168.1.14 -l
+# iscsiadm -m discovery -t st -p 192.168.1.15 -l
+
+# lsblk (note the new devices, let's say sdb, sdc and sdd multipath to mpatha)
+# mkfs.xfs /dev/mapper/mpatha
+# mount /dev/mapper/mpatha /mnt
+</pre>
+
+##### Delete the targets
+<pre>
+On initiator node
+# umount /mnt
+# iscsiadm -m node -u
+
+On the gluster-block node
+<b># gluster-block --delete TARGET1 --block-host 192.168.1.13,192.168.1.14,192.168.1.15</b>
+[OnHost: <b>192.168.1.13</b>]
+Deleted storage object TARGET1.
+Deleted Target iqn.2016-12.org.gluster-block:192.168.1.13-91b990b6-952c-4ded-b42a-dd238bce21b6.
+[OnHost: <b>192.168.1.14</b>]
+Deleted storage object TARGET1.
+Deleted Target iqn.2016-12.org.gluster-192.168.1.14-91b990b6-952c-4ded-b42a-dd238bce21b6.
+[OnHost: <b>192.168.1.15</b>]
+Deleted storage object TARGET1.
+Deleted Target iqn.2016-12.org.gluster-block:192.168.1.15-91b990b6-952c-4ded-b42a-dd238bce21b6.
+</pre>