Middleware and Compute Engine for an OpenStack Swift compute framework that runs compute within a Swift cluster
Go to file
Matt Riedemann b7977876c2 Fix section headers in docs home page
Because the title of the main home page was the
same as the sub-sections, the sub-sections were
not actually rendered which made a cluttered mess
of the docs.

This fixes the sub-section header formatting so the
sections are actually rendered properly.

Change-Id: I0377f85e334e5775f712b5a4fa238c76c436c2ae
2018-12-05 17:23:59 -05:00
bin Use argparse to parse command line options 2018-03-29 05:36:46 +00:00
devstack Add _member_ role on functests setup 2018-02-05 15:38:51 +09:00
doc/source Fix section headers in docs home page 2018-12-05 17:23:59 -05:00
etc Replace deprecated "auth_uri" by "www_authenticate_uri" 2018-05-11 08:38:07 +07:00
playbooks/storlets-functional Make the playbook's yaml file start with "---" 2018-10-10 10:37:26 -04:00
releasenotes Update releasenote page index 2018-08-21 17:01:26 +09:00
scripts Getting all storlet related code out of the container 2017-09-15 10:05:42 +03:00
src moving to devstack first phase 2017-10-13 15:13:24 +03:00
storlets python 3 compatibility: fix xrange/range issues 2018-10-07 23:19:52 -04:00
StorletSamples Spelling Mistakes 2018-09-07 10:59:28 +08:00
tests python 3 compatibility: fix xrange/range issues 2018-10-07 23:19:52 -04:00
.coveragerc Change ignore-errors to ignore_errors 2015-09-21 14:55:43 +00:00
.functests Store the func test config and logs in the func gate result 2018-02-27 09:27:10 +00:00
.gitignore Switch to use stestr for unit test 2018-07-20 13:59:22 +07:00
.gitreview Initial Cookiecutter Commit. 2015-08-09 18:08:41 +03:00
.mailmap Initial Cookiecutter Commit. 2015-08-09 18:08:41 +03:00
.stestr.conf Switch to use stestr for unit test 2018-07-20 13:59:22 +07:00
.unittests Prep works for Py3 gate 2016-09-08 11:54:48 +09:00
.zuul.yaml add python 3.6 unit test job 2018-08-24 06:51:08 +00:00
AUTHORS Add Rocky cycle release notes 2018-08-08 17:09:50 +09:00
babel.cfg Initial Cookiecutter Commit. 2015-08-09 18:08:41 +03:00
bindep.txt correct the urls 2018-02-06 16:31:25 +08:00
build.xml Create storlets package 2016-12-01 10:28:43 +09:00
CHANGELOG CHANGELOG and AUTHORS updates for storlets 1.0.0 2018-02-07 11:00:42 +09:00
cluster_config.json-sample Introducing initial cluster config 2016-01-16 03:33:47 +02:00
CONTRIBUTING.rst Update the documention link for doc migration 2017-10-16 15:03:04 +08:00
HACKING.rst Update the documention link for doc migration 2017-10-16 15:03:04 +08:00
install_libs.sh Amend the spelling error of a word 2018-06-07 09:04:03 +08:00
LICENSE Initial Cookiecutter Commit. 2015-08-09 18:08:41 +03:00
openstack-common.conf Initial Cookiecutter Commit. 2015-08-09 18:08:41 +03:00
README.rst Make the playbook's yaml file start with "---" 2018-10-10 10:37:26 -04:00
requirements.txt Bumping up pbr version requirement 2017-03-02 12:29:30 +02:00
s2aio.sh moving to devstack first phase 2017-10-13 15:13:24 +03:00
setup.cfg Merge "Update the documention link for doc migration" 2017-10-20 02:49:43 +00:00
setup.py Working with a JSON cluster configuration 2016-05-15 20:51:20 +03:00
test-requirements.txt Switch to use stestr for unit test 2018-07-20 13:59:22 +07:00
tox.ini Merge "Switch to use stestr for unit test" 2018-08-03 02:55:15 +00:00

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".

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://storlets.readthedocs.io/en/latest/

Getting Started for Users

The fastest way to get started is "S2AIO - Swift Storlets All In One".

For Engine Developers

Getting Started

The best way to get started is following this guide: "Installing a Development Environment".

Tests

There are two types of tests included in the Storlets repo.

  1. Unit tests
  2. 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".

Code Organization

  • Engine/: The code comprising the middleware and the compute engine
    • SBus/: A protocol layer between the middleware and the sandbox used to execute storlets
      • SBusJavaFacade/: A Java implementation of the protocol
      • SBusPythonFacade/: A Python implementation of the protocol
      • SBusTransportLayer/: A thin layer in "C" used for passing fds between the middleware and container
    • SCommon/: A Java library required for storlets development
    • SDaemon/: A generic Java daemon for loading storlets at runtime
    • SMSCripts/: Run time scripts for doing Docker management commands
    • agent/: Python code for Docker side storlets process management
    • swift/: Python swift side code
      • etc/: Sample config files
      • storlet_gateway/: Run time loadable code for managing storlets execution
      • storlet_middleware/: Swift middleware dealing with storlet invocation requests
  • StorletSamples/: Storlets examples, used for functional testing
  • doc/source/: Documentation
  • install/: Installation scripts
    • swift/: Scripts for invoking an extenral Swift ansible installation scrpts
    • storlets/: Scripts for installing storlets over a Swift cluster
  • 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".

The write and deploy a storlet, follow: "Writing and deploying storelts".

For Deployers

Instructions for how to deploy Storlets over an existing Swift cluster (not SAIO): "Deploying storlets over an existing Swift cluster".