Skip to content

Commit 4c9e8fa

Browse files
vbelluravati
authored andcommitted
doc: Added admin guide
Change-Id: Ic60558dee0d20df0c2a1bf41e4bd072ae4774912 BUG: 811311 Signed-off-by: Vijay Bellur <[email protected]> Reviewed-on: http://review.gluster.com/3209 Tested-by: Gluster Build System <[email protected]> Reviewed-by: Amar Tumballi <[email protected]> Tested-by: divya M N <[email protected]> Reviewed-by: divya M N <[email protected]> Reviewed-by: Anand Avati <[email protected]>
1 parent 664daec commit 4c9e8fa

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+6766
-0
lines changed

Diff for: doc/admin-guide/en-US/Administration_Guide.ent

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!ENTITY PRODUCT "Documentation">
2+
<!ENTITY BOOKID "Administration_Guide">
3+
<!ENTITY YEAR "2012">
4+
<!ENTITY HOLDER "Red Hat Inc">

Diff for: doc/admin-guide/en-US/Administration_Guide.xml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<book>
7+
<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
8+
<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
9+
<xi:include href="gfs_introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
10+
<xi:include href="admin_start_stop_daemon.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
11+
<xi:include href="admin_console.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
12+
<xi:include href="admin_storage_pools.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
13+
<xi:include href="admin_setting_volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
14+
<xi:include href="admin_settingup_clients.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
15+
<xi:include href="admin_managing_volumes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
16+
<xi:include href="admin_geo-replication.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
17+
<xi:include href="admin_directory_Quota.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
18+
<xi:include href="admin_monitoring_workload.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
19+
<xi:include href="admin_ACLs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
20+
<xi:include href="admin_UFO.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
21+
<xi:include href="admin_Hadoop.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
22+
<xi:include href="admin_troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
23+
<xi:include href="admin_commandref.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
24+
<xi:include href="glossary.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
25+
<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
26+
</book>
27+

Diff for: doc/admin-guide/en-US/Author_Group.xml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<authorgroup>
7+
<author>
8+
<firstname>Divya</firstname>
9+
<surname>Muntimadugu</surname>
10+
<affiliation>
11+
<orgname>Red Hat</orgname>
12+
<orgdiv>Engineering Content Services</orgdiv>
13+
</affiliation>
14+
<email>[email protected]</email>
15+
</author>
16+
</authorgroup>
17+

Diff for: doc/admin-guide/en-US/Book_Info.xml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE bookinfo PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<bookinfo id="book-Administration_Guide-Administration_Guide">
7+
<title>Administration Guide</title>
8+
<subtitle>Using Gluster File System <remark> Beta 3</remark> </subtitle>
9+
<productname>Gluster File System</productname>
10+
<productnumber>3.3</productnumber>
11+
<edition>1</edition>
12+
<pubsnumber>1</pubsnumber>
13+
<abstract>
14+
<para>
15+
This guide describes Gluster File System (GlusterFS) and provides information on how to configure, operate, and manage GlusterFS.
16+
</para>
17+
</abstract>
18+
<corpauthor>
19+
<inlinemediaobject>
20+
<imageobject>
21+
<imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
22+
</imageobject>
23+
</inlinemediaobject>
24+
</corpauthor>
25+
<xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
26+
<xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
27+
</bookinfo>
28+

Diff for: doc/admin-guide/en-US/Chapter.xml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<chapter id="chap-Administration_Guide-Test_Chapter">
7+
<title>Test Chapter</title>
8+
<para>
9+
This is a test paragraph
10+
</para>
11+
<section id="sect-Administration_Guide-Test_Chapter-Test_Section_1">
12+
<title>Test Section 1</title>
13+
<para>
14+
This is a test paragraph in a section
15+
</para>
16+
</section>
17+
18+
<section id="sect-Administration_Guide-Test_Chapter-Test_Section_2">
19+
<title>Test Section 2</title>
20+
<para>
21+
This is a test paragraph in Section 2
22+
<orderedlist>
23+
<listitem>
24+
<para>
25+
listitem text
26+
</para>
27+
</listitem>
28+
</orderedlist>
29+
</para>
30+
</section>
31+
32+
</chapter>
33+

