Client Config Reference
------------------------
-``client_acl_type``
-
-:Description: Set the ACL type. Currently, only possible value is ``"posix_acl"`` to enable POSIX ACL, or an empty string. This option only takes effect when the ``fuse_default_permissions`` is set to ``false``.
-
-:Type: String
-:Default: ``""`` (no ACL enforcement)
-
-``client_cache_mid``
-
-: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 the number of inodes that the client keeps in the metadata cache.
-:Type: Integer
-:Default: ``16384``
-
-``client_caps_release_delay``
-
-: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: If set to ``true``, clients read data directly from OSDs instead of using a local page cache.
-:Type: Boolean
-:Default: ``false``
-
-``client_dirsize_rbytes``
-
-: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: 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``
-
-``client_metadata``
-
-:Description: Comma-delimited strings for client metadata sent to each MDS, in addition to the automatically generated version, host name, and other metadata.
-:Type: String
-:Default: ``""`` (no additional metadata)
-
-``client_mount_gid``
-
-:Description: Set the group ID of CephFS mount.
-:Type: Integer
-:Default: ``-1``
-
-``client_mount_timeout``
-
-:Description: Set the timeout for CephFS mount in seconds.
-:Type: Float
-:Default: ``300.0``
-
-``client_mount_uid``
-
-:Description: Set the user ID of CephFS mount.
-:Type: Integer
-:Default: ``-1``
-
-``client_mountpoint``
-
-: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.
-:Type: Boolean
-:Default: ``true``
-
-``client_oc_max_dirty``
-
-:Description: Set the maximum number of dirty bytes in the object cache.
-:Type: Integer
-:Default: ``104857600`` (100MB)
-
-``client_oc_max_dirty_age``
-
-: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: Set the maximum number of objects in the object cache.
-:Type: Integer
-:Default: ``1000``
-
-``client_oc_size``
-
-:Description: Set how many bytes of data will the client cache.
-:Type: Integer
-:Default: ``209715200`` (200 MB)
-
-``client_oc_target_dirty``
-
-:Description: Set the target size of dirty data. We recommend to keep this number low.
-:Type: Integer
-:Default: ``8388608`` (8MB)
-
-``client_permissions``
-
-:Description: Check client permissions on all I/O operations.
-:Type: Boolean
-:Default: ``true``
-
-``client_quota``
-
-:Description: Enable client quota checking if set to ``true``.
-:Type: Boolean
-:Default: ``true``
-
-``client_quota_df``
-
-:Description: Report root directory quota for the ``statfs`` operation.
-:Type: Boolean
-:Default: ``true``
-
-``client_readahead_max_bytes``
-
-:Description: Set the maximum number of bytes that the client reads ahead for future read operations. Overridden by the ``client_readahead_max_periods`` setting.
-:Type: Integer
-:Default: ``0`` (unlimited)
-
-``client_readahead_max_periods``
-
-:Description: Set the number of file layout periods (object size * number of stripes) that the client reads ahead. Overrides the ``client_readahead_max_bytes`` setting.
-:Type: Integer
-:Default: ``4``
-
-``client_readahead_min``
-
-:Description: Set the minimum number bytes that the client reads ahead.
-:Type: Integer
-:Default: ``131072`` (128KB)
-
-``client_reconnect_stale``
-
-:Description: Automatically reconnect stale session.
-:Type: Boolean
-:Default: ``false``
-
-``client_snapdir``
-
-:Description: Set the snapshot directory name.
-:Type: String
-:Default: ``".snap"``
-
-``client_tick_interval``
-
-:Description: Set the interval in seconds between capability renewal and other upkeep.
-:Type: Float
-:Default: ``1.0`` (seconds)
-
-``client_use_random_mds``
-
-:Description: Choose random MDS for each request.
-:Type: Boolean
-:Default: ``false``
-
-``fuse_default_permissions``
-
-:Description: When set to ``false``, ``ceph-fuse`` utility checks does its own permissions checking, instead of relying on the permissions enforcement in FUSE. Set to ``false`` together with the ``client acl type=posix_acl`` option to enable POSIX ACL.
-:Type: Boolean
-:Default: ``true``
-
-``fuse_max_write``
-
-:Description: Set the maximum number of bytes in a single write operation.
- A value of 0 indicates no change; the
- FUSE default of 128 kbytes remains in force.
-:Type: Integer
-:Default: ``0``
-
-``fuse_disable_pagecache``
-
-:Description: If set to ``true``, kernel page cache is disabled for ``ceph-fuse``
- mounts. When multiple clients read/write to a file at the same
- time, readers may get stale data from page cache. Due to
- limitations of FUSE, ``ceph-fuse`` can't disable page cache dynamically.
-:Type: Boolean
-:Default: ``false``
+.. confval:: client_acl_type
+.. confval:: client_cache_mid
+.. confval:: client_cache_size
+.. confval:: client_caps_release_delay
+.. confval:: client_debug_force_sync_read
+.. confval:: client_dirsize_rbytes
+.. confval:: client_max_inline_size
+.. confval:: client_metadata
+.. confval:: client_mount_gid
+.. confval:: client_mount_timeout
+.. confval:: client_mount_uid
+.. confval:: client_mountpoint
+.. confval:: client_oc
+.. confval:: client_oc_max_dirty
+.. confval:: client_oc_max_dirty_age
+.. confval:: client_oc_max_objects
+.. confval:: client_oc_size
+.. confval:: client_oc_target_dirty
+.. confval:: client_permissions
+.. confval:: client_quota_df
+.. confval:: client_readahead_max_bytes
+.. confval:: client_readahead_max_periods
+.. confval:: client_readahead_min
+.. confval:: client_reconnect_stale
+.. confval:: client_snapdir
+.. confval:: client_tick_interval
+.. confval:: client_use_random_mds
+.. confval:: fuse_default_permissions
+.. confval:: fuse_max_write
+.. confval:: fuse_disable_pagecache
Developer Options
#################
.. important:: These options are internal. They are listed here only to complete the list of options.
-``client_debug_getattr_caps``
-
-:Description: Check if the reply from the MDS contains required capabilities.
-:Type: Boolean
-:Default: ``false``
-
-``client_debug_inject_tick_delay``
-
-:Description: Add artificial delay between client ticks.
-:Type: Integer
-:Default: ``0``
-
-``client_inject_fixed_oldest_tid``
-
-:Description:
-:Type: Boolean
-:Default: ``false``
-
-``client_inject_release_failure``
-
-:Description:
-:Type: Boolean
-:Default: ``false``
-
-``client_trace``
-
-:Description: The path to the trace file for all file operations. The output is designed to be used by the Ceph `synthetic client <../../man/8/ceph-syn>`_.
-:Type: String
-:Default: ``""`` (disabled)
-
+.. confval:: client_debug_getattr_caps
+.. confval:: client_debug_inject_tick_delay
+.. confval:: client_inject_fixed_oldest_tid
+.. confval:: client_inject_release_failure
+.. confval:: client_trace
type: size
level: basic
desc: soft maximum number of directory entries in client cache
+ fmt_desc: Set the number of inodes that the client keeps in the metadata cache.
default: 16_K
services:
- mds_client
type: float
level: advanced
desc: mid-point of client cache LRU
+ fmt_desc: Set client cache midpoint. The midpoint splits the least recently used
+ lists into a hot and warm list.
default: 0.75
services:
- mds_client
type: bool
level: dev
desc: issue new requests to a random active MDS
+ fmt_desc: Choose random MDS for each request.
default: false
services:
- mds_client
type: float
level: advanced
desc: timeout for mounting CephFS (seconds)
+ fmt_desc: Set the timeout for CephFS mount in seconds.
default: 5_min
services:
- mds_client
type: secs
level: dev
desc: seconds between client upkeep ticks
+ fmt_desc: Set the interval in seconds between capability renewal and other upkeep.
default: 1
services:
- mds_client
type: size
level: advanced
desc: minimum bytes to readahead in a file
+ fmt_desc: Set the minimum number bytes that the client reads ahead.
default: 128_K
services:
- mds_client
type: size
level: advanced
desc: maximum bytes to readahead in a file (zero is unlimited)
+ fmt_desc: Set the maximum number of bytes that the client reads ahead for
+ future read operations. Overridden by the ``client_readahead_max_periods``
+ setting.
default: 0
services:
- mds_client
type: int
level: advanced
desc: maximum stripe periods to readahead in a file
+ fmt_desc: Set the number of file layout periods (object size * number of
+ stripes) that the client reads ahead. Overrides the
+ ``client_readahead_max_bytes`` setting.
default: 4
services:
- mds_client
type: str
level: advanced
desc: pseudo directory for snapshot access to a directory
+ fmt_desc: Set the snapshot directory name.
default: .snap
services:
- mds_client
type: str
level: advanced
desc: default mount-point
+ fmt_desc: Directory to mount on the CephFS file system. An alternative to the
+ ``-r`` option of the ``ceph-fuse`` command.
default: /
services:
- mds_client
default: -1
services:
- mds_client
+ fmt_desc: Set the user ID of CephFS mount.
with_legacy: true
- name: client_mount_gid
type: int
level: advanced
desc: gid to mount as
+ fmt_desc: Set the group ID of CephFS mount.
default: -1
services:
- mds_client
default: 5
services:
- mds_client
+ fmt_desc: 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.
with_legacy: true
- name: client_quota_df
type: bool
level: advanced
desc: show quota usage for statfs (df)
+ fmt_desc: Report root directory quota for the ``statfs`` operation.
default: true
services:
- mds_client
type: size
level: advanced
desc: maximum size of object cache
+ fmt_desc: Set how many bytes of data will the client cache.
default: 200_M
services:
- mds_client
type: size
level: advanced
desc: maximum size of dirty pages in object cache
+ fmt_desc: Set the maximum number of dirty bytes in the object cache.
default: 100_M
services:
- mds_client
type: size
level: advanced
desc: target size of dirty pages object cache
+ fmt_desc: Set the target size of dirty data. We recommend to keep this number low.
default: 8_M
services:
- mds_client
type: float
level: advanced
desc: maximum age of dirty pages in object cache (seconds)
+ fmt_desc: Set the maximum age in seconds of dirty data in the object cache
+ before writeback.
default: 5
services:
- mds_client
type: int
level: advanced
desc: maximum number of objects in cache
+ fmt_desc: Set the maximum number of objects in the object cache.
default: 1000
services:
- mds_client
default: false
services:
- mds_client
+ fmt_desc: If set to ``true``, clients read data directly from OSDs instead
+ of using a local page cache.
with_legacy: true
- name: client_debug_inject_tick_delay
type: secs
default: 4_K
services:
- mds_client
+ fmt_desc: 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.
with_legacy: true
# synthetic client bug for testing
- name: client_inject_release_failure
type: str
level: advanced
desc: metadata key=value comma-delimited pairs appended to session metadata
+ fmt_desc: Comma-delimited strings for client metadata sent to each MDS, in addition
+ to the automatically generated version, host name, and other metadata.
services:
- mds_client
with_legacy: true
type: str
level: advanced
desc: ACL type to enforce (none or "posix_acl")
+ fmt_desc: Set the ACL type. Currently, only possible value is ``"posix_acl"`` to
+ enable POSIX ACL, or an empty string. This option only takes effect when the
+ ``fuse_default_permissions`` is set to ``false``.
services:
- mds_client
with_legacy: true
type: bool
level: advanced
desc: client-enforced permission checking
+ fmt_desc: Check client permissions on all I/O operations.
default: true
services:
- mds_client
type: bool
level: advanced
desc: disable page caching in the kernel for this FUSE mount
+ fmt_desc: If set to ``true``, kernel page cache is disabled for ``ceph-fuse``
+ mounts. When multiple clients read/write to a file at the same
+ time, readers may get stale data from page cache. Due to
+ limitations of FUSE, ``ceph-fuse`` can't disable page cache dynamically.
default: false
services:
- mds_client
type: bool
level: advanced
desc: pass default_permisions to FUSE on mount
+ fmt_desc: When set to ``false``, ``ceph-fuse`` utility checks does its own
+ permissions checking, instead of relying on the permissions enforcement in
+ FUSE. Set to ``false`` together with the ``client acl type=posix_acl``
+ option to enable POSIX ACL.
default: false
services:
- mds_client
long_desc: Set the maximum number of bytes in a single write operation that may
pass atomically through FUSE. The FUSE default is 128kB and may be indicated by
setting this option to 0.
+ fmt_desc: Set the maximum number of bytes in a single write operation. A value of
+ 0 indicates no change; the FUSE default of 128 kbytes remains in force.
default: 0
services:
- mds_client
projects / ceph.git / commitdiff