---

Object-Store Abstraction Architecture (Osaka)

    An abstraction architecture for supporting multiple object-storage systems within HySDS

Osaka is an object storage abstraction system allowing a user to push generic file objects to various backend storage systems. It was designed to abstract the technological specifics of supporting multiple object stores for the HySDS ecosystem. These different backends are selected based on the scheme element of the URI for the file object, thus can be enacted automatically. As a minimum requirement, Osaka must have one endpoint that exists on a local file system.

Features

• Push ability to multiple object-storage systems
• Compatibility with HySDS
• [INSERT LIST OF FEATURES IMPORTANT TO YOUR USERS HERE]

Supported Object-Stores

Schemes	Push Implemented	Pull Implemented	Tested	Notes:
file://, none	Yes	Yes	Yes
s3://, s3s://	Yes	Yes	Yes
dav://, davs://	Yes	Yes	Yes
http://, https://	Yes	Yes	Yes
azure://, azures://	Yes	Yes	Yes	Experimental version by NVG
ftp://, sftp://	No	No	No	Needs re-implementation
rsync://	No	No	No	Not a backend, but a transfer mechanism

Quick Start

Requirements

• Python 3
• Access to an object-storage system (e.g. Amazon AWS S3)
• [INSERT LIST OF REQUIREMENTS HERE]

Setup Instructions

1. [INSERT STEP-BY-STEP SETUP INSTRUCTIONS HERE]

Run Instructions

1. [INSERT STEP-BY-STEP RUN INSTRUCTIONS HERE, WITH OPTIONAL SCREENSHOTS]

Usage Examples

• [INSERT LIST OF COMMON USAGE EXAMPLES HERE, WITH OPTIONAL SCREENSHOTS]

Test Instructions

Osaka has test scripts available here

1. [INSERT STEP-BY-STEP TEST INSTRUCTIONS HERE, WITH OPTIONAL SCREENSHOTS]

Changelog

See our releases page for our key versioned releases.

Frequently Asked Questions (FAQ)

No questions yet. Propose a question to be added here by reaching out to our contributors! See support section below.

Contributing

1. Create an GitHub issue ticket describing what changes you need (e.g. issue-1)
2. Fork this repo
3. Make your modifications in your own fork
4. Make a pull-request in this repo with the code in your fork and tag the repo owner / largest contributor as a reviewer

Working on your first pull request? See guide: How to Contribute to an Open Source Project on GitHub

License

See our: LICENSE

Support

See our: contributors

Key points of contact are: @pymonger