---
id: "file-storage"
type: "kind"
category: "data"
url: "https://localhost:3000/catalogue/kinds/file-storage"
---

# File share

A shared filesystem mounted by many machines over NFS or SMB.

| | |
|---|---|
| Category | Data |
| Properties | 7 |
| Components | 36 |
| Rules | 0 |

## Properties

| property | type | values | required | default |
|---|---|---|---|---|
| `backupEnabled` | boolean | — | no | false |
| `encryptionInTransit` | boolean | — | no | — |
| `managed` | boolean | — | no | false |
| `protocol` | enum | `nfs`, `smb`, `multi`, `lustre`, `native` | yes | — |
| `publicAccess` | boolean | — | no | — |
| `quotaGib` | integer | — | no | — |
| `redundancy` | enum | `local`, `zonal`, `regional` | no | — |

## Rules for this kind · 0

No rule selects this kind or its category.

## Components · 36

### vendor-neutral

- [Generic file share](https://localhost:3000/catalogue/components/file-storage.md) `file-storage` — the kind itself

### alibabacloud

- [Apsara File Storage for HDFS](https://localhost:3000/catalogue/components/alibaba-file-storage-hdfs.md) `alibaba-file-storage-hdfs` — 3 defaults
- [Apsara File Storage NAS](https://localhost:3000/catalogue/components/alibaba-nas.md) `alibaba-nas` — 4 defaults

### aws

- [Amazon EFS](https://localhost:3000/catalogue/components/aws-efs.md) `aws-efs` — 6 defaults
- [Amazon File Cache](https://localhost:3000/catalogue/components/aws-file-cache.md) `aws-file-cache` — 6 defaults
- [Amazon FSx for Lustre](https://localhost:3000/catalogue/components/aws-fsx-lustre.md) `aws-fsx-lustre` — 3 defaults
- [Amazon FSx for NetApp ONTAP](https://localhost:3000/catalogue/components/aws-fsx-ontap.md) `aws-fsx-ontap` — 4 defaults
- [Amazon FSx for OpenZFS](https://localhost:3000/catalogue/components/aws-fsx-openzfs.md) `aws-fsx-openzfs` — 5 defaults
- [Amazon FSx for Windows File Server](https://localhost:3000/catalogue/components/aws-fsx-windows.md) `aws-fsx-windows` — 5 defaults

### azure

- [Azure File Sync](https://localhost:3000/catalogue/components/azure-file-sync.md) `azure-file-sync` — 3 defaults
- [Azure Files](https://localhost:3000/catalogue/components/azure-files.md) `azure-files` — 6 defaults
- [Azure Managed Lustre](https://localhost:3000/catalogue/components/azure-managed-lustre.md) `azure-managed-lustre` — 4 defaults
- [Azure NetApp Files](https://localhost:3000/catalogue/components/azure-netapp-files.md) `azure-netapp-files` — 2 defaults

### default

- [BeeGFS](https://localhost:3000/catalogue/components/beegfs.md) `beegfs` — 5 defaults
- [CephFS](https://localhost:3000/catalogue/components/cephfs.md) `cephfs` — 5 defaults
- [CubeFS](https://localhost:3000/catalogue/components/cubefs.md) `cubefs` — 5 defaults
- [Curvine](https://localhost:3000/catalogue/components/curvine.md) `curvine` — 4 defaults
- [File store](https://localhost:3000/catalogue/components/file-store.md) `file-store` — 2 defaults
- [GlusterFS](https://localhost:3000/catalogue/components/glusterfs.md) `glusterfs` — 6 defaults
- [HDFS](https://localhost:3000/catalogue/components/hdfs.md) `hdfs` — 6 defaults
- [JuiceFS](https://localhost:3000/catalogue/components/juicefs.md) `juicefs` — 4 defaults
- [Lustre](https://localhost:3000/catalogue/components/lustre.md) `lustre` — 5 defaults
- [MooseFS](https://localhost:3000/catalogue/components/moosefs.md) `moosefs` — 5 defaults
- [Nextcloud](https://localhost:3000/catalogue/components/nextcloud.md) `nextcloud` — 3 defaults
- [NFS server](https://localhost:3000/catalogue/components/nfs-server.md) `nfs-server` — 6 defaults
- [Samba](https://localhost:3000/catalogue/components/samba.md) `samba` — 5 defaults

### digitalocean

- [DigitalOcean Network File Storage](https://localhost:3000/catalogue/components/digitalocean-nfs.md) `digitalocean-nfs` — 4 defaults

### gcp

- [Filestore](https://localhost:3000/catalogue/components/google-filestore.md) `google-filestore` — 4 defaults
- [Google Cloud Managed Lustre](https://localhost:3000/catalogue/components/google-managed-lustre.md) `google-managed-lustre` — 5 defaults
- [Google Cloud NetApp Volumes](https://localhost:3000/catalogue/components/google-netapp-volumes.md) `google-netapp-volumes` — 4 defaults
- [Parallelstore](https://localhost:3000/catalogue/components/google-parallelstore.md) `google-parallelstore` — 4 defaults

### ibm

- [File Storage for VPC](https://localhost:3000/catalogue/components/ibm-file-storage.md) `ibm-file-storage` — 3 defaults
- [File Storage for Classic](https://localhost:3000/catalogue/components/ibm-file-storage-classic.md) `ibm-file-storage-classic` — 4 defaults

### oci

- [OCI File Storage](https://localhost:3000/catalogue/components/oci-file-storage.md) `oci-file-storage` — 6 defaults
- [OCI File Storage with Lustre](https://localhost:3000/catalogue/components/oci-file-storage-lustre.md) `oci-file-storage-lustre` — 5 defaults

### openstack

- [OpenStack Manila](https://localhost:3000/catalogue/components/openstack-manila.md) `openstack-manila` — 3 defaults

## Source (`kind` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../schema/kind.schema.json
# A multi-attach mount point with a protocol and a quota, which neither object-store nor block-storage models. protocol is required because a share is meaningless without one; publicAccess and encryptionInTransit stay open for exposure rules.
schemaVersion: "1"
type: "kind"
id: "file-storage"
category: "data"
properties:
  protocol:
    type: "enum"
    values: ["nfs", "smb", "multi", "lustre", "native"]
    required: true
  quotaGib:
    type: "integer"
  encryptionInTransit:
    type: "boolean"
  publicAccess:
    type: "boolean"
  redundancy:
    type: "enum"
    values: ["local", "zonal", "regional"]
  backupEnabled:
    type: "boolean"
    default: false
  managed:
    type: "boolean"
    default: false
```

Human page: https://localhost:3000/catalogue/kinds/file-storage