OpenWhisk Proposal

OpenWhisk is an open source, distributed Serverless computing platform able to execute application logic (Actions) in response to events (Triggers) from external sources (Feeds) or HTTP requests governed by conditional logic (Rules). It provides a programming environment supported by a REST API-based Command Line Interface (CLI) along with tooling to support packaging and catalog services.

Champion: Sam Ruby, IBM

Mentors:

Background

Serverless computing is the evolutionary next stage in Cloud computing carrying further the abstraction offered to software developers using Container-based operating system virtualization. The Serverless paradigm enables programmers to just “write” functional code and not worry about having to configure any aspect of a server needed for execution. Such Serverless functions are single purpose and stateless that respond to event-driven data sources and can be scaled on-demand.

The OpenWhisk project offers a truly open, highly scalable, performant distributed Serverless platform leveraging other open technologies along with a robust programming model, catalog of service and event provider integrations and developer tooling. Specifically, every architectural component service of the OpenWhisk platform (e.g., Controller, Invokers, Messaging, Router, Catalog, API Gateway, etc.) all is designed to be run and scaled as a Docker container. In addition, OpenWhisk uniquely leverages aspects of Docker engine to manage, load balance and scale supported OpenWhisk runtime environments (e.g., JavaScript, Python, Swift, Java, etc.), that run Serverless functional code within Invoker compute instances, using Docker containers.

OpenWhisk's containerized design tenants not only allows it to be hosted in various IaaS, PaaS Clouds platforms that support Docker containers, but also achieves the high expectation of the Serverless computing experience by masking all aspects of traditional resource specification and configuration from the end user simplifying and accelerating Cloud application development. In order to enable HTTP requests as a source of events, and thus the creation of Serverless microservices that expose REST APIs, OpenWhisk includes an API Gateway that performs tasks like security, request routing, throttling, and logging.

Rationale

Serverless computing is in the very early stages of the technology adoption curve and has great promise in enabling new paradigms in event-driven application development, but current implementation efforts are fractured as most are tied to specific Cloud platforms and services. Having an open implementation of a Serverless platform, such as OpenWhisk, available and governed by an open community like Apache could accelerate growth of this technology, as well as encourage dialog and interoperability.

Having the ASF accept and incubate OpenWhisk would provide a clear signal to developers interested in Serverless and its future that they are welcome to participate and contribute in its development, growth and governance.

In addition, there are numerous projects already at the ASF that would provide a natural fit to the API-centric, event-driven programming model that OpenWhisk sees as integral to a Serverless future. In fact, any project that includes a service that can produce or consume actionable events could become an integration point with OpenWhisk-enabled functions. Apache projects that manage programming languages and (micro) service runtimes could become part of the OpenWhisk set of supported runtime environments for functions. Device and API gateways would provide natural event sources that could utilize OpenWhisk functions to process, store and analyze vast amounts of information immediately unlocking the potential of fast-growing computing fields offered in spaces as IoT, analytics, cognitive, mobile and more.

Initial Goals

OpenWhisk is an open source community project which seeks to adopt the Apache way through the course of the incubator process and foster collaborative development in the Serverless space.

Currently, the OpenWhisk project's source repository is in GitHub using its associated project tooling, but we believe the open Apache processes, democratic project governance, along with its rich developer community and natural integrations with existing projects provide the ideal fit for the technology to grow.

Serverless will only reach its full potential and avoid fragmentation if it is grown in an environment that Apache can offer.

Current Status

