other storage interfaces to form a modern unified storage system: RBD (Ceph
Block Devices) and RGW (Ceph Object Storage Gateway).
-.. note:: If you are evaluating CephFS for the first time, please review
- the best practices for deployment: :doc:`/cephfs/best-practices`
+Getting Started with CephFS
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+For most deployments of Ceph, setting up a CephFS file system is as simple as:
-Using CephFS
-^^^^^^^^^^^^
+.. code:: bash
-Using CephFS with a running Ceph Storage Cluster requires at least one active
-:doc:`Metadata Server (MDS) daemon </cephfs/add-remove-mds>`, :doc:`creating
-the file system </cephfs/createfs>`, selecting a mount mechanism for clients
-(:doc:`FUSE </cephfs/fuse>` or :doc:`kernel driver </cephfs/kernel>`), and
-configuring :doc:`authentication credentials </cephfs/client-auth>` for
-clients.
+ ceph volume create <fs name>
+
+The Ceph `Orchestrator`_ will automatically create and configure MDS for your
+file system if the back-end deployment technology supports it (see
+`Orchestrator deployment table`_). Otherwise, please :doc:`deploy MDS manually
+as needed </cephfs/add-remove-mds>`.
+
+Finally, to mount CephFS on your client nodes, setup a :doc:`FUSE mount
+</cephfs/fuse>` or :doc:`kernel mount </cephfs/kernel>`. Additionally, a
+command-line shell utility is available for interactive access or scripting via
+the :doc:`cephfs-shell </cephfs/cephfs-shell>`.
-For setting up CephFS quickly, checkout the :doc:`CephFS Quick Start document
-</start/quick-cephfs>`.
.. raw:: html
<!---
-Metadata Server Setup
-^^^^^^^^^^^^^^^^^^^^^
+Administration
+^^^^^^^^^^^^^^
.. raw:: html
:maxdepth: 1
:hidden:
+ Deployment best practices <best-practices>
+ Create a CephFS file system <createfs>
+ Administrative commands <administration>
Provision/Add/Remove MDS(s) <add-remove-mds>
- MDS failover and standby configuration <standby>
- MDS Configuration Settings <mds-config-ref>
- Client Configuration Settings <client-config-ref>
- Journaler Configuration <journaler>
- Manpage ceph-mds <../../man/8/ceph-mds>
+ MDS failover and standby configuration <standby>
+ MDS Cache Size Limits <cache-size-limits>
+ MDS Configuration Settings <mds-config-ref>
+ Manual: ceph-mds <../../man/8/ceph-mds>
+ Export over NFS <nfs>
+ Application best practices <app-best-practices>
+ FS volume and subvolumes <fs-volumes>
+ CephFS Quotas <quota>
+ Health messages <health-messages>
+ Upgrading old file systems <upgrading>
.. raw:: html
:maxdepth: 1
:hidden:
- Create a CephFS file system <createfs>
- Mount CephFS using Kernel Driver <kernel>
- Mount CephFS using FUSE <fuse>
- Use the CephFS Shell <cephfs-shell>
- Supported Features of Kernel Driver <kernel-features>
- Manpage ceph-fuse <../../man/8/ceph-fuse>
- Manpage mount.ceph <../../man/8/mount.ceph>
- Manpage mount.fuse.ceph <../../man/8/mount.fuse.ceph>
+ Client Configuration Settings <client-config-ref>
+ Client authentication <client-auth>
+ Mount CephFS using Kernel Driver <kernel>
+ Mount CephFS using FUSE <fuse>
+ Use the CephFS Shell <cephfs-shell>
+ Supported Features of Kernel Driver <kernel-features>
+ Manual: ceph-fuse <../../man/8/ceph-fuse>
+ Manual: mount.ceph <../../man/8/mount.ceph>
+ Manual: mount.fuse.ceph <../../man/8/mount.fuse.ceph>
.. raw:: html
<!---
-Additional Details
-^^^^^^^^^^^^^^^^^^
+CephFS Concepts
+^^^^^^^^^^^^^^^
.. raw:: html
:maxdepth: 1
:hidden:
- Deployment best practices <best-practices>
MDS States <mds-states>
- Administrative commands <administration>
- Understanding MDS Cache Size Limits <cache-size-limits>
POSIX compatibility <posix>
- Experimental Features <experimental-features>
- CephFS Quotas <quota>
- Using Ceph with Hadoop <hadoop>
MDS Journaling <mds-journaling>
- cephfs-journal-tool <cephfs-journal-tool>
File layouts <file-layouts>
- Client eviction <eviction>
- Handling full file systems <full>
- Health messages <health-messages>
- Troubleshooting <troubleshooting>
- Disaster recovery <disaster-recovery>
- Client authentication <client-auth>
- Upgrading old file systems <upgrading>
- Configuring directory fragmentation <dirfrags>
- Configuring multiple active MDS daemons <multimds>
- Export over NFS <nfs>
- Application best practices <app-best-practices>
- Scrub <scrub>
- LazyIO <lazyio>
Distributed Metadata Cache <mdcache>
- FS volume and subvolumes <fs-volumes>
Dynamic Metadata Management in CephFS <dynamic-metadata-management>
CephFS IO Path <cephfs-io-path>
+ LazyIO <lazyio>
+ Directory fragmentation <dirfrags>
+ Multiple active MDS daemons <multimds>
+
.. raw:: html
<!---
-Metadata Repair
-^^^^^^^^^^^^^^^
+Troubleshooting and Disaster Recovery
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. raw:: html
.. toctree::
:hidden:
- Advanced: Metadata repair <disaster-recovery-experts>
+ Client eviction <eviction>
+ Scrubbing the File System <scrub>
+ Handling full file systems <full>
+ Metadata repair <disaster-recovery-experts>
+ Troubleshooting <troubleshooting>
+ Disaster recovery <disaster-recovery>
+ cephfs-journal-tool <cephfs-journal-tool>
.. raw:: html
<!---
-For Developers
-^^^^^^^^^^^^^^
+Developer Guides
+^^^^^^^^^^^^^^^^
.. raw:: html
:maxdepth: 1
:hidden:
+ Journaler Configuration <journaler>
Client's Capabilities <capabilities>
- libcephfs <../../api/libcephfs-java/>
+ libcephfs for Java <../../api/libcephfs-java/>
Mantle <mantle>
+
+.. raw:: html
+
+ <!---
+
+Additional Details
+^^^^^^^^^^^^^^^^^^
+
+.. raw:: html
+
+ --->
+
+.. toctree::
+ :maxdepth: 1
+ :hidden:
+
+ Experimental Features <experimental-features>
+ Using Ceph with Hadoop <hadoop>
+
+
+.. _Orchestrator: ../mgr/orchestrator_cli
+.. _Orchestrator deployment table: ..//mgr/orchestrator_cli/#current-implementation-status
projects / ceph-ci.git / commitdiff