|
1 | | -# OpenSDS |
| 1 | +# SODA API |
2 | 2 |
|
3 | 3 | [](https://goreportcard.com/report/github.com/sodafoundation/api) |
4 | 4 | [](https://travis-ci.org/sodafoundation/api) |
5 | 5 | [](https://codecov.io/github/sodafoundation/api?branch=master) |
6 | 6 | [](https://github.com/sodafoundation/api/releases) |
7 | 7 | [](https://github.com/sodafoundation/api/blob/master/LICENSE) |
8 | 8 |
|
9 | | -<img src="https://www.opensds.io/wp-content/uploads/sites/18/2016/11/logo_opensds.png" width="100"> |
10 | | - |
11 | | -## ATTN: |
12 | | -Some of the below information is under reivew and update due to the migration from OpenSDS to SODA Foundation. If you have any questions, please post in SODA Slack. If you are not a member, please join [SODA Slack] (https://sodafoundation.io/slack/) |
| 9 | +<img src="https://sodafoundation.io/wp-content/uploads/2020/01/SODA_logo_outline_color_800x800.png" width="200" height="200"> |
13 | 10 |
|
14 | 11 | ## Introduction |
15 | 12 |
|
16 | | -The [OpenSDS Project](https://opensds.io/) is a collaborative project under Linux |
17 | | -Foundation supported by storage users and vendors, including |
18 | | -Dell EMC, Intel, Huawei, Fujitsu, Western Digital, Vodafone, NTT and Oregon State University. The project |
19 | | -will also seek to collaborate with other upstream open source communities |
20 | | -such as Cloud Native Computing Foundation, Docker, OpenStack, and Open |
21 | | -Container Initiative. |
| 13 | +SODA API is an open source implementation of SODA API Standards for Data and Storage Management. The effort is to provide a common unified data and storage interface to store, run any data anywhere. |
| 14 | + |
| 15 | +This project implements the API Server, Different API services, utilities and more. The implementation will be based on the API standards from The SODA Foundation. |
| 16 | + |
| 17 | +It connects the application or client to the storage backends to do data/storage management seamlessly providing a platform and storage agnostic framework. |
| 18 | + |
| 19 | +Any application or client platform can implement the interface using the API specification to connect to API or implement northbound plugins to bridge their specifications to SODA API. |
| 20 | + |
| 21 | +Currently we support block and file APIs for key features of data management (provisioning, migration, fileshare, etc). for on-prem implementation |
| 22 | + |
| 23 | +This is one of the SODA Core Projects and is maintained by SODA Foundation directly. |
| 24 | + |
| 25 | +Earlier part of github.com/sodafoundation/opensds Or github.com/opensds/opensds |
| 26 | + |
| 27 | +## Documentation |
| 28 | + |
| 29 | +[https://docs.sodafoundation.io](https://docs.sodafoundation.io/) |
| 30 | + |
| 31 | +## Quick Start - To Use/Experience |
| 32 | + |
| 33 | +[https://docs.sodafoundation.io](https://docs.sodafoundation.io/) |
| 34 | + |
| 35 | +## Quick Start - To Develop |
| 36 | + |
| 37 | +[https://docs.sodafoundation.io](https://docs.sodafoundation.io/) |
| 38 | + |
| 39 | +## Latest Releases |
| 40 | + |
| 41 | +[https://github.com/sodafoundation/api/releases](https://github.com/sodafoundation/api/releases) |
| 42 | + |
| 43 | +## Support and Issues |
| 44 | + |
| 45 | +[https://github.com/sodafoundation/api/issues](https://github.com/sodafoundation/api/issues) |
| 46 | + |
| 47 | +## Project Community |
| 48 | + |
| 49 | +[https://sodafoundation.io/slack/](https://sodafoundation.io/slack/) |
| 50 | + |
| 51 | +## How to contribute to this project? |
22 | 52 |
|
23 | | -It is a software defined storage controller that provides |
24 | | -unified block, file, object storage services and focuses on: |
| 53 | +Join [https://sodafoundation.io/slack/](https://sodafoundation.io/slack/) and share your interest in the ‘general’ channel |
25 | 54 |
|
26 | | -* *Simple*: well-defined API that follows the [OpenAPI](https://github.com/OAI/OpenAPI-Specification) specification. |
27 | | -* *Lightweight*: no external dependencies, deployed once in binary file or container. |
28 | | -* *Extensible*: pluggable framework available for different storage systems, identity services, capability filters, etc. |
| 55 | +Checkout [https://github.com/sodafoundation/api/issues](https://github.com/sodafoundation/api/issues) labelled with ‘good first issue’ or ‘help needed’ or ‘help wanted’ or ‘StartMyContribution’ or ‘SMC’ |
29 | 56 |
|
30 | | -## Community |
| 57 | +## Project Roadmap |
31 | 58 |
|
32 | | -The OpenSDS community welcomes anyone who is interested in software defined |
33 | | -storage and shaping the future of cloud-era storage. If you are a company, |
34 | | -you should consider joining the [OpenSDS Project](https://opensds.io/). |
35 | | -If you are a developer and would like to be part of the code development |
36 | | -that is happening now, please refer to the Contributing sections below. |
| 59 | +SODA API Standards working with standard bodies and industry partners. Build a scalable microservice based API layer to support data store with file, block and object operations across edge, core/on-prem and cloud. |
37 | 60 |
|
38 | | -## You want to contribute? |
| 61 | + |
39 | 62 |
|
40 | | -* [Our Documentation](https://docs.opensds.io/) : |
41 | | -You can find the quick start guides and start using OpenSDS releases. |
42 | | -See [COMMUNITY](https://docs.opensds.io/community/) for details on discussion of the OpenSDS architecture design and feature development. |
| 63 | +[https://docs.sodafoundation.io](https://docs.sodafoundation.io/) |
43 | 64 |
|
44 | | -## How to start ? |
| 65 | +## Join SODA Foundation |
45 | 66 |
|
46 | | -Please refer to [Try OpenSDS](https://docs.opensds.io/try-opensds/) to start using our releases and knowing more. |
| 67 | +Website : [https://sodafoundation.io](https://sodafoundation.io/) |
47 | 68 |
|
48 | | -## License |
| 69 | +Slack : [https://sodafoundation.io/slack/](https://sodafoundation.io/slack/) |
49 | 70 |
|
50 | | -OpenSDS is under the Apache 2.0 license. See the [LICENSE](LICENSE) file for details. |
| 71 | +Twitter : @sodafoundation |
51 | 72 |
|
52 | | -## Contact |
53 | | -* Mailing list: [opensds-tech-discuss](https://lists.opensds.io/mailman/listinfo/opensds-tech-discuss) |
54 | | -* slack: #[opensds](https://opensds.io/slack) |
55 | | -* Ideas/Bugs: You can raise your ideas, requirements and issues at any of the projects under [our git organization](https://github.com/opensds/) |
56 | | -* Join our community meetings. All the details, refer [our global community meeting agenda and notes](http://bit.ly/sodaglobalcommunitymeeting) |
| 73 | +Mailinglist : [https://lists.opensds.io](https://lists.opensds.io/groups) |
0 commit comments