marvin-steinke/nuclio_fusionizer

The Nuclio Fusionizer streamlines FaaS tasks into single, cost-effective Nuclio Functions for optimal serverless computing.

Nuclio Fusionizer Server

The Nuclio Fusionizer Server is a project that enables the fusion of specific FaaS Tasks into single Nuclio functions. These functions can then be deployed to the open-source serverless computing platform, Nuclio.

The project is informed by the principles outlined in the Fusionize++ paper by Schirmer et al., which discusses the benefits and disadvantages of the Function-as-a-Service (FaaS) model in serverless computing. One key take away from the paper, and the guiding principle of this project, is the optimization of operational flexibility and cost-effectiveness by fusing application code into an optimized multi-function composition.

Key Features

• Fusion of Tasks: Through Nuclio Fusionizer, different Tasks can be fused into singular Nuclio functions, thereby streamlining function calls and execution flow within an application.

• Elimination of Invocation Overhead, Cold starts, and Double Billing: Because Tasks operate within the same memory, invocation overheads, cold starts and double billing associated with individual function calls are eliminated.

• Customized Optimization: You can customize the optimization process for the fusion Tasks with custom Optimizers, providing flexibility to test and compare multiple strategies.

Architecture

• FastApi Server (api_server.py): FastAPI based server that provides an HTTP interface for user interaction with the fusionizer system. It defines endpoints for Task operations and utilizes the Mapper and Nuctl objects.

• Task Manager/Mapper (mapper.py): Manages the representation and operations on Fusion Groups, facilitating the mapping between Tasks and their corresponding Fusion Groups.

• Task Fuser (fuser.py): Takes care of the fusion process, merging multiple Tasks into a single Nuclio function deployment. It combines Tasks into a Fusion Group, generates a unified configuration and creates a dispatch mechanism.

• Optimizers (optimizer.py): Contains abstract and concrete classes for optimization strategies that periodically update the fusion setup based on various conditions or configurations. Implementation includes a static optimizer that changes setup based on a predefined schedule.

• nuctl Interface (nuclio_interface.py): A Python abstraction layer for Nuclio's CLI tool nuctl, handling deployment, deletion, invocation, and information retrieval of Nuclio functions.

• Dispatcher (dispatcher.py): Deployed within Nuclio functions, the dispatcher routes invocation requests from the Fusionizer server to the appropiate Task. HTTP requests between Tasks within the same Nuclio function (≙ Fusion Group) are intercepted and locally invoked.

Installation

# Install nuctl https://nuclio.io/docs/latest/reference/nuctl/nuctl/
curl -s https://api.github.com/repos/nuclio/nuclio/releases/latest \
			| grep -i "browser_download_url.*nuctl.*$(uname)" \
			| cut -d : -f 2,3 \
			| tr -d \" \
			| wget -O nuctl -qi - && chmod +x nuctl
mv nuctl /bin/
pip install .

Usage

Run either directly:

nuclio-fusionizer -h

or use the Docker image and omit the installation:

container_id=$(
     docker run \
          -e ADDRESS=$(hostname -I | awk '{print $1}') \
          # Set all other optional args also as envs, see deployment/docker/entrypoint.sh
          -p 8000:8000 \
          -v /var/run/docker.sock:/var/run/docker.sock \
          -d ghcr.io/marvin-steinke/nuclio-fusionizer:latest
)

if [ $? -eq 0 ]; then
    # Copy config file
    docker cp config.json $container_id:/app/config.json

Deploying and Invoking Tasks

Set up your Tasks as instructed by nuclio with the addition of the requests_session parameter in your handler function. This custom session will intercept any invcocation requests to other Tasks if they reside within the same nuclio function and invoke them locally. The address of the Fusionizer server is supplied in the event headers:

def handler(context, event, requests_session):
    fusionizer_address = event.headers["Fusionizer-Server-Address"]
    # invoke other Task
    url = f"http://{fusionizer_address}:8000/<other Task>"
    headers = {"Content-Type": "application/json"}
    data = {"value1": 5, "value2": 3}
    response = requests_session.post(url, headers=headers, json=data))
    return response.text

Other Task:

def handler(context, event, requests_session):
    return event.body["value1"] + event.body["value2"]

To deploy a Task, you need to zip your Task files and then upload them via the API. Your Task files should be structured like this:

.
├── function.yaml 
├── your_handler.py
└── your_local_dependencies

ZIP compress your Task files from within the Tasks dir:

zip task.zip -r .

API

1. To deploy a new Task or redeploy an existing one:

curl -X PUT http://localhost:8000/<task_name> \
     -H "Content-Type: multipart/form-data" \
     -F "zip_file=@<task>.zip"

2. To delete an existing Task:

curl -X DELETE http://localhost:8000/<task_name>

3. To get information about a Task:

curl -X GET http://localhost:8000/<task_name>

4. To invoke a Task:

curl -X POST http://localhost:8000/<task_name> \
     -H "Content-Type: application/json" \
     -d '{"arg1": "value1", "arg2": 42}'

- Take a look at the tests to see more detailed usage examples -

Custom Optimizers

The Optimizer module in this project provides a flexible way to build and apply unique optimization strategies to Fusion Setups. To create your custom optimizer, you’ll need to subclass the Optimizer abstract class and implement its core methods.

Subclassing Optimizer

• Define Your Class: Inherit from Optimizer and define your custom logic.

• Implement _sleep(): Determine the wait time between optimization runs.

• Implement _optimize(): Create your optimization algorithm to return the new setup.

Example: Using StaticOptimizer

The StaticOptimizer class is a concrete implementation of the abstract Optimizer. It reads a JSON configuration and applies Fusion Groups at the designated times and is the default Optimizer used in the current release.

from nuclio_fusionizer import Optimizer, Mapper

class StaticOptimizer(Optimizer):
    def __init__(self, mapper, config_file):
        super().__init__(mapper)  # Initialize the base class
        # Load configurations here

    def _sleep(self):
        # Sleep control logic here

    def _optimize(self):
        # Read the setup from a configuration and apply it

To use StaticOptimizer, instantiate it with the required mapper and path to the configuration file, then simply start its thread.