ownCloud
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode

Terminology

Communication is hard. And clear communication is even harder. You may encounter the following terms throughout the documentation, in the code or when talking to other developers. Just keep in mind that whenever you hear or read storage, that term needs to be clarified, because on its own it is too vague. PR welcome.

Logical concepts

Resources

A resource is the basic building block that oCIS manages. It can be of different types:

  • an actual file
  • a container, e.g. a folder or bucket
  • a symlink, or
  • a reference which can point to a resource in another storage provider

References

A reference identifies a resource. A CS3 reference can carry a path and a CS3 resource id. The references come in two flavors: absolute and combined. Absolute references have either the path or the resource id set:

  • An absolute path MUST start with a /. The resource id MUST be empty.
  • An absolute resource id uniquely identifies a resource and is used as a stable identifier for sharing. The path MUST be empty. Combined references have both, path and resource id set:
  • the resource id identifies the root resource
  • the path is relative to that root. It MUST start with .

References

A reference is a logical concept that identifies a resource. A CS3 reference consists of either

The / is important because currently the static storage registry uses a map to look up which storage provider is responsible for the resource. Paths must be prefixed with / so there can be no collisions between paths and storage provider ids in the same map.

Storage Drivers

A storage driver implements access to a storage system:

It maps the path and id based CS3 references to an appropriate storage system specific reference, e.g.:

  • eos file ids
  • posix inodes or paths
  • deconstructed filesystem nodes

Proposed Change iOS clients can only queue single requests to be executed in the background. The queue an upload and need to be able to identify the uploaded file after it has been uploaded to the server. The disconnected nature of the connection might cause workflows or manual user interaction with the file on the server to move the file to a different place or changing the content while the device is offline. However, on the device users might have marked the file as favorite or added it to other iOS specific collections. To be able to reliably identify the file the client can generate a uuid and attach it to the file metadata during the upload. While it is not necessary to look up files by this uuid having a second file id that serves exactly the same purpose as the file id is redundant.

Another aspect for the file id / uuid is that it must be a logical identifier that can be set, at least by internal systems. Without a writeable fileid we cannot restore backups or migrate storage spaces from one storage provider to another storage provider.

Technically, this means that every storage driver needs to have a map of a uuid to in internal resource identifier. This internal resource identifier can be

  • an eos fileid, because eos can look up files by id
  • an inode if the filesystem and the storage driver support looking up by inode
  • a path if the storage driver has no way of looking up files by id.
    • In this case other mechanisms like inotify, kernel audit or a fuse overlay might be used to keep the paths up to date.
    • to prevent excessive writes when deep folders are renamed a reverse map might be used: it will map the uuid to <parentuuid>:<childname>, allowing to trade writes for reads

Storage Providers

Technical concepts

Storage Systems

oCIS storage provider
[Software System]
oCIS storage provider...
reva storage provider
[Component: golang]

hosts multiple storage spaces using a storage driver
reva storage provider...
reva gateway
[Component: golang]

API facade for internal reva services
reva gateway...
Storage System
[Software System]

provides persistent storage
Storage System...
Reads from and writes to
[POSIX, S3]
Reads from and writes to...
reva frontend
[Component: golang]

handles protocol translation
reva frontend...
oCIS proxy
[Component: golang]

Routes requests to oc10 or ecis
oCIS proxy...
Mints an internal JWT
and torwards requests to
[WebDAV, OCS, OCM, tus]
Mints an internal JWT...
Client
[Container: C++, Kotlin,
Swift or Vue]

A desktop, mobile or web Client
Client...
Reads from and writes to
[WebDAV, libregraph, CS3]
Reads from and writes to...
Reads from and writes to
[CS3, tus]
Reads from and writes to...
Forwards to
[CS3, storage registry]
Forwards to...

C4 Component diagram for an oCIS storage provider

An oCIS storage provider manages resources in storage spaces by persisting them with a specific storage driver in a storage system.

Date: 2021-07-22T12:40

C4 Component diagram for an oCIS storage provider...
Viewer does not support full SVG 1.1

A storage provider manages multiple storage spaces by accessing a storage system with a storage driver.

CS3
storage provider
API (GRPC)
CS3...
storage provider
storage provider
Viewer does not support full SVG 1.1

Storage Space Registries

A storage spaces registry manages the namespace for a user

Storage Spaces

A storage space is a logical concept: It is a tree of resourcesresources with a single owner (user or group), a quota and permissions, identified by a storage space id.

the root resource of the storage space
the root resource of...
RESOURCE_TYPE_CONTAINER
RESOURCE_TYPE_CONTAINER
RESOURCE_TYPE_FILE
RESOURCE_TYPE_FILE
if the gateway encounters a resource type reference it will look it up and replace the reference with the results of the actual node (which can live in another storage provider)
if the gateway encounters a...
every resource can be referenced by path or by id
every resource can be...
RESOURCE_TYPE_SYMLINK
RESOURCE_TYPE_SYMLINK
RESOURCE_TYPE_REFERENCE
RESOURCE_TYPE_REFERENCE
Viewer does not support full SVG 1.1

Examples would be every user’s home storage space, project storage spaces or group storage spaces. While they all serve different purposes and may or may not have workflows like anti virus scanning enabled, we need a way to identify and manage these subtrees in a generic way. By creating a dedicated concept for them this becomes easier and literally makes the codebase cleaner. A storage space registry then allows listing the capabilities of storage spaces, e.g. free space, quota, owner, syncable, root etag, upload workflow steps, …

Finally, a logical storage space id is not tied to a specific storage provider. If the storage driver supports it, we can import existing files including their file id, which makes it possible to move storage spaces between storage providers to implement storage classes, e.g. with or without archival, workflows, on SSDs or HDDs.

Shares

To be clarified: we are aware that storage spaces may be too ‘heavyweight’ for ad hoc sharEsing with groups. That being said, there is no technical reason why group shares should not be treated like storage spaces that users can provision themselves. They would share the quota with the users home storage space and the share initiator would be the sole owner. Technically, the mechanism of treating a share like a new storage space would be the same. This obviously also extends to user shares and even file individual shares that would be wrapped in a virtual collection. It would also become possible to share collections of arbitrary files in a single storage space, e.g. the ten best pictures from a large album.

Storage Systems

Every storage system has different native capabilities like id and path based lookups, recursive change time propagation, permissions, trash, versions, archival and more. A storage provider makes the storage system available in the CS3 API by wrapping the capabilities as good as possible using a storage driver. There might be multiple storage drivers for a storage system, implementing different tradeoffs to match varying requirements.

Gateways

A gateway acts as a facade to the storage related services. It authenticates and forwards API calls that are publicly accessible.