deb/xtreemfs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Imported Upstream version 1.5.1

Browse Source
This commit is contained in:
Mario Fetka
2020-09-22 02:25:22 +02:00
commit 434d6067d9
2103 changed files with 928962 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
man/man1/lsfs.xtreemfs.1 Normal file
View File

@@ -0,0 +1,68 @@
.TH lsfs.xtreemfs 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS client"
.SH NAME
lsfs.xtreemfs - list all XtreemFS volumes on an MRC
.SH SYNOPSIS
\fBlsfs.xtreemfs [\fIoptions\fB] [pbrpc[g|s]://]\fImrc-host\fR[:\fIport\fR]
.br
.SH DESCRIPTION
.I lsfs.xtreemfs
lists all volumes located on the XtreemFS MRC running at \fImrc-host\fR:\fIport\fR.
.SH EXAMPLE USAGE
.TP
List all volumes of the MRC server "remote.mrc.machine":
.TP
.B "lsfs.xtreemfs remote.mrc.machine
.SH OPTIONS
.TP
Admin Password:
.TP
.BI "--admin_password " password
MRC's admin_password (not required if not set at the MRC).
.TP
General Options:
.TP
.BI "-d, --log-level " EMERG|ALERT|CRIT|ERR|WARNING|NOTICE|INFO|DEBUG
The log level of the XtreemFS client.
.TP
.B "-h, --help"
Print help and exit.
.TP
.BI "-l, --log-file-path " log_file_path
Path to log file.
.TP
.BI "-V, --version"
Shows the version number.
.TP
SSL Options:
.TP
.BI "--pem-certificate-file-path " certfile
Path to PEM certificate file (for SSL installations only).
.TP
.BI "--pem-private-key-file-path " file
Path to PEM private key file (for SSL installations only).
.TP
.BI "--pem-private-key-passphrase " pass
Passphrase for PEM private key file (for SSL installations only)
.TP
.BI "--pkcs12-file-path " file
Path to PKCS#12 file (for SSL installations only).
.TP
.BI "--pkcs12-passphrase " pass
Passphrase for PKCS#12 file (for SSL installations only).
.SH "SEE ALSO"
.BR mkfs.xtreemfs (1),
.BR mount.xtreemfs (1),
.BR rmfs.xtreemfs (1),
.BR umount.xtreemfs (1),
.BR xtfsutil (1)
.BR
.SH AVAILABILITY
The lsfs.xtreemfs command is part of the XtreemFS-client package and is available from \fIhttp://www.xtreemfs.org\fP.

145
man/man1/mkfs.xtreemfs.1 Normal file
View File

@@ -0,0 +1,145 @@
.TH mkfs.xtreemfs 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS client"
.SH NAME
mkfs.xtreemfs - create a new XtreemFS volume
.SH SYNOPSIS
\fBmkfs.xtreemfs [\fIoptions\fB] [pbrpc[g|s]://]\fImrc-host\fR[:\fIport\fR]/\fIvolume
.br
.SH DESCRIPTION
.I mkfs.xtreemfs
Creates a new volume named \fIvolume\fR at the MRC \fImrc-host\fR:\fIport\fR.
.SH EXAMPLE USAGE
.TP
Create the volume "MyVolume" on the MRC server "remote.mrc.machine":
.TP
.B "mkfs.xtreemfs remote.mrc.machine/MyVolume"
.br
.TP
Create a volume with a default striping width of 2 meaning files will be always striped across 2 OSDs.
.TP
.B "mkfs.xtreemfs \-p RAID0 \-w 2 remote.mrc.machine/MyVolume"
.SH OPTIONS
.TP
Admin Password:
.TP
.BI "--admin_password " password
MRC's admin_password (not required if not set at the MRC).
.TP
Volume Options:
.TP
.BI "-m, \--mode " mode
Mode of the volume's root directory (777 by default).
.TP
.BI "-u, \--owner-username " username
Owner of the new volume (by default it is the username of the effective user id).
.TP
.BI "-g, \--owner-groupname " groupname
Owning group of the new volume (by default its the groupname of the effective
group id).
.TP
.BI "-a, \--access-control-policy " NULL|POSIX|VOLUME
Access Control Policy of the volume. By default
.IR POSIX .
.TP
Striping Policy Options:
.TP
.BI "-p, \--striping-policy " RAID0
Default striping policy for new files. Currently only the policy
.I RAID0
is available. Please do not get confused by the name
.IR RAID0 .
If the default
.I \--striping-policy-width
of 1 is used, all objects of a file are stored on the same OSD and there is no higher failure probability compared to storing files on other file systems.
.TP
.BI "-s, \--striping-policy-stripe-size " stripe-size
Stripe size in kB.
.TP
.BI "-w, \--striping-policy-width " stripe-width
Number of OSDs (stripes) per replica.
.TP
Volume Attributes:
.TP
.BI "--volume-attribute " name=value
Define volume specific attributes of the form
.IR name=value ,
e.g. "chown_non_root=true".
.TP
.B "--chown-non-root"
Shortcut for \--volume-attribute chown_non_root=true. If this attribute is not set, regular users (everybody except root) are not allowed to change the ownership of their
.B own
files.
.TP
General Options:
.TP
.BI "-d, \--log-level " EMERG|ALERT|CRIT|ERR|WARNING|NOTICE|INFO|DEBUG
The log level of the XtreemFS client.
.TP
.B "-h, \--help"
Print help and exit.
.TP
.BI "-l, \--log-file-path " log_file_path
Path to log file.
.TP
.BI "-V, \--version"
Shows the version number.
.TP
SSL Options:
.TP
.BI "--pem-certificate-file-path " certfile
Path to PEM certificate file (for SSL installations only).
.TP
.BI "--pem-private-key-file-path " file
Path to PEM private key file (for SSL installations only).
.TP
.BI "--pem-private-key-passphrase " pass
Passphrase for PEM private key file (for SSL installations only)
.TP
.BI "--pkcs12-file-path " file
Path to PKCS#12 file (for SSL installations only).
.TP
.BI "--pkcs12-passphrase " pass
Passphrase for PKCS#12 file (for SSL installations only).
.TP
Grid Support options:
.TP
.B "--grid-ssl "
Explicitily use the XtreemFS Grid-SSL mode. Same as specifying pbrpcg:// in the volume URL.
.TP
.B "--globus-gridmap"
Authorize using globus gridmap file.
.TP
.B "--unicore-gridmap"
Authorize using unicore gridmap file.
.TP
.BI "--gridmap-location " path
Location of the gridmap file. If this option is not set, the default path will be used, depending on the chosen gridmap file:
.RS
Unicore default: /etc/grid-security/d-grid_uudb
Globus default: /etc/grid-security/grid-mapfile
.RE
.TP
.BI "--gridmap-reload-interval-m " interval
Interval (in minutes) after which the gridmap file will be checked for changes and reloaded if necessary. 60 minutes by default.
.SH "SEE ALSO"
.BR lsfs.xtreemfs (1),
.BR mount.xtreemfs (1),
.BR rmfs.xtreemfs (1),
.BR umount.xtreemfs (1),
.BR xtfsutil (1)
.BR
.SH AVAILABILITY
The mkfs.xtreemfs command is part of the XtreemFS-client package and is available from \fIhttp://www.xtreemfs.org\fP.

189
man/man1/mount.xtreemfs.1 Normal file
View File

@@ -0,0 +1,189 @@
.TH mount.xtreemfs 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS client"
.SH NAME
mount.xtreemfs \- mounts an XtreemFS volume
.SH SYNOPSIS
\fBmount.xtreemfs [\fIoptions\fB] [pbrpc[g|s]://]\fIdir-host\fR[:\fIport\fR]/\fIvolume mountpoint
.br
.SH DESCRIPTION
.I mount.xtreemfs
mounts the volume \fIvolume\fR registered at the Directory Service \fIdir-host\fR:\fIport\fR to the local directory \fImountpoint\fR. \fImount.xtreemfs\fR is implemented as a FUSE user-level file system driver.
.SH EXAMPLE USAGE
.TP
Mount the volume "MyVolume" (which is registered at the DIR server "remote.dirservice.machine") to the mount point "/mnt":
.TP
.B "mount.xtreemfs remote.dirservice.machine/MyVolume /mnt"
.SH OPTIONS
.TP
Fuse Options:
.TP
.B "-f, \--foreground"
Do not fork into background.
.TP
.BI "-o, \--fuse_option " option
Passes \-o=<\fIoption\fR> to Fuse.
.TP
ACL and extended attributes Support:
.TP
.B "-o xtreemfs_acl"
Enable the correct evaluation of XtreemFS ACLs. (Note that you cannot use the system tools getfattr and setfattr; use
.BR xtfsutil (1)
instead to set and retrieve ACLs.)
.TP
.B "-o user_xattr"
Enable user defined extended attributes.
.TP
General Options:
.TP
.BI "-d, \--log-level " EMERG|ALERT|CRIT|ERR|WARNING|NOTICE|INFO|DEBUG
The log level of the XtreemFS client.
.TP
.B "-h, \--help"
Print help and exit.
.TP
.BI "-l, \--log-file-path " log_file_path
Path to log file.
.TP
.BI "-V, \--version"
Shows the version number.
.TP
Optimizations:
.TP
.BI "--metadata-cache-size " size
Number of entries which will be cached. (Set to 0 to disable the cache.)
.TP
.BI "--metadata-cache-ttl-s " ttl
Time to live after which cached entries will expire.
.TP
.BI "--enable-async-writes"
Enables asynchronous writes.
.TP
.BI "--async-writes-max-reqs " count
Maximum number of pending write requests per file. Asynchronous writes will block if this limit is reached first.
.TP
.BI "--readdir-chunk-size " size
Number of directory entries which will be fetched from the MRC per readdir request. Do not set this value too high - otherwise the MRC will spent too much time generating the response containing thousands of directory entries. In general, you should not have directories with multiple thousands of entries. If you stick to this, all directory entries are fetched with one request as long as this value is lower than the number of entries.
.TP
Error Handling options:
.TP
.BI "--max-tries " attempts
Maximum number of
.I attempts
to send a request (0 means infinite).
.TP
.BI "--max-read-tries " attempts
Maximum number of
.I attempts
to send a
.I read
request (0 means infinite).
.TP
.BI "--max-write-tries " attempts
Maximum number of
.I attempts
to send a
.I write
request (0 means infinite).
.TP
.BI "--retry-delay " delay
Wait time after a request failed until next attempt (in seconds).
.TP
.BI "--connect-timeout " connection-timeout
Timeout after which a connection attempt will be retried (in seconds).
.TP
.BI "--request-timeout " timeout
Timeout after which a request will be retried (in seconds).
.TP
.BI "--linger-timeout " linger-time
Time after which idle connections will be closed (in seconds).
.TP
SSL Options:
.TP
.BI "--pem-certificate-file-path " certfile
Path to PEM certificate file (for SSL installations only).
.TP
.BI "--pem-private-key-file-path " file
Path to PEM private key file (for SSL installations only).
.TP
.BI "--pem-private-key-passphrase " pass
Passphrase for PEM private key file (for SSL installations only). If the argument \fIpass\fR is set to "-", the user will be prompted for the passphrase.
.TP
.BI "--pkcs12-file-path " file
Path to PKCS#12 file (for SSL installations only).
.TP
.BI "--pkcs12-passphrase " pass
Passphrase for PKCS#12 file (for SSL installations only). If the argument \fIpass\fR is set to "-", the user will be prompted for the passphrase.
.TP
Grid Support options:
.TP
.B "--grid-ssl "
Explicitily use the XtreemFS Grid-SSL mode. Same as specifying pbrpcg:// in the volume URL.
.TP
.B "--globus-gridmap"
Authorize using globus gridmap file.
.TP
.B "--unicore-gridmap"
Authorize using unicore gridmap file.
.TP
.BI "--gridmap-location " path
Location of the gridmap file. If this option is not set, the default path will be used, depending on the chosen gridmap file:
.RS
Unicore default: /etc/grid-security/d-grid_uudb
Globus default: /etc/grid-security/grid-mapfile
.RE
.TP
.BI "--gridmap-reload-interval-m " interval
Interval (in minutes) after which the gridmap file will be checked for changes and reloaded if necessary. 60 minutes by default.
.TP
Vivaldi options:
.TP
.B "--vivaldi-enable"
Enables the vivaldi coordinate calculation for the client.
.TP
.B "--vivaldi-enable-dir-updates"
Enables sending the coordinates to the DIR after each recalculation. This is only needed to add the clients to the vivaldi visualization at the cost of some additional traffic between client and DIR.
.TP
.B "--vivaldi-filename " path
The file where the vivaldi coordinates should be saved after each recalculation.
.TP
.BI "--vivaldi-recalculation-interval " seconds
The interval between coordinate recalculations in seconds. Also see vivaldi-recalculation-epsilon.
.TP
.BI "--vivaldi-recalculation-epsilon " seconds
The recalculation interval will be randomly chosen from vivaldi-recalculation-inverval +/- vivaldi-recalculation-epsilon.
.TP
.BI "--vivaldi-max-iterations-before-updating " count
Number of coordinate recalculations before updating the list of OSDs.
.TP
.BI "--vivaldi-max-request-retries " retries
Maximal number of retries when requesting coordinates from another vivaldi node.
.SH "SEE ALSO"
.BR lsfs.xtreemfs (1),
.BR mkfs.xtreemfs (1),
.BR rmfs.xtreemfs (1),
.BR umount.xtreemfs (1),
.BR xtfsutil (1)
.BR
.SH "KNOWN ISSUES"
FUSE does not support mmap in connection with direct I/O. In order to get applications running on XtreemFS that rely on mmap, volumes have to be mounted without using the FUSE option
.BR "-o direct_io" .
However, this might lead to inconsistencies if different clients access a file concurrently, as requests might be serviced from the local page cache.
If
.B "-o xtreemfs_acl"
or a gridmap file is used, the Fuse default permissions check will be disabled. In consequence, the Fuse Option "\-o default_permissions" will not be sent to Fuse. In these cases, the content of the metadata cache may be spoofed by users although they are not allowed to list the directory or retrieve the stat information of a file.
.SH AVAILABILITY
The mount.xtreemfs command is part of the XtreemFS-client package and is available from \fIhttp://www.xtreemfs.org\fP.

75
man/man1/rmfs.xtreemfs.1 Normal file
View File

@@ -0,0 +1,75 @@
.TH rmfs.xtreemfs 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS client"
.SH NAME
rmfs.xtreemfs - delete a volume including all files on an XtreemFS MRC
.SH SYNOPSIS
\fBrmfs.xtreemfs [\fIoptions\fB] [pbrpc[g|s]://]\fImrc-host\fR[:\fIport\fR]/\fIvolume
.br
.SH DESCRIPTION
.I rmfs.xtreemfs
deletes the volume named \fIvolume\fR from the XtreemFS MRC running at \fImrc-host\fR:\fIport\fR. Be careful, this command will delete the volume including the metadata of all files.
However, the disk space on the OSDs, occupied by the objects of the files of the deleted volume, will not be freed by \fIrmfs.xtreemfs\fR. Run
.BR xtfs_cleanup (1)
afterwards to free the disk space on the OSDs.
.SH EXAMPLE USAGE
.TP
Delete the volume "MyVolume" which is stored at the MRC server "remote.mrc.machine":
.TP
.B "rmfs.xtreemfs remote.mrc.machine/MyVolume"
.SH OPTIONS
.TP
rmfs.xtreemfs Options:
.TP
.BI "--admin_password " password
MRC's admin_password (not required if not set at the MRC).
.TP
.BI "-f, --force"
Never prompt. Overrides safety questions.
.TP
General Options:
.TP
.BI "-d, --log-level " EMERG|ALERT|CRIT|ERR|WARNING|NOTICE|INFO|DEBUG
The log level of the XtreemFS client.
.TP
.B "-h, --help"
Print help and exit.
.TP
.BI "-l, --log-file-path " log_file_path
Path to log file.
.TP
.BI "-V, --version"
Shows the version number.
.TP
SSL Options:
.TP
.BI "--pem-certificate-file-path " certfile
Path to PEM certificate file (for SSL installations only).
.TP
.BI "--pem-private-key-file-path " file
Path to PEM private key file (for SSL installations only).
.TP
.BI "--pem-private-key-passphrase " pass
Passphrase for PEM private key file (for SSL installations only)
.TP
.BI "--pkcs12-file-path " file
Path to PKCS#12 file (for SSL installations only).
.TP
.BI "--pkcs12-passphrase " pass
Passphrase for PKCS#12 file (for SSL installations only).
.SH "SEE ALSO"
.BR lsfs.xtreemfs (1),
.BR mkfs.xtreemfs (1),
.BR mount.xtreemfs (1),
.BR umount.xtreemfs (1),
.BR xtfsutil (1)
.BR
.SH AVAILABILITY
The rmfs.xtreemfs command is part of the XtreemFS-client package and is available from \fIhttp://www.xtreemfs.org\fP.

23
man/man1/umount.xtreemfs.1 Normal file
View File

@@ -0,0 +1,23 @@
.TH umount.xtreemfs 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS client"
.SH NAME
umount.xtreemfs \- unmounts an XtreemFS volume
.SH SYNOPSIS
\fBumount.xtreemfs \fIvolume mountpoint
.br
.SH DESCRIPTION
.I umount.xtreemfs
umounts the volume that has been mounted to \fIvolume\fR.
.SH EXAMPLE USAGE
.B "umount.xtreemfs /mnt"
.SH "SEE ALSO"
.BR lsfs.xtreemfs (1),
.BR mkfs.xtreemfs (1),
.BR mount.xtreemfs (1),
.BR rmfs.xtreemfs (1)
.BR
.SH AVAILABILITY
The umount.xtreemfs command is part of the XtreemFS-client package and is available from \fIhttp://www.xtreemfs.org\fP.

45
man/man1/xtfs_chstatus.1 Normal file
View File

@@ -0,0 +1,45 @@
.TH xtfs_chstatus 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS Admin Tools"
.SH NAME
xtfs_chstatus \- changes the status flag of an OSD.
.SH SYNOPSIS
\fBxtfs_chstatus [ \fIoptions\fB ] \fI<osd_uuid> online|removed\fB
.br
.SH DESCRIPTION
.I xtfs_chstatus
displays and changes the status flag of an OSD. The status can be 0 (online), 1 (locked) and 2 (permanently dead/removed). The status flag is used by the scrubber to identify dead OSDs. Files and replicas on dead OSDs are removed by the scrubber tool.
.SH EXAMPLE USAGE
.TP
.B "xtfs_chstatus -dir pbrpc://localhost:32638 2e3d-424b-b3d2 removed
Changes the status of the OSD with UUID 2e3d-424b-b3d2 registered at the Directory Service 'pbrpc://localhost:32638' to 2 (removed)
.SH OPTIONS
.TP
\fB-c \fI<creds_file>
Path to a PKCS#12 credentials file (private key + certificate) to use for SSL authentication. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
\fB-cpass \fI<creds_passphrase>
An optional passphrase to access the credentials file.
.TP
\fB-dirs \fI<uri(,uri...)>
Specifies the directory services to use (e.g. 'pbrpc://localhost:32638,pbrpc://myDir.com:32638') (comma-separated). If no URI is specified, URIs and security settings are taken from '/etc/xos/xtreemfs/default_dir'. In case of a secured URI ('pbrpcs://...' or 'pbrpcg://...'), it is necessary to also specify SSL settings.
.TP
\fB-h/--help
Show usage info.
.TP
\fB-t \fI<trusted_CAs>
Path to a PKCS#12 file containing a set of certificates from trusted certification authorities. These certificates will be used to authenticate the MRC. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
\fB-tpass \fI<trusted_passphrase>
An optional passphrase to access the truststore file.
.SH "SEE ALSO"
.BR xtfs_cleanup (1),
.BR xtfs_mrcdbtool (1),
.BR xtfs_remove_osd (1),
.BR xtfs_scrub (1),
.BR
.SH AVAILABILITY
The xtfs_chstatus command is part of the XtreemFS-tools package and is available from \fIhttp://www.xtreemfs.org\fP.

75
man/man1/xtfs_cleanup.1 Normal file
View File

@@ -0,0 +1,75 @@
.TH xtfs_cleanup 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS Admin Tools"
.SH NAME
xtfs_cleanup \- checks for each file on the OSD, if it has an entry at the Metadata Server (MRC).
.SH SYNOPSIS
\fBxtfs_cleanup [ \fIoptions\fB ] \fIuuid:<osd_uuid>
.BR
.SH DESCRIPTION
.I xtfs_cleanup
performs a check of each file on the given Object Storage Device (OSD) whether it is registered at a MRC or not and removes orphaned OSD metadata.
.SH EXAMPLE USAGE
.TP
.B "xtfs_cleanup -e uuid:d1feb333-d986-4e91-b8e7-eb2a48485f8b"
Starts the cleanup process on the OSD identified by UUID 'd1feb333-d986-4e91-b8e7-eb2a48485f8b' and deletes all orphaned files automatically.
.SH OPTIONS
.TP
\fB-c \fI<creds_file>
Path to a PKCS#12 credentials file (private key + certificate) to use for SSL authentication. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
\fB-cpass \fI<creds_passphrase>
An optional passphrase to access the credentials file.
.TP
\fB-delete_volumes
Deletes volumes that might be dead.
.TP
\fB-dir \fI<uri(,uri...)>
Specifies the directory services to use (e.g. 'pbrpc://localhost:32638,pbrpc://myDir.com:32638') (comma-separated). If no URI is specified, URIs and security settings are taken from '/etc/xos/xtreemfs/default_dir'. In case of a secured URI ('pbrpcs://...' or 'pbrpcg://...'), it is necessary to also specify SSL settings.
.TP
\fB-e
Automatically deletes orphaned files.
.TP
\fB-h/--help
Shows usage info.
.TP
\fB-i
Enables the interactive mode and displays the cleanup progress.
.TP
\fB-metadata_timeout \fI<timeout>
Metadata will only be deleted, if the last XLocSet update was more than \fI<timeout>\fR seconds ago. The default \fI<timeout>\fR is equal to the default capability timeout: 600. If \fI<timeout>\fR is 0, metadata will be deleted instantly.
.TP
\fB-metadata_keep
Keep metadata when files are deleted and don't search for orphaned metadata. By default metadata will be deleted after \fI<timeout>\fR seconds.
.TP
\fB-r
Restores all orphaned files to a directory '/lost+found/' in the volume root directory.
.TP
\fB-stop
Suspends the currently running cleanup process.
.TP
\fB-t \fI<trusted_CAs>
Path to a PKCS#12 file containing a set of certificates from trusted certification authorities. These certificates will be used to authenticate the MRC. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
\fB-tpass \fI<trusted_passphrase>
An optional passphrase to access the truststore file.
.TP
.B \-v
Run a version cleanup, which disposes of obsolete file versions. A version cleanup will only affect files with multiple versions.
.TP
.B \-wait
Blocks the call until the current cleanup run has finished.
.TP
.B \--admin_password \fI<passphrase>
The administrator password, if password protection is enabled.
.SH "SEE ALSO"
.BR xtfs_chstatus (1),
.BR xtfs_mrcdbtool (1),
.BR xtfs_remove_osd (1),
.BR xtfs_scrub (1),
.BR
.SH AVAILABILITY
The xtfs_cleanup command is part of the XtreemFS-tools package and is available from \fIhttp://www.xtreemfs.org\fP.

51
man/man1/xtfs_mrcdbtool.1 Normal file
View File

@@ -0,0 +1,51 @@
.TH xtfs_mrcdbtool 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS Admin Tools"
.SH NAME
xtfs_mrcdbtool \- dumps and restores MRC databases.
.SH SYNOPSIS
\fBxtfs_mrcdbtool [\fIoptions\fB] \fIdump|restore\fP <dump_file>
.br
.SH DESCRIPTION
.I xtfs_mrcdbtool
dumps an MRC database to a file, or restores an MRC database from a dump file. An XML dump of the MRC database is created if the \fIdump\fP option is chosen. When dumping an MRC database, the XML file containing the dump will be created on the server at the path \fIdump_file\fP. Dumps can be restored by using the \fIrestore\fP option. For safety reasons, this is only possible if the target MRC does not have a database yet.
.SH EXAMPLE USAGE
.TP
.B "xtfs_mrcdbtool -mrc pbrpc://localhost:32636 dump /tmp/dump.xml"
Dumps the database of the MRC running on \fIlocalhost:32636\fP to \fI/tmp/dump.xml\fP.
.TP
.B "xtfs_mrcdbtool -mrc pbrpc://localhost:32636 restore /tmp/dump.xml"
Restores the database of the MRC running on \fIlocalhost:32636\fP from the dump in \fI/tmp/dump.xml\fP.
.SH OPTIONS
.TP
.B \-c \fIcreds_file
Path to a PKCS#12 credentials file (private key + certificate) to use for SSL authentication. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
.B \-cpass \fIcreds_passphrase
An optional passphrase to access the credentials file.
.TP
.B \-h/--help
Shows usage info.
.TP
.B \-mrc \fImrc_url
The URL the MRC, e.g. pbrpc://localhost:32636.
.TP
.B \-t \fItrusted_CAs
Path to a PKCS#12 file containing a set of certificates from trusted certification authorities. These certificates will be used to authenticate the MRC. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
.B \-tpass \fItrusted_passphrase
An optional passphrase to access the truststore file.
.TP
.B \--admin_password \fI<passphrase>
The administrator password, if password protection is enabled.
.SH "SEE ALSO"
.BR xtfs_chstatus (1),
.BR xtfs_cleanup (1),
.BR xtfs_remove_osd (1),
.BR xtfs_scrub (1),
.BR
.SH AVAILABILITY
The xtfs_mrcdbtool command is part of the XtreemFS-tools package and is available from \fIhttp://www.xtreemfs.org\fP.

66
man/man1/xtfs_remove_osd.1 Normal file
View File

@@ -0,0 +1,66 @@
.TH xtfs_remove_osd 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS Admin Tools"
.SH NAME
xtfs_remove_osd \- removes an OSD by copying all objects on this OSD to other OSDs
.SH SYNOPSIS
\fBxtfs_remove_osd [ \fIoptions\fB ] \fIuuid:<osd_uuid>
.BR
.SH DESCRIPTION
.I xtfs_remove_osd
removes an OSD which is currently used. It copies all objectes on the OSD with the UUID
.I <osd_uuid>
to other OSDs and then shut down the OSD.
.SH EXAMPLE USAGE
.TP
.B "xtfs_remove_osd -dir localhost:32638 uuid:d1feb333-d986-4e91-b8e7-eb2a48485f8b"
Starts the removing process on the OSD identified by UUID 'd1feb333-d986-4e91-b8e7-eb2a48485f8b' and copies all files automatically to other OSDs (determinded by the OSD Selection Policy).
.SH OPTIONS
.TP
\fB-c \fI<creds_file>
Path to a PKCS#12 credentials file (private key + certificate) to use for SSL authentication. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
\fB-cpass \fI<creds_passphrase>
An optional passphrase to access the credentials file.
.TP
\fB-dir \fI<uri>
Specifies the directory service to use (e.g. 'pbrpc://localhost:32638'). If no URI is specified, URI and security settings are taken from '/etc/xos/xtreemfs/default_dir'. In case of a secured URI ('pbrpcs://...' or 'pbrpcg://...'), it is necessary to also specify SSL settings.
.TP
\fB-h/--help
Shows usage info.
.TP
\fB-t \fI<trusted_CAs>
Path to a PKCS#12 file containing a set of certificates from trusted certification authorities. These certificates will be used to authenticate the MRC. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
\fB-tpass \fI<trusted_passphrase>
An optional passphrase to access the truststore file.
.TP
\fB-d
Enables debugging output.
.TP
\fB-s
Shuts down the OSD per remote call after all object files are moved to other OSDs. Note that the shutdown process will be performed independently from your init system which can lead to errors if you try to start this OSD again with your init scripts. Therefore the default is not to shutdown the OSD. This step should be performed manually.
.TP
.B \--admin_password \fI<passphrase>
The administrator password, if password protection is enabled. Used only if you want to shutdown the OSD automatically per remote call.
.SH LIMITATIONS
.TP
While the draining is in progress, it is not possible to modify the to be moved files as they are temporarily set to read-only. Additionally, when the draining will be started, no files of the OSD should be hold open by any client.
.TP
Draining an OSD that holds striped and replicated files involves certain limitations. A striped file is currently moved to a new OSD in its entirety rather than partially. Regardless of the original number of OSDs it was striped across, it is relocated to a single target OSD, which implies that the target file is not striped anymore. As a consequence, data may be moved from OSDs that are not directly affected by the draining process.
.TP
Furthermore, at least one OSD has to exist for each file that does not hold any data of the file, i.e. is not included in any stripe or replica. If all OSDs that are eligible according to the OSD selection policy have already been assigned to a file, draining any of these OSDs will fail, as no additional replicas can be created.
.SH "SEE ALSO"
.BR xtfs_chstatus (1),
.BR xtfs_mrcdbtool (1),
.BR xtfs_remove_osd (1),
.BR xtfs_scrub (1),
.BR xtfs_cleanup (1)
.BR
.SH AVAILABILITY
The xtfs_remove_osd command is part of the XtreemFS-tools package and is available at \fIhttp://www.xtreemfs.org\fP.

62
man/man1/xtfs_scrub.1 Normal file
View File

@@ -0,0 +1,62 @@
.TH xtfs_scrub 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS Admin Tools"
.SH NAME
xtfs_scrub \- checks for each file in a volume if the MRC file size is outdated and if the checksum of all objects is correct. The scrubber can also replace defective replicas in repair mode.
.SH SYNOPSIS
\fBxtfs_scrub [ \fIoptions\fB ] \fI<volume_name>\fB
.br
.SH DESCRIPTION
.I xtfs_scrub
performs a consistency check of each file in a given volume. If run without \-repair or \-delete it will only perform checks and report problems. Th scrubber checks for file if the file size on the OSDs is stored on the MRC and fixes inconsistencies if run in the \-repair mode. In addition, the scrubber checks the checksum for each object of a file if the checksums are enabled on the OSD.
For replicated files the scrubber will check each replica for objects with inccorect checksum. In addition, it marks full replicas that successfully copied all objects as "complete" replicas. In the \-repair mode, the scrubber will also replace replicas that contain ramoved OSDs. An OSD must be marked as dead/removed with the xtfs_chstatus tool, otherwise the scrubber will consider the OSD as temporarily unavailable and won't replace the replica.
.SH EXAMPLE USAGE
.B "xtfs_scrub \-dir pbrpc://localhost:32638 myVolume
.PP
Scrubs all files in the volume named 'myVolume' registered at the Directory Service 'pbrpc://localhost:32638'.
.SH OPTIONS
.TP
.TP
\fB-c \fI<creds_file>
Path to a PKCS#12 credentials file (private key + certificate) to use for SSL authentication. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
\fB-cpass \fI<creds_passphrase>
An optional passphrase to access the credentials file.
.TP
\fB\-delete
Deletes files where the objects are lost because they were stored on a failed/removed OSD.
.TP
\fB-dirs \fI<uri(,uri...)>
Specifies the directory services to use (e.g. 'pbrpc://localhost:32638,pbrpc://myDir.com:32638') (comma-separated).
If no URI is specified, URIs and security settings are taken from '/etc/xos/xtreemfs/default_dir'.
In case of a secured URI ('pbrpcs://...' or 'pbrpcg://...'), it is necessary to also specify SSL settings.
.TP
\fB-h/--help
Shows usage info.
.TP
\fB\-repair
Repairs inconsistent file sizes and replace replicas on failed/removed OSD.
.TP
\fB\-silent
Hides detailed information about the scrubbed files.
.TP
\fB-t \fI<trusted_CAs>
Path to a PKCS#12 file containing a set of certificates from trusted certification authorities. These certificates will be used to authenticate the MRC. Must be present when MRC URL starts with pbrpcs:// or pbrpcg://.
.TP
\fB\-thrs \fI<#threads>
Sets the number of threads to use for scrubbing (default=10).
.TP
\fB-tpass \fI<trusted_passphrase>
An optional passphrase to access the truststore file.
.SH "SEE ALSO"
.BR xtfs_chstatus (1),
.BR xtfs_cleanup (1),
.BR xtfs_mrcdbtool (1),
.BR xtfs_remove_osd (1),
.BR
.SH AVAILABILITY
The xtfs_scrub command is part of the XtreemFS-tools package and is available from \fIhttp://www.xtreemfs.org\fP.

199
man/man1/xtfsutil.1 Normal file
View File

@@ -0,0 +1,199 @@
.TH xtfsutil 1 "July 2011" "The XtreemFS Distributed File System" "XtreemFS utility"
.SH NAME
xtfsutil \- shows and modifies XtreemFS specific file, directory and volume attributes
.SH SYNOPSIS
\fBxtfsutil \fP[\fIpath\fP]\fR \- shows the XtreemFS attributes such as URL, locations etc.
.br
\fBxtfsutil \fP[OPTIONS] [\fIpath\fP]\fR \- modifies XtreemFS attributes, adds/removes replicas, snapshots, etc.
.br
.SH DESCRIPTION
.I xtfsutil
when no options are provided, xtfsutl shows information about a file or directory \fIpath\fP.
.SH EXAMPLE USAGE
.TP
.TP
Display information about the file "/somedir/myfile":
.TP
.B "xtfsutil xtfs-mount/somedir/myfile"
.br
.TP
Add another replica to the replicated file "/somedir/myfile" which will be created on an automatically chosen OSD. If the file is not replicated yet, set a replication policy for the file first (see option \-r / \-\-set-replication-policy). Or set a default replication policy for future files.
.TP
.B "xtfsutil \--add-replica AUTO xtfs-mount/somedir/myfile"
.br
.TP
Set the default replication policy to "WqRq" and a default replication factor of 3 for the mounted volume:
.TP
.B "xtfsutil \--set-drp \--replication-policy WqRq \--replication-factor 3 xtfs-mount/"
.SH OPTIONS
.TP
\fB\-\-errors
Shows a list of recent error messages the client has reveived,
e.g. more detailed XtreemFS error messages.
.TP
\fB\-\-set-acl [acl]
Sets or updates a POSIX ACL entry for a file, directory or volume.
The acl entry must have the following format: u|g|m|o:[<name>]:[<rwx>|<octal>]
.TP
\fB\-\-del-acl [acl]
Removes a POSIX ACL entry for a file, directory or volume.
The acl entry must have the following format: u|g|m|o:[<name>]
.TP
VOLUME OPTIONS:
.TP
\fB\-\-set-dsp
Changes the default striping policy for a volume.
This policy defines, how new files are striped but does not affect
files that already exist on the volume.
.br
Requires the following options: \-\-striping-policy-width, \-\-striping-policy-stripe-size
.br
Additional options: \-\-striping-policy
.TP
\fB\-\-set-drp
Changes the default replication policy for a volume.
If a replication policy is defined, all new files will be replicated.
.br
Requires the following options: \-\-replication-policy, \-\-replication-factor
.br
Additional options: \-\-full
.TP
\fB\-\-replication-policy ronly|WqRq|WaR1|none (the aliases readonly|quorum|all are also allowed)
Sets the replication policy.
.br
.B ronly
Read-only replication, files are immutable. Files will be replicated after closing them.
.br
.B WqRq
Quorum-based replication. Files are mutable and provide regular POSIX semantics. A WqRq-replicated file is available for reading and writing as long as the majority of its replicas are available. Please read more about the technical details of the WqRq replication policy in the XtreemFS user guide (Section "Read/Write File Replication").
.br
.B WaR1
Files are mutable and provide regular POSIX semantics. Writes have to be acknowledged by all replicas. Data can be read from any replica.
.br
.B none
Disables replication.
.TP
\fB\-\-replication-factor num
Sets the replication factor to num.
.TP
\fB\-\-full
If replication policy is ronly (read-only replication), this flag will create full replicas.
By default, read-only replicas are partial.
.TP
\fB\-\-set-osp [comma separated list of policy IDs] or \fIDEFAULT,FQDN,UUID,DCMAP,VIVALDI
Changes the OSD selection policy for a volume. The OSD selection policy defines which OSDs are used
for new files and replicas. In general, this command accepts a comma separated list of
policy IDs without spaces. The command also accepts one of the following predefined policies:
.br
\fBDEFAULT OSDs are selected randomly.
.br
\fBFQDN OSDs are sorted by the number of characters matching the client's FQDN.
.br
\fBUUID OSDs are selected based on their UUID.
.br
\fBDCMAP OSDs are sorted by the distance to the client according to the datacenter map.
.br
\fBVIVALDI OSDs are sorted by the distance to the client based on dynamic network coordinates (VIVALDI).
.TP
\fB\-\-set-rsp [comma separated list of policy IDs] or \fIDEFAULT,FQDN,DCMAP,VIVALDI
Changes the Replica selection policy for a volume. The Replica selection policy defines how the list of
replicas for a file is sorted for a client when it accesses a file. Clients iterate over the list of
replicas from the first to the last. In general, this command accepts a comma separated list of
policy IDs without spaces. The command also accepts one of the following predefined policies:
.br
\fBDEFAULT The list of replicas is not modified.
.br
\fBFQDN Replicas are sorted by the number of characters matching the client's FQDN.
.br
\fBDCMAP Replicas are sorted by the distance to the client according to the datacenter map.
.br
\fBVIVALDI Replicas are sorted by the distance to the client based on dynamic network coordinates (VIVALDI).
.TP
\fB\-\-set-pattr [value name] \-\-value [attribute value]
Changes the value of a policy attribute for a volume. See the XtreemFS user guide for attribute names.
Policy attributes can be removed by setting an empty value, e.g.:
$> xtfsutil \--set-pattr 1001.domains \--value "" /xtreemfs
.TP
\fB\-\-list-pattrs
Lists all policy attributes that are set on a volume.
.TP
\fB\-\-enable-snapshots
Enables snapshots on the volume.
.TP
\fB\-\-disable-snapshots
Disables snapshots on the volume.
.TP
\fB\-\-list-snapshots
Lists all available snapshots.
.TP
\fB\-\-create-snapshot \fP[\fIname\fP]
Creates a snapshot of the volume/directory with the name \fIname\fP. If \fIname\fP is empty, the current server time will be used as snapshot name.
.TP
\fB\-\-create-snapshot-non-recursive \fP[\fIname\fP]
Same as \--create-snapshot but excludes any subdirectories.
.TP
\fB\-\-delete-snapshot \fP[\fIname\fP]
Deletes the snapshot with the name \fIname\fP.
.TP
\fB\-\-set-quota [quota size]MB|GB|TB
Sets the volume quota (set quota to 0 to disable the quota)
.TP
FILE OPTIONS:
.TP
\fB\-a, \-\-add-replica [OSD UUID] or AUTO
Adds a new replica on the specified OSD or on an automatically selected OSD (if AUTO is set).
.br
Additional options: \-\-full (creates a full read-only replica)
.TP
\fB\-d, \-\-delete-replica [OSD UUID]
Removes the replica on the OSD with the specified UUID.
.TP
\fB\-l, \-\-list-osds
Prints a list of up to ten OSDs that can be used for new replicas for the specified file.
.TP
\fB\-r, \-\-set-replication-policy ronly|WqRq|WaR1|none (the aliases readonly|quorum|all are also allowed)
Sets the replication policy for a file. Mode cane only be changed when a file has no replicas. See \--replication-policy for values.
.SH "SEE ALSO"
.BR lsfs.xtreemfs (1),
.BR mkfs.xtreemfs (1),
.BR mount.xtreemfs (1),
.BR rmfs.xtreemfs (1),
.BR umount.xtreemfs (1),
.BR
.SH AVAILABILITY
The xtfsutil command is part of the XtreemFS-client package and is available from http://www.xtreemfs.org.