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

RGW NFS: add nfs.rst to doc/radosgw #15789

Merged
merged 1 commit into from Jun 21, 2017

Conversation

Projects
None yet
3 participants
@mattbenjamin
Contributor

mattbenjamin commented Jun 20, 2017

This document contains sections by John Wilkins jowilkin@redhat.com.

Signed-off-by: Matt Benjamin mbenjamin@redhat.com

@mattbenjamin mattbenjamin added the rgw label Jun 20, 2017

@mattbenjamin mattbenjamin self-assigned this Jun 20, 2017

@mattbenjamin mattbenjamin requested review from johnwilkins and cbodley Jun 20, 2017

References
==========
[1] http://docs.aws.amazon.com/AmazonS3/latest/dev/ListingKeysHierarchy.html

This comment has been minimized.

@cbodley

cbodley Jun 20, 2017

Contributor

there's a special format you can use for links like this. an example from https://raw.githubusercontent.com/ceph/ceph/master/doc/radosgw/encryption.rst:

This is implemented in S3 according to the `Amazon SSE-KMS`_ specification.

then at the bottom:

.. _Amazon SSE-KMS: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html

This comment has been minimized.

@cbodley

cbodley Jun 20, 2017

Contributor

alternatively, there's a footnote syntax

- many typical i/o operations such as editing files in place will necessarily fail as they perform non-sequential stores
- some file utilities *apparently* writing sequentially (e.g., some versions of GNU tar) may fail due to infrequent non-sequential stores
- When mounting via NFS, sequential application i/o can generally be constrained to be written sequentially to the NFS server via a synchronous mount option (e.g. -osync in Linux)
- NFS clients which cannot mount synchronously (e.g., MS Windows) will not be able to upload files

This comment has been minimized.

@cbodley

cbodley Jun 20, 2017

Contributor

it doesn't appear to like the list formatting. github will show you a preview: https://github.com/linuxbox2/ceph/blob/10ea9a515784ce1a4bae55ef4fd257d2215125f9/doc/radosgw/nfs.rst

everything under Security looks great though. not sure what's wrong here

selection variables (e.g., *rgw data* and *rgw frontends*) are
optional and in some cases ignored.
A small number of config variables (e.g., *rgw_namespace_expire_secs*)

This comment has been minimized.

@cbodley

cbodley Jun 20, 2017

Contributor

other radosgw docs use the ``double-backtick`` syntax to highlight config variables, config sections, and other terms. see https://raw.githubusercontent.com/ceph/ceph/master/doc/radosgw/config-ref.rst for examples

This comment has been minimized.

@mattbenjamin
@mattbenjamin

This comment has been minimized.

Contributor

mattbenjamin commented Jun 20, 2017

@cbodley updated

Required ceph.conf configuration for RGW NFS includes:
* valid [client.radosgw.{instance-name}] section
* valid values for minimal instance configation, in particular, an installed and correct ``keyring``

This comment has been minimized.

@ricardoasmarques

ricardoasmarques Jun 21, 2017

Member

typo: s/configation/configuration/

NFS_Protocols = 4;
Transport_Protocols = TCP;
# optional, permit unsquashed access by client "root" user

This comment has been minimized.

@ricardoasmarques

ricardoasmarques Jun 21, 2017

Member

This line should use space indentation instead of tab indentation

@mattbenjamin

This comment has been minimized.

Contributor

mattbenjamin commented Jun 21, 2017

@ricardoasmarques thank you!

RGW NFS: add nfs.rst to doc/radosgw
This document contains sections by John Wilkins <jowilkin@redhat.com>.

Signed-off-by: Matt Benjamin <mbenjamin@redhat.com>

@mattbenjamin mattbenjamin merged commit 7873c48 into ceph:master Jun 21, 2017

2 of 4 checks passed

make check make check failed
Details
arm64 make check arm64 make check started
Details
Signed-off-by all commits in this PR are signed
Details
Unmodified Submodules submodules for project are unmodified
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment