Skip to content

doc/cephfs: add doc for cephfs io path#30369

Merged
batrick merged 1 commit intoceph:masterfrom
ukernel:wip-41738
Oct 29, 2019
Merged

doc/cephfs: add doc for cephfs io path#30369
batrick merged 1 commit intoceph:masterfrom
ukernel:wip-41738

Conversation

@ukernel
Copy link
Contributor

@ukernel ukernel commented Sep 13, 2019

Fixes: https://tracker.ceph.com/issues/41738
Signed-off-by: "Yan, Zheng" zyan@redhat.com

Checklist

  • References tracker ticket
  • Updates documentation if necessary
  • Includes tests for new functionality or reproducer for bug

Show available Jenkins commands
  • jenkins retest this please
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard backend
  • jenkins test docs
  • jenkins render docs

@ukernel ukernel added documentation cephfs Ceph File System labels Sep 13, 2019
@batrick
Copy link
Member

batrick commented Sep 16, 2019

jenkins render docs

Copy link
Member

@batrick batrick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs rebased.

@batrick batrick requested a review from a team September 23, 2019 14:21
Ceph File System IO Path
=========================

The Ceph File System (CephFS) stores file data as RADOS objects. File System
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pehaps we can make this paragraph more coherent -

All file data in CephFS is stored as RADOS objects. CephFS clients can directly access RADOS to operate on file data but metadata operations are handled by MDS.

@ukernel
Copy link
Contributor Author

ukernel commented Sep 30, 2019

jenkins render docs

To read/write a CephFS file, client needs to have 'file read/write' capabilities
for corresponding inode. If client does not have required capabilities, it sends
a 'cap message' to MDS, telling MDS what it wants. MDS will issue capabilities
to client when it is possible. Once client has 'file read/write' capabilities,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also a chance to explain how buffered/cached I/O works.

a 'cap message' to MDS, telling MDS what it wants. MDS will issue capabilities
to client when it is possible. Once client has 'file read/write' capabilities,
it can directly access RADOS to read/write file data. File data are stored as
Rados objects in the form of <inode number>.<object index>.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RADOS*

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and <inode number>.<object index> is not completely self-explanatory, which is why I suggest talking about file layouts.

@ukernel
Copy link
Contributor Author

ukernel commented Oct 14, 2019

update

@ukernel
Copy link
Contributor Author

ukernel commented Oct 21, 2019

jenkins render docs

Fixes: https://tracker.ceph.com/issues/41738
Signed-off-by: "Yan, Zheng" <zyan@redhat.com>
@ukernel
Copy link
Contributor Author

ukernel commented Oct 23, 2019

jenkins render docs

@ceph-jenkins
Copy link
Collaborator

Doc render available at http://docs.ceph.com/ceph-prs/30369/

batrick added a commit that referenced this pull request Oct 29, 2019
* refs/pull/30369/head:
	doc/cephfs: add doc for cephfs io path

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
@batrick batrick merged commit 2328698 into ceph:master Oct 29, 2019
@ukernel ukernel deleted the wip-41738 branch October 31, 2019 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cephfs Ceph File System documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants