Glusterfs-volgen Reference Page

From GlusterDocumentation

Contents

Summary

glusterfs-volgen - A tool to generate volume files for GlusterFS.

Usage

glusterfs-volgen is a tool to generate volume files of GlusterFS, based on the command line arguments passed. The generated volume specification files are written in the current working directory with the names <volumename>-<transport_type>.vol and <hostname>-<volumename>-export.vol.

 $ glusterfs-volgen --help
 Usage: glusterfs-volgen: -n <VOLUMENAME> -t <TRANSPORT> -p <NUMBER> -a <AUTH>
 -r <TYPE>
 A tool to generate volume files for GlusterFS.
 Options:
    --version             show program's version number and exit
    -h, --help            show this help message and exit
 Basic Options:
   -n VOLUME_NAME, --name=VOLUME_NAME
                       <volume-name>
   -t TRANSPORT_TYPE, --transport=TRANSPORT_TYPE
                       tcp,ib-verbs default: tcp
   -p PORT, --port=PORT
                       <port> number
   -a AUTH_PARAM, --auth=AUTH_PARAM
                       comma seperated ip range
   -r RAID_TYPE, --raid=RAID_TYPE
                       0|1
 Advanced Options:
   --ibdev=IB_DEV      Infiniband device number <N>
   -c CONF_DIR, --conf-dir=CONF_DIR
                       output directory for volume files
   --volume-size-server=SIZE_SERVER
                       volume size for each server
   --volume-size-client=SIZE_CLIENT
                       volume size for each client
 Extra Options:
   --unused            enable unused options


The <hostname>-<volumename>-export.vol and <volumename>-<transport_type>.vol files have to be placed in /etc/glusterfs on all servers (specified as HOST1:<EXPORT_DIR> HOST2:<EXPORT_DIR ..). The <hostname>-<volumename>-export.vol file contains the configuration information for the servers. The <volumename>-<transport_type>.vol file contains the configuration information for the clients (which retrieve this file from the server at the time of mounting).

Mandatory Parameters:

--name <volname>     

An identifier name for the volume being defined.

host1:/<export_dir> ..           

Hostnames or IP addresses of the list of servers.


Optional Parameters:

--transport         

Type of transport to use as the connection between the servers and clients. The default transport is TCP sockets. To use InfiniBand verbs, specify ib-verbs as the transport.

--raid              

Type of clustering to be used internally:

  • 0 = striping: a distributed striped volume.
  • 1 = replication: a distributed replicated volume (with 2 copies of all files).


Examples:

Create a simple distributed volume of 8 servers:

$ glusterfs-volgen --name store1 hostname001:/export/sdb1 hostname002:/export/sdb1 .. hostname008:/export/sdb1

Create a distributed replicated volume of 8 servers:

$ glusterfs-volgen --name repstore1 --raid 1 hostname001:/export/sdb1 .. hostname008:/export/sdb1

Create a distributed volume over InfiniBand with 2GB client caching:

$ glusterfs-volgen --name ibstore1 --transport ib-verbs hostname001:/export/sdb1 .. hostname008:/export/sdb1

Create a striped volume over InfiniBand:

$ glusterfs-volgen --name ibstripe1 --transport ib-verbs --raid 0 hostname001:/export/sdb1 .. hostname008:/export/sdb1

Related Information

For the user guide instructions on configuring your server, see Configuring GlusterFS.

 

Copyright © 2009 Gluster, Inc. All Rights Reserved.