Diff for: doc/admin-guide/en-US/Preface.xml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!-- This document was created with Syntext Serna Free. -->
3+
<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4+
<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent">
5+
%BOOK_ENTITIES;
6+
]>
7+
<preface id="pref-Administration_Guide-Preface">
8+
<title>Preface</title>
9+
<para>This guide describes how to configure, operate, and manage Gluster File System (GlusterFS).</para>
10+
<section>
11+
<title>Audience</title>
12+
<para>This guide is intended for Systems Administrators interested in configuring and managing GlusterFS.</para>
13+
<para>This guide assumes that you are familiar with the Linux operating system, concepts of File System, GlusterFS concepts, and GlusterFS Installation</para>
14+
</section>
15+
<section>
16+
<title>License</title>
17+
<para>The License information is available at <ulink url="http://www.redhat.com/licenses/rhel_rha_eula.html"/>.</para>
18+
</section>
19+
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Conventions.xml"/>
20+
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Feedback.xml">
21+
<xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="Common_Content/Feedback.xml"/>
22+
</xi:fallback>
23+
</xi:include>
24+
</preface>

Diff for: doc/admin-guide/en-US/Revision_History.xml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?xml version='1.0' encoding='utf-8' ?>
2+
<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3+
<!ENTITY % BOOK_ENTITIES SYSTEM "Administration_Guide.ent">
4+
%BOOK_ENTITIES;
5+
]>
6+
<appendix id="appe-Administration_Guide-Revision_History">
7+
<title>Revision History</title>
8+
<simpara>
9+
<revhistory>
10+
<revision>
11+
<revnumber>1-0</revnumber>
12+
<date>Thu Apr 5 2012</date>
13+
<author>
14+
<firstname>Divya</firstname>
15+
<surname>Muntimadugu</surname>
16+
<email>[email protected]</email>
17+
</author>
18+
<revdescription>
19+
<simplelist>
20+
<member>Draft </member>
21+
</simplelist>
22+
</revdescription>
23+
</revision>
24+
</revhistory>
25+
</simpara>
26+
</appendix>
27+

Diff for: doc/admin-guide/en-US/admin_ACLs.xml

