Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/apache/openwhisk-runtime-python

Apache OpenWhisk Runtime Python supports Apache OpenWhisk functions written in Python
https://github.com/apache/openwhisk-runtime-python

apache cloud docker faas functions functions-as-a-service openwhisk openwhisk-runtime python serverless serverless-architectures serverless-functions

Last synced: 5 days ago
JSON representation

Apache OpenWhisk Runtime Python supports Apache OpenWhisk functions written in Python

Awesome Lists containing this project

README 

        



# Apache OpenWhisk Runtimes for Python

[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)

[![Continuous Integration](https://github.com/apache/openwhisk-runtime-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/apache/openwhisk-runtime-python/actions/workflows/ci.yaml)



This repository contains sources files needed to build the Python runtimes for Apache OpenWhisk. The build system will produce a series of docker images for each runtime version. These images are used in the platform to execute Python actions.



The following Python runtime versions (with kind & image labels) are generated by the build system:



- Python 3.9 (python:3.9 & openwhisk/action-python-v3.9)

- Python 3.10 (python:3.10 & openwhisk/action-python-v3.10)

- Python 3.11 (python:3.11 & openwhisk/action-python-v3.11)

- Python 3.12 (python:3.12 & openwhisk/action-python-v3.12)



This README documents the build, customization and testing of these runtime images.



So a very simple `hello world` function would be:



```python

def main(args):

    name = args.get("name", "stranger")

    greeting = "Hello " + name + "!"

    print(greeting)

    return {"greeting": greeting}

```



For the return result, not only support `dictionary` but also support `array`



So a very simple `hello array` function would be:



```python

def main(args):

    return ["a", "b"]

```



And support array result for sequence action as well, the first action's array result can be used as next action's input parameter.



So the function can be:



```python

def main(args):

    return args

```



To learn more about using Python actions to build serverless applications, check out the main project documentation [here](https://github.com/apache/openwhisk/blob/master/docs/actions-python.md).



## Build Python Runtime



There are two options to build the Python runtime:



- Build using Docker

- Build using Gradle



### Build Python Runtime using Docker

The runtimes can be built using Docker locally. Please follow the detailed [tutorial](tutorials/local_build.md) to build and test the runtime locally.



### Building Python Runtime using Gradle



Pre-requisites



- [Gradle](https://gradle.org/)

- [Docker](https://www.docker.com/)

- [OpenWhisk CLI wsk](https://github.com/apache/openwhisk-cli/releases)



The runtimes are built using Gradle. The file [settings.gradle](settings.gradle) lists the images that are built by default.



To build all those images, run the following command.



```

./gradlew distDocker

```



You can optionally build a specific image by modifying the gradle command. For example:

```

./gradlew core:python311Action:distDocker

```



The build will produce Docker images such as `action-python-v3.11`

and will also tag the same image with the `whisk/` prefix. The latter

is a convenience, which if you're testing with a local OpenWhisk

stack, allows you to skip pushing the image to Docker Hub.



The image will need to be pushed to Docker Hub if you want to test it

with a hosted OpenWhisk installation.



### Using Gradle to push to a Docker Registry



The Gradle build parameters `dockerImagePrefix` and `dockerRegistry`

can be configured for your Docker Registry. Make sure you are logged

in first with the `docker` CLI.



- Use the `docker` CLI to login. The following assumes you will substitute `$DOCKER_USER` with an appropriate value.

  ```

  docker login --username $DOCKER_USER

  ```



- Now build, tag and push the image accordingly.

  ```

  ./gradlew distDocker -PdockerImagePrefix=$DOCKER_USER -PdockerRegistry=docker.io

  ```



### Using Your Image as an OpenWhisk Action



You can now use this image as an OpenWhisk action. For example, to use

the image `action-python-v3.11` as an action runtime, you would run

the following command.



```

wsk action update myAction myAction.py --docker $DOCKER_USER/action-python-v3.11

```



## Test Runtimes



There are suites of tests that are generic for all runtimes, and some that are specific to a runtime version.

To run all tests, there are two steps.



First, you need to create an OpenWhisk snapshot release. Do this from your OpenWhisk home directory.

```

./gradlew install

```



Now you can build and run the tests in this repository.

```

./gradlew tests:test

```



Gradle allows you to selectively run tests. For example, the following

command runs tests which match the given pattern and excludes all

others.

```

./gradlew :tests:test --tests Python*Tests

```



## Using additional python libraries



If you need more libraries for your Python action,  you can include a virtualenv in the zip file of the action.



The requirement is that the zip file must have a subfolder named `virtualenv` with a script `virtualenv\bin\activate_this.py` working in an Linux AMD64 environment. It will be executed at start time to use your extra libraries.



### Using requirements.txt



Python virtual environments are typically built by installing dependencies listed in a `requirements.txt` file. If you have an action that requires additional libraries, you can include a `requirements.txt` file.



You have to create a folder `myaction` with at least two files:



```

__main__.py

requirements.txt

```



Then zip your action and deploy to OpenWhisk, the requirements will be installed for you at init time, creating a suitable virtualenv.



Keep in mind that resolving requirements involves downloading and install software, so your action timeout limit may need to be adjusted accordingly. Instead, you should consider using precompilation to resolve the requirements at build time.



### Precompilation of a virtualenv



The action containers can actually generate a virtualenv for you, provided you have a requirements.txt.



If you have an action in the format described before (with a `requirements.txt`) you can build the zip file with the included files with:



```

zip -j -r myaction | docker run -i action-python-v3.11 -compile main > myaction.zip

```



You may use `v3.11`, `v3.10`, or `v3.9` according to your Python version needs.



The resulting action includes a virtualenv already built for you and that is fast to deploy and start as all the dependencies are already resolved. Note that there is a limit on the size of the zip file and this approach will not work for installing large libraries like Pandas or Numpy, instead build a custom docker image that includes these libraries.