NVIDIA / proxyfs

Apache License 2.0
64 stars 25 forks source link

Build Status Coverage Status

ProxyFS

Provides a POSIX compliant file system mount of an OpenStack Swift Object Storage Container

Synopsis

ProxyFS is a disributed read/write hierarchical POSIX file system layered on top of Swift object storage. File system accesses map to Objects inside a Swift Container.

How to Contribute

All code contributions for ProxyFS go through GitHub.

https://github.com/NVIDIA/proxyfs

Please feel free to contribute by opening a pull request to the development branch. If you see an open pull request, feel free to review it and leave comments on it. ProxyFS follows a git flow development model.

If you'd like to ask questions, discuss ideas, or otherwise communicate with other ProxyFS contributors, please register for and participate in the ProxyFS dev mailing list or the ProxyFS Slack group, which you can join through this inivitation.

How to get the code

Docker-based Development Environment

ProxyFS develoment/building leverages Docker Containers and Docker Compose.

A Multi-Stage Dockerfile is provided that builds the following three images:

To build the images:

To instantiate either a development or test environment, a docker-compose.yml is provided that instantiates the following Docker Containers:

To kick off development activities:

To build all the images:

To clear out prior deamon runs and run the daemons in the background:

Notes:

For a more appropriate environment in which to perform functional testing, the docker-compose.yml file my also be used to launch the suite of Docker Containers:

At this point, you have a separate Docker Container running each of the ProxyFS services. Inside the iclient Docker Container, the /mnt directory will be the FUSE mount point to your ProxyFS file system.

For either the up cases (i.e. dev or iclient), both the imgr and iclient services provide an HTTP endpoint that, due to the port mapping specified in docker-compose.yml, should be reachable from a browser in the host:

License

See LICENSE file