github.com/rohankumardubey/proxyfs@v0.0.0-20210108201508-653efa9ab00e/docs/source/index.rst (about)

     1  ProxyFS Introduction
     2  ====================
     3  
     4  ProxyFS is a hierarchical file system that provides integrated file and
     5  object API access for data stored with an object storage back-end.
     6  
     7  .. image:: /_static/ProxyFS-file-object.png
     8   :width: 200pt
     9  
    10  Background
    11  ----------
    12  
    13  .. toctree::
    14      :maxdepth: 1
    15  
    16      architecture/background
    17  
    18  Not a Gateway
    19  -------------
    20  
    21  Rather than using a gateway to provide file-based access, ProxyFS is
    22  directly integrated into the core of OpenStack Swift object storage to
    23  enable direct AWS S3 and Swift object API access. This makes it
    24  compatible with its corresponding projects for `S3
    25  API <https://github.com/openstack/swift3>`__ and `public cloud
    26  synchronization <https://github.com/swiftstack/swift-s3-sync>`__.
    27  
    28  Multiple Modes of Access
    29  ------------------------
    30  
    31  ProxyFS supports SMB and NFS along with AWS S3 and OpenStack Swift
    32  object protocols. This enables filesystem clients to mount and
    33  read/write data that is simultaneously read/write (GET/PUT/etc)
    34  accessible to object API clients.
    35  
    36  Full Filesystem
    37  ---------------
    38  
    39  ProxyFS is a full filesystem. It is not filesystem-like. Full filesystem
    40  operations are supported such as rename, move, growing files, modifying
    41  data, etc.
    42  
    43  ProxyFS is designed to support filesystem-based applications that could
    44  benefit from leveraging cloud storage platforms.
    45  
    46  Modernize Workflows
    47  -------------------
    48  
    49  ProxyFS enables file-based applications and workflows can coexist with
    50  new applications that leverage object APIs such as AWS S3 / Swift API
    51  and integrate with public cloud services.
    52  
    53  Many workflows (and users!) that have increasing storage needs that are
    54  rooted in the expectations of current filesystem access. However, these
    55  workflows could benefit from the architecture and capabilities of object
    56  and cloud storage.
    57  
    58  ProxyFS enables the integration of object storage into existing
    59  file-based workflows / applications while at the same time supporting
    60  object APIs for newer, “cloud native” applications.
    61  
    62  ProxyFS allows the same data that is accessed by S3 and Swift API
    63  accessible by a Filesystem API. This provides a bridge to allow data
    64  services for both existing applications and new applications.
    65  
    66  
    67  API
    68  ---
    69  
    70  .. toctree::
    71      :maxdepth: 1
    72  
    73      api/index
    74  
    75  
    76  Architecture
    77  ------------
    78  
    79  .. toctree::
    80      :maxdepth: 1
    81  
    82      architecture/log-structured-intro
    83      architecture/access
    84      architecture/example-flows
    85  
    86  
    87  Reference Diagrams
    88  ------------------
    89  
    90  .. toctree::
    91      :maxdepth: 2
    92  
    93      architecture/uml-references