+206
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,206 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "docbookV4.5/docbookx.dtd" []>
3+
<chapter id="chap-Administration_Guide-ACLs">
4+
<title>POSIX Access Control Lists </title>
5+
<para>POSIX Access Control Lists (ACLs) allows you to assign different permissions for different users or
6+
groups even though they do not correspond to the original owner or the owning group.
7+
</para>
8+
<para>For example: User john creates a file but does not want to allow anyone to do anything with this
9+
file, except another user, antony (even though there are other users that belong to the group john).
10+
</para>
11+
<para>This means, in addition to the file owner, the file group, and others, additional users and groups can
12+
be granted or denied access by using POSIX ACLs.
13+
</para>
14+
<section id="sect-Administration_Guide-ACLs-Activating_ACLs">
15+
<title>Activating POSIX ACLs Support </title>
16+
<para>To use POSIX ACLs for a file or directory, the partition of the file or directory must be mounted with
17+
POSIX ACLs support.
18+
</para>
19+
<section id="sect-Administration_Guide-ACLs-Activating_ACLs-Server">
20+
<title>Activating POSIX ACLs Support on Sever </title>
21+
<para>To mount the backend export directories for POSIX ACLs support, use the following command:
22+
</para>
23+
<para><command># mount -o acl <replaceable>device-name</replaceable><replaceable>partition</replaceable></command>
24+
</para>
25+
<para>For example:
26+
</para>
27+
<para><command># mount -o acl /dev/sda1 /export1 </command></para>
28+
<para>Alternatively, if the partition is listed in the /etc/fstab file, add the following entry for the partition
29+
to include the POSIX ACLs option:
30+
</para>
31+
<para><command>LABEL=/work /export1 ext3 rw, acl 14 </command></para>
32+
</section>
33+
<section>
34+
<title>Activating POSIX ACLs Support on Client </title>
35+
<para>To mount the glusterfs volumes for POSIX ACLs support, use the following command:
36+
</para>
37+
<para><command># mount –t glusterfs -o acl <replaceable>severname:volume-id</replaceable><replaceable>mount point</replaceable></command>
38+
</para>
39+
<para>For example:
40+
</para>
41+
<para><command># mount -t glusterfs -o acl 198.192.198.234:glustervolume /mnt/gluster</command>
42+
</para>
43+
</section>
44+
</section>
45+
<section>
46+
<title>Setting POSIX ACLs </title>
47+
<para>You can set two types of POSIX ACLs, that is, access ACLs and default ACLs. You can use
48+
access ACLs to grant permission for a specific file or directory. You can use default ACLs only
49+
on a directory but if a file inside that directory does not have an ACLs, it inherits the permissions of
50+
the default ACLs of the directory.
51+
</para>
52+
<para>You can set ACLs for per user, per group, for users not in the user group for the file, and via the
53+
effective right mask.
54+
</para>
55+
<section>
56+
<title>Setting Access ACLs </title>
57+
<para>You can apply access ACLs to grant permission for both files and directories.
58+
</para>
59+
<para><emphasis role="bold">To set or modify Access ACLs</emphasis>
60+
</para>
61+
<para>You can set or modify access ACLs use the following command:
62+
</para>
63+
<para><command># setfacl –m <replaceable>entry type</replaceable> file </command></para>
64+
<para>The ACL entry types are the POSIX ACLs representations of owner, group, and other.
65+
</para>
66+
<para>Permissions must be a combination of the characters <command>r</command> (read), <command>w</command> (write), and <command>x</command> (execute). You must
67+
specify the ACL entry in the following format and can specify multiple entry types separated by
68+
commas.
69+
</para>
70+
<informaltable frame="all">
71+
<tgroup cols="2">
72+
<colspec colname="c1"/>
73+
<colspec colname="c2"/>
74+
<thead>
75+
<row>
76+
<entry>ACL Entry</entry>
77+
<entry>Description</entry>
78+
</row>
79+
</thead>
80+
<tbody>
81+
<row>
82+
<entry>u:uid:&lt;permission&gt; </entry>
83+
<entry>Sets the access ACLs for a user. You can specify user name or UID </entry>
84+
</row>
85+
<row>
86+
<entry>g:gid:&lt;permission&gt; </entry>
87+
<entry>Sets the access ACLs for a group. You can specify group name or GID. </entry>
88+
</row>
89+
<row>
90+
<entry>m:&lt;permission&gt; </entry>
91+
<entry>Sets the effective rights mask. The mask is the combination of all access permissions of the owning group and all of the user and group entries. </entry>
92+
</row>
93+
<row>
94+
<entry>o:&lt;permission&gt; </entry>
95+
<entry>Sets the access ACLs for users other than the ones in the group for the file. </entry>
96+
</row>
97+
</tbody>
98+
</tgroup>
99+
</informaltable>
100+
<para>If a file or directory already has an POSIX ACLs, and the setfacl command is used, the additional
101+
permissions are added to the existing POSIX ACLs or the existing rule is modified.
102+
</para>
103+
<para>For example, to give read and write permissions to user antony:
104+
</para>
105+
<para><command># setfacl -m u:antony:rw /mnt/gluster/data/testfile </command></para>
106+
</section>
107+
<section>
108+
<title>Setting Default ACLs </title>
109+
<para>You can apply default ACLs only to directories. They determine the permissions of a file system
110+
objects that inherits from its parent directory when it is created.
111+
</para>
112+
<para>To set default ACLs
113+
</para>
114+
<para>You can set default ACLs for files and directories using the following command:
115+
</para>
116+
<para><command># setfacl –m –-set <replaceable>entry type directory</replaceable></command>
117+
</para>
118+
<para>For example, to set the default ACLs for the /data directory to read for users not in the user group:
119+
</para>
120+
<para><command># setfacl –m --set o::r /mnt/gluster/data </command></para>
121+
<para><note>
122+
<para>An access ACLs set for an individual file can override the default ACLs permissions.
123+
</para>
124+
</note></para>
125+
<para><emphasis role="bold">Effects of a Default ACLs </emphasis></para>
126+
<para>The following are the ways in which the permissions of a directory&apos;s default ACLs are passed to the
127+
files and subdirectories in it:
128+
</para>
129+
<itemizedlist>
130+
<listitem>
131+
<para>A subdirectory inherits the default ACLs of the parent directory both as its default ACLs and as an
132+
access ACLs.
133+
</para>
134+
</listitem>
135+
<listitem>
136+
<para>A file inherits the default ACLs as its access ACLs.
137+
</para>
138+
</listitem>
139+
</itemizedlist>
140+
</section>
141+
</section>
142+
<section>
143+
<title>Retrieving POSIX ACLs </title>
144+
<para>You can view the existing POSIX ACLs for a file or directory.
145+
</para>
146+
<para><emphasis role="bold">To view existing POSIX ACLs </emphasis></para>
147+
<itemizedlist>
148+
<listitem>
149+
<para>View the existing access ACLs of a file using the following command:
150+
</para>
151+
<para><command># getfacl <replaceable>path/filename</replaceable></command>
152+
</para>
153+
<para>For example, to view the existing POSIX ACLs for sample.jpg
154+
</para>
155+
<programlisting># getfacl /mnt/gluster/data/test/sample.jpg
156+
# owner: antony
157+
# group: antony
158+
user::rw-
159+
group::rw-
160+
other::r--</programlisting>
161+
</listitem>
162+
<listitem>
163+
<para>View the default ACLs of a directory using the following command:
164+
</para>
165+
<para><command># getfacl <replaceable>directory name</replaceable></command></para>
166+
<para>For example, to view the existing ACLs for /data/doc
167+
</para>
168+
<programlisting># getfacl /mnt/gluster/data/doc
169+
# owner: antony
170+
# group: antony
171+
user::rw-
172+
user:john:r--
173+
group::r--
174+
mask::r--
175+
other::r--
176+
default:user::rwx
177+
default:user:antony:rwx
178+
default:group::r-x
179+
default:mask::rwx
180+
default:other::r-x</programlisting>
181+
</listitem>
182+
</itemizedlist>
183+
</section>
184+
<section>
185+
<title>Removing POSIX ACLs </title>
186+
<para>To remove all the permissions for a user, groups, or others, use the following command:
187+
</para>
188+
<para><command># setfacl -x <replaceable>ACL entry type file</replaceable></command></para>
189+
<para>For example, to remove all permissions from the user antony:
190+
</para>
191+
<para><command># setfacl -x u:antony /mnt/gluster/data/test-file</command></para>
192+
</section>
193+
<section>
194+
<title>Samba and ACLs </title>
195+
<para>If you are using Samba to access GlusterFS FUSE mount, then POSIX ACLs are enabled by default.
196+
Samba has been compiled with the <command>--with-acl-support</command> option, so no special flags are required
197+
when accessing or mounting a Samba share.
198+
</para>
199+
</section>
200+
<section>
201+
<title>NFS and ACLs </title>
202+
<para>Currently we do not support ACLs configuration through NFS, i.e. setfacl and getfacl commands do
203+
not work. However, ACLs permissions set using Gluster Native Client applies on NFS mounts.
204+
</para>
205+
</section>
206+
</chapter>

0 commit comments

Comments
 (0)