]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: minor changes in fuse client config reference
authorBarbora Ančincová <bancinco@redhat.com>
Mon, 23 Jan 2017 15:34:55 +0000 (16:34 +0100)
committerBarbora Ančincová <bancinco@redhat.com>
Mon, 23 Jan 2017 15:34:55 +0000 (16:34 +0100)
Signed-off-by: Bara Ancincova (bara@redhat.com)
doc/cephfs/client-config-ref.rst

index 7e2106a8875016635f00ab1abcda834ebfda4b89..b111dca40db734599051f69886de8c97c95170d1 100644 (file)
@@ -4,49 +4,49 @@
 
 ``client acl type``
 
-:Description: Set to ``"posix_acl"`` to enable POSIX ACLs.
+:Description: Set the ACL type. Currently, only possible value is ``"posix_acl"`` to enable POSIX ACL, or an empty string.
 :Type: String
-:Default: ``""`` (N/A)
+:Default: ``""`` (empty string)
 
 ``client cache mid``
 
-:Description: Set client cache mid-point.
+:Description: Set client cache midpoint. The midpoint splits the least recently used lists into a hot and warm list.
 :Type: Float
 :Default: ``0.75``
 
 ``client_cache_size``
 
-:Description: Set client cache object count maximum.
+:Description: Set the number of inodes that the client keeps in the metadata cache.
 :Type: Integer
 :Default: ``16384``
 
 ``client_caps_release_delay``
 
-:Description: Delay between capability releases.
+:Description: Set the delay between capability releases in seconds. The delay sets how many seconds a client waits to release capabilities that it no longer needs in case the capabilities are needed for another user space operation.
 :Type: Integer
 :Default: ``5`` (seconds)
 
 ``client_debug_force_sync_read``
 
-:Description: Always read synchronously (go to osds).
+:Description: If set to ``true``, clients read data directly from OSDs instead of using a local page cache.
 :Type: Boolean
 :Default: ``false``
 
 ``client_debug_getattr_caps``
 
-:Description: Check if MDS reply contains wanted caps.
+:Description: Check if the reply from the MDS contains required capabilities.
 :Type: Boolean
 :Default: ``false``
 
 ``client_dirsize_rbytes``
 
-:Description: Use recursive size of directory for directory ``st_size`` stat member.
+:Description: If set to `true`, use the recursive size of a directory (that is, total of all descendants).
 :Type: Boolean
 :Default: ``true``
 
 ``client_max_inline_size``
 
-:Description: Maximum size of inlined data stored in a file inode (rather than in a separate data object in RADOS). This setting only applies if the ``inline_data`` flag is set on the MDSMap.
+:Description: Set the maximum size of inlined data stored in a file inode rather than in a separate data object in RADOS. This setting only applies if the ``inline_data`` flag is set on the MDS map.
 :Type: Integer
 :Default: ``4096``
 
 
 :Description: Comma-delimited strings for client metadata sent to each MDS.
 :Type: String
-:Default: ``""`` (N/A)
+:Default: ``""`` (empty string)
 
 ``client_mount_gid``
 
-:Description: Group-id of CephFS mount.
+:Description: Set the group ID of CephFS mount.
 :Type: Integer
 :Default: ``-1``
 
 ``client_mount_timeout``
 
-:Description: Timeout for CephFS mount.
+:Description: Set the timeout for CephFS mount in seconds.
 :Type: Float
-:Default: ``300.0`` (seconds)
+:Default: ``300.0``
 
 ``client_mount_uid``
 
-:Description: User-id of CephFS mount.
+:Description: Set the user ID of CephFS mount.
 :Type: Integer
 :Default: ``-1``
 
 ``client_mountpoint``
 
-:Description: Directory to mount on the CephFS file system.
+:Description: Directory to mount on the CephFS file system. An alternative to the `-r` option of the `ceph-fuse` command.
 :Type: String
 :Default: ``"/"``
 
 ``client_oc``
 
