---
id: "cephfs"
type: "component"
kind: "file-storage"
provider: "default"
category: "data"
docs: "https://docs.ceph.com/en/latest/cephfs/"
url: "https://localhost:3000/catalogue/components/cephfs"
---

# CephFS

POSIX-compliant shared file system built on Ceph RADOS, also exportable over NFS and SMB.

| | |
|---|---|
| Provider | [default](https://localhost:3000/catalogue?provider=default) |
| Kind | [File share](https://localhost:3000/catalogue/kinds/file-storage) |
| Category | Data |
| Official docs | [https://docs.ceph.com/en/latest/cephfs/](https://docs.ceph.com/en/latest/cephfs/) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `backupEnabled` | boolean | — | no | false | **false** |
| `dataPoolReplicas` | integer | — | no | 3 | inherited |
| `encryptionInTransit` | boolean | — | no | — | inherited |
| `managed` | boolean | — | no | false | **false** |
| `protocol` | enum | `nfs`, `smb`, `multi`, `lustre`, `native` | yes | — | **"multi"** |
| `publicAccess` | boolean | — | no | — | **false** |
| `quotaGib` | integer | — | no | — | inherited |
| `quotasEnabled` | boolean | — | no | false | inherited |
| `redundancy` | enum | `local`, `zonal`, `regional` | no | — | **"local"** |
| `snapshotsEnabled` | boolean | — | no | true | inherited |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 35

- [Apsara File Storage for HDFS](https://localhost:3000/catalogue/components/alibaba-file-storage-hdfs.md) `alibaba-file-storage-hdfs` — alibabacloud
- [Apsara File Storage NAS](https://localhost:3000/catalogue/components/alibaba-nas.md) `alibaba-nas` — alibabacloud
- [Amazon EFS](https://localhost:3000/catalogue/components/aws-efs.md) `aws-efs` — aws
- [Amazon File Cache](https://localhost:3000/catalogue/components/aws-file-cache.md) `aws-file-cache` — aws
- [Amazon FSx for Lustre](https://localhost:3000/catalogue/components/aws-fsx-lustre.md) `aws-fsx-lustre` — aws
- [Amazon FSx for NetApp ONTAP](https://localhost:3000/catalogue/components/aws-fsx-ontap.md) `aws-fsx-ontap` — aws
- [Amazon FSx for OpenZFS](https://localhost:3000/catalogue/components/aws-fsx-openzfs.md) `aws-fsx-openzfs` — aws
- [Amazon FSx for Windows File Server](https://localhost:3000/catalogue/components/aws-fsx-windows.md) `aws-fsx-windows` — aws
- [Azure File Sync](https://localhost:3000/catalogue/components/azure-file-sync.md) `azure-file-sync` — azure
- [Azure Files](https://localhost:3000/catalogue/components/azure-files.md) `azure-files` — azure
- [Azure Managed Lustre](https://localhost:3000/catalogue/components/azure-managed-lustre.md) `azure-managed-lustre` — azure
- [Azure NetApp Files](https://localhost:3000/catalogue/components/azure-netapp-files.md) `azure-netapp-files` — azure
- [BeeGFS](https://localhost:3000/catalogue/components/beegfs.md) `beegfs` — default
- [CubeFS](https://localhost:3000/catalogue/components/cubefs.md) `cubefs` — default
- [Curvine](https://localhost:3000/catalogue/components/curvine.md) `curvine` — default
- [Generic file share](https://localhost:3000/catalogue/components/file-storage.md) `file-storage` — default
- [File store](https://localhost:3000/catalogue/components/file-store.md) `file-store` — default
- [GlusterFS](https://localhost:3000/catalogue/components/glusterfs.md) `glusterfs` — default
- [HDFS](https://localhost:3000/catalogue/components/hdfs.md) `hdfs` — default
- [JuiceFS](https://localhost:3000/catalogue/components/juicefs.md) `juicefs` — default
- [Lustre](https://localhost:3000/catalogue/components/lustre.md) `lustre` — default
- [MooseFS](https://localhost:3000/catalogue/components/moosefs.md) `moosefs` — default
- [Nextcloud](https://localhost:3000/catalogue/components/nextcloud.md) `nextcloud` — default
- [NFS server](https://localhost:3000/catalogue/components/nfs-server.md) `nfs-server` — default
- [Samba](https://localhost:3000/catalogue/components/samba.md) `samba` — default
- [DigitalOcean Network File Storage](https://localhost:3000/catalogue/components/digitalocean-nfs.md) `digitalocean-nfs` — digitalocean
- [Filestore](https://localhost:3000/catalogue/components/google-filestore.md) `google-filestore` — gcp
- [Google Cloud Managed Lustre](https://localhost:3000/catalogue/components/google-managed-lustre.md) `google-managed-lustre` — gcp
- [Google Cloud NetApp Volumes](https://localhost:3000/catalogue/components/google-netapp-volumes.md) `google-netapp-volumes` — gcp
- [Parallelstore](https://localhost:3000/catalogue/components/google-parallelstore.md) `google-parallelstore` — gcp
- [File Storage for VPC](https://localhost:3000/catalogue/components/ibm-file-storage.md) `ibm-file-storage` — ibm
- [File Storage for Classic](https://localhost:3000/catalogue/components/ibm-file-storage-classic.md) `ibm-file-storage-classic` — ibm
- [OCI File Storage](https://localhost:3000/catalogue/components/oci-file-storage.md) `oci-file-storage` — oci
- [OCI File Storage with Lustre](https://localhost:3000/catalogue/components/oci-file-storage-lustre.md) `oci-file-storage-lustre` — oci
- [OpenStack Manila](https://localhost:3000/catalogue/components/openstack-manila.md) `openstack-manila` — openstack

## Use it in a design

```yaml
nodes:
  - { id: "cephfs", component: "cephfs" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# CephFS: POSIX-compliant shared file system on RADOS, mounted natively and re-exported over NFS and SMB ("Ceph File System").
# Snapshots are on for new file systems ("CephFS Snapshots"); data pools inherit osd_pool_default_size = 3.
schemaVersion: "1"
type: "component"
id: "cephfs"
kind: "file-storage"
provider: "default"
docs: "https://docs.ceph.com/en/latest/cephfs/"
defaults:
  protocol: "multi"
  managed: false
  publicAccess: false
  backupEnabled: false
  redundancy: "local"
properties:
  dataPoolReplicas:
    type: "integer"
    default: 3
  snapshotsEnabled:
    type: "boolean"
    default: true
  quotasEnabled:
    type: "boolean"
    default: false
```

Human page: https://localhost:3000/catalogue/components/cephfs