The OpenWhisk project was published as an open source project within GitHub (https://github.com/openwhisk) under the Apache v2.0 license in February 2016. The project consists of the “core” platform repository (https://github.com/openwhisk/openwhisk) code along with its family of repositories that include a “catalog” of OpenWhisk system and utility packages.

The project also includes repositories for:

Issue tracking and project governance (milestones, epics) are also managed through GitHub Issues and visualized through ZenHub. All “pull” requests, once passing automated tests run by TravisCI, are reviewed by “core” contributors with “write” privileges. IBM has also setup private staging servers to “stress” test the platform performance under load and over extended periods of time before being merged into the main code branch. As part of the incubation process we would make these staging tests public and have them be run by Apache.

Currently, the project is not officially versioned and is considered an “experimental beta”, but is marching towards milestone 10 that aligns with what is considered to be a “beta” the end of October and another milestone 11 end of November 2016 which is considered “GA” content for the “core” platform. Again, we would very much like to adopt an Apache community system for deciding on milestones, constituent epics (features) along with dates a versioning plan and communicate effectively using email lists, IRC and a project homepage (which is currently lacking).

In addition to the OpenWhisk core runtime, IBM and Adobe plan to collaborate and contribute to the API Gateway component under an open framework with the Apache community. The API Gateway Framework component would provide essential support for a Serverless environment including container services, platform services and traditional runtimes and provides functionality for API security, request validation, request routing, rate limiting, logging, caching and load balancing.

Meritocracy

The OpenWhisk project firmly believes in meritocracy from its inception. Issue, Feature and code submissions, to fix, improve or optimize the platform code, tooling and documentation, as well as contributions of new SDKs, Packages, Tutorials, etc. have all been welcomed after successful community input, consultation and testing. Contributions can be made by anyone as long as integration and staging (including stress and performance) tests pass. We are looking forward to talented individuals to progress the success of OpenWhisk and an open Serverless ecosystem surrounding it. It would be a pleasure to invite strong contributors to become committers in the project areas where they have shown a consistent track record.

Community

OpenWhisk has made significant effort to build a community using all possible media and social outlets as possible, always asking for interested developers to join and contribute.

The following outlets have been created to engage the public in as many ways as we could conceive. Every single of these sources is monitored continually via OpenWhisk code that triggers events and messages to appropriate developer Slack channels where we seek to respond and engage as quickly as we can.

IBM has sought to promote OpenWhisk at every logical event worldwide where we are able.

Core Developers

The following core developers, along with their credentials, are proposed; each have been committers within OpenWhisk since its initial development:

Alignment

We have looked, from the earliest days of developing OpenWhisk, at Apache as a model for building a strong developer community and worked to adopt its spirit and its best practices. From the outset, we have wished to have enough interest and momentum in order to have a robust pool of developers in order to adopt an Apache governance model for meritorious acknowledgement of committer and core contributors who can bring external knowledge to further grow the project.

We see immediate chances to leverage Apache projects such as Kafka, Camel, MQTT, ApacheMQ, etc. Wherever there is a collector, funnel or router of message data that can directly or indirectly generate events, we intend to link to OpenWhisk as an even provider. These and other projects are listed below and are just, we hope, “scratching the surface” of integration points for Serverless enabled applications.

In addition, we should note that we see immediate interest in leveraging the Apache relationship with the Linux foundation to integrate with the OpenAPI specification (f.k.a., Swagger) and seek to standardize API gateways that follow that spec. to formalize endpoints for services that can produce events.

Known Risks

Orphaned products

OpenWhisk and its initial group of committers along with the community currently supporting the project will continue to promote and look for ways to engage new developers and provide linkage to other compatible open source projects. Serverless computing has a significant future in Cloud computing and an open source implementation of a platform, as OpenWhisk embodies, must success to provide competition and interoperability and provide a rich foundation for new Serverless technologies to rely upon.

Inexperience with Open Source

OpenWhisk, as you can deduce from its name, has been an open source project from its public debut in February 2016. As soon as a the initial code, developed within IBM research, was viable and provided the functionality expected of a Serverless platform, the project team open sourced it and sought to build an open community to evolve it. Most all current all current project team members have strong experience developing within open source projects with meritorious governance models. In fact, several of the current team members are committers on other Apache projects and are excited to reach out to and align with other project communities within Apache.

Homogenous Developers

The current list of committers includes developers from two different companies. The current set of committers are geographically distributed across the U.S., Europe and China. All committers are experienced with working in a distributed environment and utilize many messaging and collaboration tools to continually communicate with each effectively to develop and review code regardless of location.

Additionally, the current project members are very focused on addressing comments, feedback and issue or feature requests as soon as we are able. In fact, we utilize OpenWhisk itself to intelligently notify project developers with the correct knowledge or expertise of any public posting to any community outlets (listed above).

Reliance on Salaried Developers

All of the initial developers are currently salaried by either IBM or Adobe. With increasing awareness and interest in Serverless technologies, we expect this to change due to the addition of volunteer contributors. We intend to promote and encourage participation whenever interest is shown in the project to build a robust community.

Relationships with Other Apache Products

Some possible project intersections or potential connections are listed below. We hope to identify many others through the course of incubation.

Some additional projects we would like to explore any connection with include:

and many others that we hope the community will help identify and prioritize for development work.

An Excessive Fascination with the Apache Brand

The developers of OpenWhisk share a high appreciation of the Apache Software Foundation, and many have been active as users, contributors or committers to other Apache projects.

The main expectation for the developers is not the Apache brand, but the project governance and best practices established by the ASF, access to the Apache community and support and mentorship through senior Apache members.

Documentation

OpenWhisk offers a comprehensive set of documentation (primarily in Markdown) for all parts of the project from installation and deployment (locally, remotely, distributed) on various platforms in order to get developers “up and running” as quickly as possible on multiple platforms (Mac, Windows, Ubuntu). In addition, OpenWhisk goes to great links to document its architecture and programming model and provide guided tutorials for the CLI. All SDKs and Packages that can be installed, besides installation and use cases descriptions, often include videos and blogs. OpenWhisk is dedicated to providing the best documentation possible and even has volunteers’ submissions for translations in some areas.

Initial Source

The project is comprised of multiple repositories all under the primary openwhisk name. All initial source that would be moved under Apache control can be found in GitHub (by repository) here:

Source and Intellectual Property Submission Plan

External Dependencies

The OpenWhisk project code, documentation, samples (for all repositories) have been fully authored under the Apache 2 license with a comprehensive CLA requirements enforced for all committers from its inception. The code has been fully screened and evaluated to assure its code consists of original contributions not encumbered by any license that would be incompatible with Apache.

openwhisk-openwhisk

This repository is the primary repository for the OpenWhisk platform; it contains the implementations for all its component services, CLI and tooling.

Adobe-API-Platform

Trademarks

IBM is pursuing trademarking of the OpenWhisk name in the following jurisdictions: Canada, France, WIPO (i.e., Australia, China, CTM (EUIPO), India, Mexico, Russian Federation, Switzerland, United States of America). IBM plans to transfer all filings and trademark ownership to ASF.

Cryptography

Please note that the file https://github.com/openwhisk/openwhisk/blob/master/common/scala/src/main/scala/whisk/common/Crypt.scala makes use of the Java javax.crypto.* libraries to implement encrypt/decrypt functions. Primarily this is used to encrypt/decrypt user keys or secrets when being passed or stored between or by OpenWhisk components.

In addition, the API Gateway modules (api-gateway-hmac) relies on OpenSSL (openssl/evp.h, openssl/hmac.h).

Required Resources

Resources that infrastructure will be asked to supply for this project.

Over the course of the incubator we would like to develop staging and playground server environments for testing and developer experience. The following environment would be desirable for an initial staging (and separate playground):

In addition, we would like to host a VM with a Node.js server that provides Command Line Tutorials, along with demo samples.

Mailing lists

Initially, we would start with the following recommended initial podling mailing lists:

We would add more as we transition off exiting mailings lists and through the course of incubation.

Git Repository

As a community we would like to keep the master repository as well as issue tracking on GitHub. We will be working closely with ASF Infra. team to implement all the required pieces like ensure to send push and issue notifications through ASF controlled mailing lists. During incubation we will work closely with Infra to support GitHub master repositories. We also understand that we have to support a way of providing patches, which does not require a GitHub account for contributors who are not willing or not able abide by GitHub’s terms and conditions. It is our understanding that this approach has been signed off by Greg Stein, ASF’s Infrastructure Administrator.

If we need to adapt our repo. paths to conform to Apache guidelines (and perhaps necessitated by a move the the Apache named repo.) It is conventional to use all lower case, dash-separated (-) repository names. The repository should be prefixed with incubator and later renamed assuming the project is promoted to a TLP.

If we need to move the project codebase from its existing GitHub repo. as part of incubation, we would like to preserve the directory names as they appear today and adopt the “apache” as part of the URI path as we have seen other projects adopt.

This would mean all existing repositories which are now of the form:

would now take the form:

Issue Tracking

We would like to explore the possibility of continuing to use GitHub issue tracking (as project milestones, epics and features are all nicely tracked via ZenHub boards) as we understand that this may now be possible. We will provide any linkage or support for JIRA issue tracking if that is required in order to track any “pull” requests within GitHub.

Other Resources

We would like to preserve our existing automated TravisCI automated testing from GitHub. The project uses a continuous CD/CI process currently that we would like to continue to support via multiple stages that run progressive stress and performance tests that are also automated.

Initial Committers

The following is the proposed list of initial committers, email address [, GitHub ID)]:

Although this list of initial committers appears long, OpenWhisk is a complete platform which consists of many services supporting many environments, programming languages and integrations. This diversity in needs is reflected by the size of the initial committers group. OpenWhisk also supports an end user ecosystem including CLI, Tooling, Package Catalog, “curated” Packages, samples, etc. along with the intention of tying in API gateway (e.g., OpenAPI) and other event source integrations.

We hope to add many more committers who provide expertise and the various areas OpenWhisk uses to efficiently provide an exceptional Serverless platform with compelling content.

Affiliations

Additional TBD during the proposal process

Sponsors

Additional TBD during the proposal process.

Sponsoring Entity

OpenWhisk would ask that the Apache Incubator be the sponsor.

OpenWhiskProposal (last edited 2016-11-07 22:04:04 by edwardyoon)