-:Description: Enable object caching. **Setting currently ignored.**
+:Description: Enable object caching.
 :Type: Boolean
 :Default: ``true``
 
 ``client_oc_max_dirty``
 
-:Description: Maximum number of dirty bytes in object cache.
+:Description: Set the maximum number of dirty bytes in the object cache.
 :Type: Integer
 :Default: ``104857600`` (100MB)
 
 ``client_oc_max_dirty_age``
 
-:Description: Maximum age of dirty data in the object cache before writeback.
+:Description: Set the maximum age in seconds of dirty data in the object cache before writeback.
 :Type: Float
 :Default: ``5.0`` (seconds)
 
 ``client_oc_max_objects``
 
-:Description: Maximum number of objects in the object cache.
+:Description: Set the maximum number of objects in the object cache.
 :Type: Integer
 :Default: ``1000``
 
 ``client_oc_size``
 
-:Description: Maximum size of cached data in the object cache.
+:Description: Set how many megabytes of data will the client cache.
 :Type: Integer
 :Default: ``209715200`` (200MB)
 
 ``client_oc_target_dirty``
 
-:Description: Target size of dirty data. It is recommended to keep this low.
+:Description: Set the target size of corrupted data. We recommend to keep this number low.
 :Type: Integer
 :Default: ``8388608`` (8MB)
 
 
 ``client_quota``
 
-:Description: Enable client quota checking.
+:Description: Enable client quota checking if set to ``true``.
 :Type: Boolean
 :Default: ``true``
 
 ``client_quota_df``
 
-:Description: Report root directory quota for statfs operation.
+:Description: Report root directory quota for the ``statfs`` operation.
 :Type: Boolean
 :Default: ``true``
 
 ``client_readahead_max_bytes``
 
-:Description: Maximum bytes of readahead used for future read operations. Overridden by ``client_readahead_max_periods``.
+:Description: Set the maximum number of bytes that the kernel reads ahead for future read operations. Overridden by the ``client_readahead_max_periods`` setting.
 :Type: Integer
 :Default: ``0`` (unlimited)
 
 ``client_readahead_max_periods``
 
-:Description: Number of file layout periods (object size * number of stripes) to readahead. Overrides ``client_readahead_max_bytes``.
+:Description: Set the number of file layout periods (object size * number of stripes) that the kernel reads ahead. Overrides the ``client_readahead_max_bytes`` setting.
 :Type: Integer
 :Default: ``4``
 
 ``client_readahead_min``
 
-:Description: Minimum bytes to readahead.
+:Description: Set the minimum number bytes that the kernel reads ahead.
 :Type: Integer
 :Default: ``131072`` (128KB)
 
 ``client_snapdir``
 
-:Description: Name for the snapshot directory.
+:Description: Set the snapshot directory name.
 :Type: String
 :Default: ``".snap"``
 
 ``client_tick_interval``
 
-:Description: Interval between capability renewal and other upkeep.
+:Description: Set the interval in seconds between capability renewal and other upkeep.
 :Type: Float
 :Default: ``1.0`` (seconds)
 
 ``client_trace``
 
-:Description: Trace file path for all file operations. The output is designed to be used by the Ceph `synthetic client <../man/8/ceph-syn>`.
+:Description: Trace the file path for all file operations. The output is designed to be used by the Ceph `synthetic client <../man/8/ceph-syn>`.
 :Type: String
 :Default: ``""`` (disabled)
 
 :Type: Boolean
 :Default: ``false``
 
+``fuse_default_permissions``
+
+:Description: When set to ``true``, the FUSE client enforces permissions. When set to ``false``, the ``ceph-fuse`` utility enforces the permissions. Set to `false` together with the ``client acl type=posix_acl`` option to enable POSIX ACL.
+:Type: Boolean
+:Default: ``true``
+
 Developer Options
 #################
 
+.. important:: These options are internal. They are listed here only to complete the list of options.
+
 ``client_inject_fixed_oldest_tid``
 
 :Description: