Middleware and Compute Engine for an OpenStack Swift compute framework that runs compute within a Swift cluster
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Zuul 8462e4e688 Merge "Small cleanups" 1 week ago
StorletSamples Use Python 3 by default to run storlet applications 6 months ago
bin Do not bind python2 specific directory into container 6 months ago
devstack Fix functional job failure in gate 2 months ago
doc Switch to newer openstackdocstheme and reno versions 1 month ago
etc Remove unused parameters from sample conf files 1 year ago
playbooks/storlets-functional Fix functional job: Install tox 1 week ago
releasenotes Switch to newer openstackdocstheme and reno versions 1 month ago
scripts Do not bind python2 specific directory into container 6 months ago
src Use SBusClient for execute command 3 months ago
storlets Merge "Use SBusClient for execute command" 2 months ago
tests Use SBusClient for execute command 3 months ago
.coveragerc Change ignore-errors to ignore_errors 4 years ago
.functests Use python-swiftclient 3.8.1 to run func tests in Python2.7 2 months ago
.gitignore Switch to use stestr for unit test 2 years ago
.gitreview OpenDev Migration Patch 1 year ago
.mailmap Initial Cookiecutter Commit. 4 years ago
.stestr.conf Switch to use stestr for unit test 2 years ago
.unittests Prep works for Py3 gate 3 years ago
.zuul.yaml Make py2 functional tests job non-voting 1 month ago
AUTHORS Update AUTHORS and add release note 1 year ago
CHANGELOG CHANGELOG and AUTHORS updates for storlets 1.0.0 2 years ago
CONTRIBUTING.rst Replace git.openstack.org URLs with opendev.org URLs 1 year ago
HACKING.rst Update the documention link for doc migration 2 years ago
LICENSE Initial Cookiecutter Commit. 4 years ago
README.rst typo: storlet, not storelt 1 month ago
bindep.txt correct the urls 2 years ago
build.xml Create storlets package 3 years ago
cluster_config.json-sample Introducing initial cluster config 4 years ago
install_libs.sh Use the same python version to run storlet agents 6 months ago
py2-constraints.txt Use local py2 upper-constraints 2 months ago
requirements.txt Drop oslosphinx package 11 months ago
s2aio.sh Use stable/train keystone to run Python 2.7 job 2 months ago
setup.cfg Small cleanups 1 month ago
setup.py Revert "Cleanup py27 support" 2 months ago
test-requirements.txt Switch to newer openstackdocstheme and reno versions 1 month ago
tox.ini Merge "Small cleanups" 1 week ago

README.rst

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

For Deployers

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