diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..b25c15b8 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*~ diff --git a/Documentation/Architecture.md b/Documentation/Architecture.md new file mode 100644 index 00000000..bf38a9c8 --- /dev/null +++ b/Documentation/Architecture.md @@ -0,0 +1,107 @@ + +A high level view of the internals of Fission. + +Components +========== + +Language-neutral components: + + * Controller + * Container Pool Manager + * Container Specializer + * Router + +Language-specific components: + + * Language Build Container + * Language Run Container + + +Controller +---------- + +Function and Trigger CRUD APIs. APIs to watch for changes are also +included (useful for other components that cache state). + +See api/swagger.json for API details. + +This is the only stateful component. It needs to be configured with a +URL to an etcd cluster and a path to a persistent volume. The volume +will be used to store the functions' source code. + +Etcd is used as the DB. + + +Container Pool Manager +---------------------- + +Manage pool of generic containers. + +Probably use K8s RCs. Can we Use labels to move pods from one rc to +another? What about jobs? + +Container Specializer +--------------------- + +Inputs: a running generic language run container, a user function, +optionally an http trigger URL. + +Calls Language Run Container and sets up Router to point to it. + + +Router +------ + +- Cache trigger -> container instance mapping; implement cache miss and expiration. + +- Invoke Specializer, setup up k8s API + +- Forward requests + +The Router is stateless -- it can be scaled or killed at any time. + +There's a lot of functionality overlap with K8S Ingress Controllers. +We should clearly use Ingress and Ingress Controllers in some way. +It's not exactly clear at the moment how -- should make a whole new +Ingress Controller perhaps based on the contrib/nginx + + +Autoscaler +---------- + +This autoscales the language run containers that are backing a +trigger. + +What metrics this is based on is TBD. + +- Number of requests/sec +- "Backlog" -- number of outstanding requests not yet started -- how to measure this? +- Change in turn-around time? + + +Language Build Container +------------------------ + +* The Language Build Container is a container that is invoked for a + build. It takes one user-created function and outputs something + that can be run by the corresponding Language Run Container. + +* The Build Container must implement the Language Build Container + interface. + + +Language Run Container +---------------------- + +* The Language Run Container is the container in which user functions + run. + +* The Run Container is started without the user function. It must + start as a "Generic Container". It must implement the + "specialization interface". In short, it must implement an HTTP + server that can receive a piece of code, verify its signature, and + map it to an HTTP endpoint. See + Documentation/specs/LanguageRunContainerSpec.md for details. + + + diff --git a/Documentation/ProgrammingModel.md b/Documentation/ProgrammingModel.md new file mode 100644 index 00000000..2e4c4407 --- /dev/null +++ b/Documentation/ProgrammingModel.md @@ -0,0 +1,71 @@ +Programming Model +================= + +This document describes the programming model for fission functions. + +See TERMINOLOGY for definitions of terms, such as _function_, +_instance_, and _trigger_. + + +Idempotency +=========== + +Fission assumes that functions are idempotent. Functions whose instances +die without a result are restarted, upto a certain restart limit. + + +Time Limits +=========== + +By default, there is no time limit on fission functions. + +Idle running instances may be killed at any time (usually after the +default idle timeout of 10 minutes, but this is configurable). + + +Mapping +======= + +This section specifies the mapping between: (1) HTTP and other +triggers, and (2) function parameters, return values, and exceptions. + +In other words, this section describes how a function should be called +based on a given trigger, and how the functions behaviour affects the +result returned from the trigger. + +The HTTP Trigger +---------------- + +NodeJS +------ + +NodeJS functions are called with a context object. + +context.request contains the nodeJS Request object. + +In addition, + +context.queryString contains the parsed querystring + +context.body contains the parsed body + +context.status sets the HTTP response status code. If context.status +is an invalid HTTP status, then the HTTP status is set to 500. + +Exceptions result in a HTTP 500 error. + + + + + +XXX Should we have a "context.done()"? What are the pros and cons? + +XXX Who handles serialization and deserialization? Should we do json + automatically based on content-type and accept headers? + + +Python +------ + +Same as node, pretty much. + diff --git a/Documentation/TERMINOLOGY b/Documentation/TERMINOLOGY new file mode 100644 index 00000000..69b9c59c --- /dev/null +++ b/Documentation/TERMINOLOGY @@ -0,0 +1,22 @@ + +_Function_: A _function_ is the smallest unit of a program in Fission. +It's a program with an function as an entry point -- it doesn't have +to be just one function. + +_Trigger_: Triggers are what cause functions to be called. For +example the HTTP trigger causes functions to be called on HTTP +requests. + +_Instance_: Fission creates and runs servers containing these +functions. The running server is called an _instance_. You normally +don't need to worry about instances: their management is completely +automatic and transparent to you. However, certain configuration +settings allow you to tweak the behaviour of instances -- for example, +you can configure the strategy for destroying unused instances. + +_Generic Instance_: An instance with no user code in it. The process +of including the user code to a Generic Instance is _Specialization_, +and the resulting instance is a _Specialized Instance_. + +_Specialized Instance_: See _General Instance_. + diff --git a/Documentation/UserManual.md b/Documentation/UserManual.md new file mode 100644 index 00000000..7396e64c --- /dev/null +++ b/Documentation/UserManual.md @@ -0,0 +1,15 @@ + +Fission is functions-as-a-service for Kubernetes. + +You write some functions, and setup some way for them to be invoked +("triggers"). Triggers can be HTTP requests (HTTP Triggers) or timers +(Time Triggers). + +Topics +====== + +Testing +------- + +Function Updates +---------------- diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..d6456956 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 00000000..714d3a70 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +Fission +======= + +Fission is a fast serverless framework for Kubernetes with a focus on +developer productivity and high performance. + +It's heavily customizable (but with sensible defaults), extensible to +any language, and interoperates well with other infrastructure. + +You can create and edit functions throughs a web UI, or you can use +your favorite editor and upload them using a CLI. You can trigger these +functions via HTTP requests to paths, or by timers. + +Try it out at http://demo.example.com + +Running Fission +=============== + +On your own Kubernetes cluster +------------------------------ + +### Setup Kubernetes + + https://github.com/kubernetes/minikube + +### Get and Run Fission + + $ wget http://example.com/fission.yaml + $ kubectl create -f fission.yaml + + +Status +====== + +Fission is in early alpha. + + +Performance +=========== + +The goal is to have less than 1 second latency for requests that don't +have a running instance. In practice, benchmarks show this latency at +TODO msec for the NodeJS environment. + +Here's a simple hello world benchmark on NodeJS: TODO. It achieves +TODO requests per second on a TODO-node Kubernetes cluster. + + +Contributions +============= + +TODO diff --git a/new b/new deleted file mode 100644 index e69de29b..00000000