| Name | storlets JSON |
| Version |
14.0.0
JSON |
| download |
| home_page | https://docs.openstack.org/storlets/latest/ |
| Summary | Middleware and Compute Engine for an OpenStack Swift compute framework that runs compute within a Swift cluster |
| upload_time | 2024-10-02 11:15:53 |
| maintainer | None |
| docs_url | None |
| author | OpenStack |
| requires_python | >=3.6 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Storlets
========
Storlets extend Swift with the ability to run user defined computations
- called storlets - near the data in a secure and isolated manner.
A storlet is a compiled and packaged code (e.g. a .jar file) that can be
uploaded to Swift as any other object.
Once uploaded the storlet can be invoked over data objects in Swift.
The Storlets API is documented at
`"Storlets API v1" <https://storlets.readthedocs.io/en/latest/api/overview_api.html>`__.
The project started off as an IBM research project, and was open sourced by IBM in 2014.
- The research leading to the development of this code received funding from the European Community's Seventh Framework Programme (FP7/2007-2013) under the grant agreements for the CASPAR, ENSURE and VISION Cloud projects.
- Various stages and different aspects of the development of this code received funding from the following European Community's Framework Programme:
- Seventh Framework Programme (FP7/2007-2013) under the grant agreements for the ForgetIT project, where the code is used for offloading digital preservation functionalities to the storage.
- Seventh Framework Programme (FP7/2007-2013) under the grant agreements for COSMOS project, where the code is used for analysis of IoT data.
- Seventh Framework Programme (FP7/2007-2013) under the grant agreements for FI-CORE project where the code is integrated with a holistic cloud deployment solution, and from
- Horizon 2020 (H2020/2014-2020) under the grant agreement for the IOStack project where the code is used as a backend implementing Storage policies and is used for analytics
Docs
----
The storlerts documentation is auto-generated after every commit and available
online at https://docs.openstack.org/storlets/latest/
Getting Started for Users
-------------------------
The fastest way to get started is
`"S2AIO - Swift Storlets All In One" <https://docs.openstack.org/storlets/latest/getting_started.html>`__.
For Engine Developers
---------------------
Getting Started
~~~~~~~~~~~~~~~
The best way to get started is following this guide:
`"Installing a Development Environment" <https://docs.openstack.org/storlets/latest/engine_dev_installation.html>`__.
Tests
~~~~~
There are two types of tests included in the Storlets repo.
#. Unit tests
#. Functional tests
Unit tests, are, well, unit tests... The functional tests are black box tests validating
end-to-end scenarios using various storlets, including faulty ones. For more information
please refer to the:
`"Development and Testing Guide" <https://docs.openstack.org/storlets/latest/engine_dev_tests.html>`__.
Repository Structure
~~~~~~~~~~~~~~~~~~~~
- doc/source/: Documentation
- etc/: Sample config files
- storlets/: Python codes
- agent/: Python code for Docker side agents
- common/: An agent for storlets process management
- daemon/: An agent for execution of python applications
- daemon_factory/: Pyth
- gateway/: Run time loadable code for managing storlets execution
- sbus/: A Java implementation of the SBUS communication protocol
- swift_middleware/: Swift middleware dealing with storlet invocation requests
- StorletSamples/: Storlets examples, used for functional testing
- src/: C and Java codes
- c/: All codes
- sbus/: A core implementation of the SBUS protocol, which is used for passing fsd between the middleware and container
- java/: Java codes
- SBus:/ A Java implementation of the SBUS communication protocol
- SCommon/: A Java library required for storlets development
- SDaemon/: A generic Java daemon for loading storlets at runtime
- tests/: Unit and functional tests
- tools/: Various cluster config dependent tools for automatic and manual testing
For Storlets Developers
-----------------------
Currently, storlets can be developed in Java only.
To get started, follow:
`"S2AIO - Swift Storlets All In One" <https://docs.openstack.org/storlets/latest/s2aio.html>`__.
The write and deploy a storlet, follow:
`"Writing and deploying storlets" <https://docs.openstack.org/storlets/latest/writing_and_deploying_storlets.html>`__.
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/storlets/latest/",
"name": "storlets",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/ca/56/f567b82dc0f901f6b5582c41279fb133fe98b434b563b78e07f0a410c49d/storlets-14.0.0.tar.gz",
"platform": null,
"description": "Storlets\n========\n\nStorlets extend Swift with the ability to run user defined computations\n- called storlets - near the data in a secure and isolated manner.\nA storlet is a compiled and packaged code (e.g. a .jar file) that can be\nuploaded to Swift as any other object.\nOnce uploaded the storlet can be invoked over data objects in Swift.\nThe Storlets API is documented at\n`\"Storlets API v1\" <https://storlets.readthedocs.io/en/latest/api/overview_api.html>`__.\n\nThe project started off as an IBM research project, and was open sourced by IBM in 2014.\n\n- The research leading to the development of this code received funding from the European Community's Seventh Framework Programme (FP7/2007-2013) under the grant agreements for the CASPAR, ENSURE and VISION Cloud projects.\n- Various stages and different aspects of the development of this code received funding from the following European Community's Framework Programme:\n\n - Seventh Framework Programme (FP7/2007-2013) under the grant agreements for the ForgetIT project, where the code is used for offloading digital preservation functionalities to the storage.\n - Seventh Framework Programme (FP7/2007-2013) under the grant agreements for COSMOS project, where the code is used for analysis of IoT data.\n - Seventh Framework Programme (FP7/2007-2013) under the grant agreements for FI-CORE project where the code is integrated with a holistic cloud deployment solution, and from\n - Horizon 2020 (H2020/2014-2020) under the grant agreement for the IOStack project where the code is used as a backend implementing Storage policies and is used for analytics\n\nDocs\n----\n\nThe storlerts documentation is auto-generated after every commit and available\nonline at https://docs.openstack.org/storlets/latest/\n\nGetting Started for Users\n-------------------------\n\nThe fastest way to get started is\n`\"S2AIO - Swift Storlets All In One\" <https://docs.openstack.org/storlets/latest/getting_started.html>`__.\n\nFor Engine Developers\n---------------------\n\nGetting Started\n~~~~~~~~~~~~~~~\n\nThe best way to get started is following this guide:\n`\"Installing a Development Environment\" <https://docs.openstack.org/storlets/latest/engine_dev_installation.html>`__.\n\nTests\n~~~~~\n\nThere are two types of tests included in the Storlets repo.\n\n #. Unit tests\n #. Functional tests\n\nUnit tests, are, well, unit tests... The functional tests are black box tests validating\nend-to-end scenarios using various storlets, including faulty ones. For more information\nplease refer to the:\n`\"Development and Testing Guide\" <https://docs.openstack.org/storlets/latest/engine_dev_tests.html>`__.\n\nRepository Structure\n~~~~~~~~~~~~~~~~~~~~\n\n- doc/source/: Documentation\n\n- etc/: Sample config files\n\n- storlets/: Python codes\n\n - agent/: Python code for Docker side agents\n\n - common/: An agent for storlets process management\n - daemon/: An agent for execution of python applications\n - daemon_factory/: Pyth\n\n - gateway/: Run time loadable code for managing storlets execution\n - sbus/: A Java implementation of the SBUS communication protocol\n - swift_middleware/: Swift middleware dealing with storlet invocation requests\n\n- StorletSamples/: Storlets examples, used for functional testing\n\n- src/: C and Java codes\n\n - c/: All codes\n\n - sbus/: A core implementation of the SBUS protocol, which is used for passing fsd between the middleware and container\n\n - java/: Java codes\n\n - SBus:/ A Java implementation of the SBUS communication protocol\n - SCommon/: A Java library required for storlets development\n - SDaemon/: A generic Java daemon for loading storlets at runtime\n\n- tests/: Unit and functional tests\n\n- tools/: Various cluster config dependent tools for automatic and manual testing\n\nFor Storlets Developers\n-----------------------\n\nCurrently, storlets can be developed in Java only.\nTo get started, follow:\n`\"S2AIO - Swift Storlets All In One\" <https://docs.openstack.org/storlets/latest/s2aio.html>`__.\n\nThe write and deploy a storlet, follow:\n`\"Writing and deploying storlets\" <https://docs.openstack.org/storlets/latest/writing_and_deploying_storlets.html>`__.\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Middleware and Compute Engine for an OpenStack Swift compute framework that runs compute within a Swift cluster",
"version": "14.0.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/storlets/latest/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "717543b1acce49428c79165ddb9083152334dbc31d129ef698030045be133e4f",
"md5": "83e1f662c5fa3d26e8a3976e88ba85a2",
"sha256": "b2ee02ecd3808d8baead67a1aac11a84b10f7638ea45fd6410d7f56675f1ee1c"
},
"downloads": -1,
"filename": "storlets-14.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "83e1f662c5fa3d26e8a3976e88ba85a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 76451,
"upload_time": "2024-10-02T11:15:51",
"upload_time_iso_8601": "2024-10-02T11:15:51.848919Z",
"url": "https://files.pythonhosted.org/packages/71/75/43b1acce49428c79165ddb9083152334dbc31d129ef698030045be133e4f/storlets-14.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ca56f567b82dc0f901f6b5582c41279fb133fe98b434b563b78e07f0a410c49d",
"md5": "5b6b19296b37420abdd21106d6bdbcca",
"sha256": "7347a56458f79096961bb6387c24bbec1a7d7662e79b3d0b67ff60ec61c57d53"
},
"downloads": -1,
"filename": "storlets-14.0.0.tar.gz",
"has_sig": false,
"md5_digest": "5b6b19296b37420abdd21106d6bdbcca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 1784278,
"upload_time": "2024-10-02T11:15:53",
"upload_time_iso_8601": "2024-10-02T11:15:53.452619Z",
"url": "https://files.pythonhosted.org/packages/ca/56/f567b82dc0f901f6b5582c41279fb133fe98b434b563b78e07f0a410c49d/storlets-14.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 11:15:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "storlets"
}
