doc: minor changes in fuse client config reference #13065
Conversation
Signed-off-by: Bara Ancincova (bara@redhat.com)
doc/cephfs/client-config-ref.rst
Outdated
| :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. |
There was a problem hiding this comment.
Looks like "corrupted" has crept back in here
(Ironically this is sort of a corruption itself :-))
There was a problem hiding this comment.
Oh boy :) I had the same issue also in the downstream docs, so thank you for double checking.
This should be fixed with: 80db40f
Signed-off-by: Bara Ancincova (bara@redhat.com)
baruza
force-pushed
the
wip-fuse-client-config-edits
branch
from
f141ee5
to
80db40f
Compare
|
@jcsp ping? |
doc/cephfs/client-config-ref.rst
Outdated
| :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. |
There was a problem hiding this comment.
This setting isn't a megabyte count, it's a byte count
doc/cephfs/client-config-ref.rst
Outdated
| :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>`. |
There was a problem hiding this comment.
"Trace file path" was correct (it's the path to a file containing a trace)
There was a problem hiding this comment.
Actually, this one should move down to "developer options" too
doc/cephfs/client-config-ref.rst
Outdated
| @@ -176,9 +176,17 @@ | |||
| :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. | |||
There was a problem hiding this comment.
Maybe it's this is clearer if we say something like "When set to false, ceph-fuse 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."
Stylistically it's always nicer to define things in terms of their 'true' meaning, but in this instance all the important effects are what happens when its set to false.
doc/cephfs/client-config-ref.rst
Outdated
| @@ -4,115 +4,115 @@ | |||
|
|
|||
| ``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. | |||
There was a problem hiding this comment.
Let's add a note here that this only takes effect when fuse_default_permissions is false
doc/cephfs/client-config-ref.rst
Outdated
| :Type: String | ||
| :Default: ``""`` (N/A) | ||
| :Default: ``""`` (empty string) |
There was a problem hiding this comment.
The N/A was meant to mean "no ACL enforcement", i.e. just normal POSIX permissions.
doc/cephfs/client-config-ref.rst
Outdated
| :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. |
There was a problem hiding this comment.
Let's move this down into developer options
doc/cephfs/client-config-ref.rst
Outdated
| :Type: Integer | ||
| :Default: ``4096`` | ||
|
|
||
| ``client_metadata`` | ||
|
|
||
| :Description: Comma-delimited strings for client metadata sent to each MDS. | ||
| :Type: String | ||
| :Default: ``""`` (N/A) | ||
| :Default: ``""`` (empty string) |
There was a problem hiding this comment.
N/A in this context meant "no additional metadata".
doc/cephfs/client-config-ref.rst
Outdated
| :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`` | ||
|
|
||
| ``client_metadata`` | ||
|
|
||
| :Description: Comma-delimited strings for client metadata sent to each MDS. |
There was a problem hiding this comment.
Let's extend this description to say "...to each MDS, in addition to the automatically generated version, hostname, etc"
|
@baruza apologies for the delay re-reviewing this, I have added some more comments |
Signed-off-by: Bara Ancincova (bara@redhat.com)
baruza
force-pushed
the
wip-fuse-client-config-edits
branch
from
d93af14
to
b6cad33
Compare
|
@jcsp no problem :) I made the changes you requested. Hopefully, everything is ok now. (I also changed downstream docs) |
|
thanks! |
Signed-off-by: Bara Ancincova (bara@redhat.com)
Based on downstream changes tracked here: https://bugzilla.redhat.com/show_bug.cgi?id=1372236 reviewed by John Spray.