From 2eee2dddb3ee0b1649caa26e5afc75f7d537abd2 Mon Sep 17 00:00:00 2001 From: N Balachandran Date: Tue, 20 Feb 2018 10:34:00 +0530 Subject: [PATCH] Admin guide: refactoring Signed-off-by: N Balachandran --- Administrator Guide/Did You Know.md | 36 ---------------- Administrator Guide/index.md | 67 +++++++++++++---------------- Administrator Guide/overview.md | 8 ++++ mkdocs.yml | 18 ++++---- 4 files changed, 47 insertions(+), 82 deletions(-) delete mode 100644 Administrator Guide/Did You Know.md create mode 100644 Administrator Guide/overview.md diff --git a/Administrator Guide/Did You Know.md b/Administrator Guide/Did You Know.md deleted file mode 100644 index 085b4a8..0000000 --- a/Administrator Guide/Did You Know.md +++ /dev/null @@ -1,36 +0,0 @@ -#Did you know? - -This document is an attempt to describe less-documented behaviours and features -of GlusterFS that an admin always wanted to know but was too shy or busy to -ask. - -## Trusted Volfiles - -Observant admins would have wondered why there are two similar volume files for -every volume, namely trusted--fuse.vol and -fuse.vol. To -appreciate this one needs to know about the IP address/hostname based access -restriction schemes available in GlusterFS. They are "auth-allow" and -"auth-reject". The "auth-allow" and "auth-reject" options take a comma -separated list of IP addresses/hostnames as value. "auth-allow" allows access -_only_ to clients running on machines whose IP address/hostname are on this -list. It is highly likely for an admin to configure the "auth-allow" option -without including the list of nodes in the cluster. One would expect this to -work. Previously, in this configuration (internal) clients such as -gluster-nfs, glustershd etc., running in the trusted storage pool, would be -denied access to the volume. This is undesirable and counter-intuitive. The -work around was to add the IP address/hostnames of all the nodes in the trusted -storage pool to the "auth-allow" list. This is bad for a reasonably large -number of nodes. To fix this, an alternate authentication mechanism for nodes -in the storage pool was introduced. Following is a brief explanation of how -this works. - -The volume file with trusted prefix in its name (i.e trusted-volfile) has a -username and password option in the client xlator. The trusted-volfile is used -_only_ by mount processes running in the trusted storage pool (hence the name). -The username and password, when present, allow "mount" (and other glusterfs) -processes to access the brick processes even if the node they are running on is -not explicitly added in "auth-allow" addresses. 'Regular' mount processes, -running on nodes outside the trusted storage pool, use the non-trusted-volfile. -The important thing to note is that "trusted" in this context only implied -belonging to the trusted storage pool. - diff --git a/Administrator Guide/index.md b/Administrator Guide/index.md index 8970d7e..8204a3e 100644 --- a/Administrator Guide/index.md +++ b/Administrator Guide/index.md @@ -1,46 +1,36 @@ # Administration Guide -1. Platform introduction - - * [About GlusterFS](./GlusterFS Introduction.md) - -2. GlusterFS Architecture and Concepts - - * [Architecture](../Quick-Start-Guide/Architecture.md) - * [Glossary](../glossary.md) - * [Other Features of GlusterFS](./Did You Know.md) - -3. Getting Started +1. Managing a Cluster * [Managing the Gluster Service](./Start Stop Daemon.md) - * [Setting Up Trusted Storage Pools](./Storage Pools.md) + * [Managing Trusted Storage Pools](./Storage Pools.md) -4. Setting Up Storage +2. Setting Up Storage * [Brick Naming Conventions](./Brick Naming Conventions.md) * [Formatting and Mounting Bricks](./formatting-and-mounting-bricks.md) * [POSIX Access Control Lists](./Access Control Lists.md) -5. [Accessing Data - Setting Up Clients](./Setting Up Clients.md) +3. [Setting Up Clients](./Setting Up Clients.md) * [Handling of users that belong to many groups](./Handling-of-users-with-many-groups.md) -6. Volumes +4. Volumes * [Setting Up Volumes](./Setting Up Volumes.md) * [Managing Volumes](./Managing Volumes.md) * [Modifying .vol files with a filter](./GlusterFS Filter.md) -7. [GlusterFS Service Logs and Locations](./Logging.md) +5. [Configuring NFS-Ganesha](./NFS-Ganesha GlusterFS Integration.md) -8. [Geo Replication](./Geo Replication.md) - -9. [Managing Directory Quotas](./Directory Quota.md) +6. Features -10. [Managing Snapshots](./Managing Snapshots.md) + * [Geo Replication](./Geo Replication.md) + * [Quotas](./Directory Quota.md) + * [Snapshots](./Managing Snapshots.md) + * [Trash](./Trash.md) -11. [Monitoring Workload](./Monitoring Workload.md) -12. Data Access With Other Interfaces +7. Data Access With Other Interfaces * [Managing Object Store](./Object Storage.md) * [Accessing GlusterFS using Cinder Hosts](./GlusterFS Cinder.md) @@ -48,34 +38,35 @@ * [Install Gluster on Top of ZFS](./Gluster On ZFS.md) * [Configuring Bareos to store backups on Gluster](./Bareos.md) -13. [Securing GlusterFS Communication using SSL](./SSL.md) +8. [GlusterFS Service Logs and Locations](./Logging.md) + +9. [Monitoring Workload](./Monitoring Workload.md) + +10. [Securing GlusterFS Communication using SSL](./SSL.md) -14. [Puppet Gluster](./Puppet.md) +11. [Puppet Gluster](./Puppet.md) -15. [RDMA Transport](./RDMA Transport.md) +12. [RDMA Transport](./RDMA Transport.md) -16. [GlusterFS iSCSI](./GlusterFS iSCSI.md) +13. [GlusterFS iSCSI](./GlusterFS iSCSI.md) -17. [Linux Kernel Tuning](./Linux Kernel Tuning.md) +14. [Linux Kernel Tuning](./Linux Kernel Tuning.md) -18. [Export and Netgroup Authentication](./Export And Netgroup Authentication.md) +15. [Export and Netgroup Authentication](./Export And Netgroup Authentication.md) -19. [Configuring NFS-Ganesha server](./NFS-Ganesha GlusterFS Integration.md) -20. [Split brain and ways to deal with it](Split brain and ways to deal with it.md) +16. [Split brain and ways to deal with it](Split brain and ways to deal with it.md) -21. [Arbiter volumes and quorum options](./arbiter-volumes-and-quorum.md) +17. [Arbiter volumes and quorum options](./arbiter-volumes-and-quorum.md) -22. [Trash for GlusterFS](./Trash.md) +18. [Mandatory Locks](./Mandatory Locks.md) -23. [Mandatory Locks](./Mandatory Locks.md) +19. [GlusterFS coreutilities](./GlusterFS Coreutils.md) -24. [GlusterFS coreutilities](./GlusterFS Coreutils.md) +20. [Events APIs](./Events APIs.md) -25. [Events APIs](./Events APIs.md) +21. [Building QEMU With gfapi For Debian Based Systems](./Building QEMU With gfapi For Debian Based Systems.md) -26. [Building QEMU With gfapi For Debian Based Systems](./Building QEMU With gfapi For Debian Based Systems.md) - -27. Appendices +22. Appendices * [Network Configuration Techniques](./Network Configurations Techniques.md) * [Performance Testing](./Performance Testing.md) diff --git a/Administrator Guide/overview.md b/Administrator Guide/overview.md new file mode 100644 index 0000000..8da93cd --- /dev/null +++ b/Administrator Guide/overview.md @@ -0,0 +1,8 @@ +### Overview + + +The Administration guide covers day to day management tasks as well as advanced configuration methods for your Gluster setup. + +You can manage your Gluster cluster using the [Gluster CLI](../CLI-Reference/cli-main.md) + +See the [glossary](../glossary.md) for an explanation of the various terms used in this document. diff --git a/mkdocs.yml b/mkdocs.yml index ad8e5cc..8071c55 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,6 +8,7 @@ docs_dir: . pages: - Home: index.md - Getting started with GlusterFS: + - Introduction: Administrator Guide/GlusterFS Introduction.md - Quick Start Guide: Quick-Start-Guide/Quickstart.md - Architecture: Quick-Start-Guide/Architecture.md - Install Guide: @@ -20,11 +21,9 @@ pages: - Compiling RPMS: Install-Guide/compiling-rpms.md - Community Packages: Install-Guide/Community_Packages.md - Configure: Install-Guide/Configure.md -- Presentations: presentations/index.md -- Administrator Guide: +- Administration Guide: + - Overview: Administrator Guide/overview.md - Index: Administrator Guide/index.md - - GlusterFS Introduction: Administrator Guide/GlusterFS Introduction.md - - Did You Know: Administrator Guide/Did You Know.md - Managing the Gluster Service: Administrator Guide/Start Stop Daemon.md - Managing Trusted Storage Pools: Administrator Guide/Storage Pools.md - Setting Up Storage: @@ -39,9 +38,12 @@ pages: - Building QEMU with gfapi For Debian Based Systems: Administrator Guide/Building QEMU With gfapi For Debian Based Systems.md - GlusterFS Filter: Administrator Guide/GlusterFS Filter.md - Logging: Administrator Guide/Logging.md - - Geo Replication: Administrator Guide/Geo Replication.md - - Directory Quota: Administrator Guide/Directory Quota.md - - Managing Snapshots: Administrator Guide/Managing Snapshots.md + - Features: + - Setting Up Storage : Administrator Guide/setting-up-storage.md + - Geo Replication: Administrator Guide/Geo Replication.md + - Quotas: Administrator Guide/Directory Quota.md + - Snapshots: Administrator Guide/Managing Snapshots.md + - Trash: Administrator Guide/Trash.md - Monitoring Workload: Administrator Guide/Monitoring Workload.md - Object Storage: Administrator Guide/Object Storage.md - GlusterFS Cinder: Administrator Guide/GlusterFS Cinder.md @@ -60,12 +62,12 @@ pages: - Consul integration: Administrator Guide/Consul.md - Split brain and ways to deal with it: Administrator Guide/Split brain and ways to deal with it.md - Arbiter volumes and quorum options: Administrator Guide/arbiter-volumes-and-quorum.md - - Trash for GlusterFS: Administrator Guide/Trash.md - Mandatory Locks: Administrator Guide/Mandatory Locks.md - GlusterFS coreutilities: Administrator Guide/GlusterFS Coreutils.md - Events APIs: Administrator Guide/Events APIs.md - CLI Reference: - Overview: CLI-Reference/cli-main.md +- Presentations: presentations/index.md - Developers Guide: - Developers Home: Developer-guide/Developers-Index.md - Simplified Development Workflow : Developer-guide/Simplified-Development-Workflow.md