New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: minor changes in fuse client config reference #13065

Merged
merged 3 commits into from Feb 20, 2017

Conversation

Projects
None yet
3 participants
@baruza
Contributor

baruza commented Jan 23, 2017

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.

doc: minor changes in fuse client config reference
Signed-off-by: Bara Ancincova (bara@redhat.com)
: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.

This comment has been minimized.

@jcsp

jcsp Jan 26, 2017

Contributor

Looks like "corrupted" has crept back in here

(Ironically this is sort of a corruption itself :-))

This comment has been minimized.

@baruza

baruza Jan 26, 2017

Contributor

Oh boy :) I had the same issue also in the downstream docs, so thank you for double checking.

This should be fixed with: 80db40f

doc: Dirty data are not the same as corrupted data
Signed-off-by: Bara Ancincova (bara@redhat.com)
@tchaikov

This comment has been minimized.

Contributor

tchaikov commented Feb 13, 2017

@jcsp ping?

: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.

This comment has been minimized.

@jcsp

jcsp Feb 15, 2017

Contributor

This setting isn't a megabyte count, it's a byte count

: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>`.

This comment has been minimized.

@jcsp

jcsp Feb 15, 2017

Contributor

"Trace file path" was correct (it's the path to a file containing a trace)

This comment has been minimized.

@jcsp

jcsp Feb 15, 2017

Contributor

Actually, this one should move down to "developer options" too

@@ -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.

This comment has been minimized.

@jcsp

jcsp Feb 15, 2017

Contributor

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.

@@ -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.

This comment has been minimized.

@jcsp

jcsp Feb 15, 2017

Contributor

Let's add a note here that this only takes effect when fuse_default_permissions is false

:Type: String
:Default: ``""`` (N/A)
:Default: ``""`` (empty string)

This comment has been minimized.

@jcsp

jcsp Feb 15, 2017

Contributor

The N/A was meant to mean "no ACL enforcement", i.e. just normal POSIX permissions.

: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.

This comment has been minimized.

@jcsp

jcsp Feb 15, 2017

Contributor

Let's move this down into developer options

: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)

This comment has been minimized.

@jcsp

jcsp Feb 15, 2017

Contributor

N/A in this context meant "no additional metadata".

: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.

This comment has been minimized.

@jcsp

jcsp Feb 15, 2017

Contributor

Let's extend this description to say "...to each MDS, in addition to the automatically generated version, hostname, etc"

@jcsp

This comment has been minimized.

Contributor

jcsp commented Feb 15, 2017

@baruza apologies for the delay re-reviewing this, I have added some more comments

doc: additional edits in FUSE client config
Signed-off-by: Bara Ancincova (bara@redhat.com)
@baruza

This comment has been minimized.

Contributor

baruza commented Feb 16, 2017

@jcsp no problem :) I made the changes you requested. Hopefully, everything is ok now. (I also changed downstream docs)

@jcsp

jcsp approved these changes Feb 20, 2017

@jcsp jcsp merged commit 41253bb into master Feb 20, 2017

3 checks passed

Signed-off-by all commits in this PR are signed
Details
Unmodifed Submodules submodules for project are unmodified
Details
default Build finished.
Details

@jcsp jcsp deleted the wip-fuse-client-config-edits branch Feb 20, 2017

@jcsp

This comment has been minimized.

Contributor

jcsp commented Feb 20, 2017

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment