Download the PHP package open-runtimes/executor without Composer

Open Runtimes Executor 🤖

Executor for Open Runtimes, a runtime environments for serverless cloud computing for multiple coding languages.

Executor is responsible for providing HTTP API for creating and executing Open Runtimes. Executor is stateless and can be scaled horizontally when a load balancer is introduced in front of it. You could use any load balancer but we highly recommend using Open Runtimes Proxy for it's ease of setup with Open Runtimes Executor.

Features

• Flexibility - Configuring custom image lets you use any runtime for your functions.
• Performance - Coroutine-style HTTP servers allows asynchronous operations without blocking. We. Run. Fast! ⚡
• Open Source - Released under the MIT license, free to use and extend.

Getting Started

1. Pull Open Runtimes Executor image:

2. Create docker-compose.yml file:

Notice we added bind to local ./functions directory. That is only nessessary for this getting started, since we will be executing our custom function.

3. Create .env file:

OPR_EXECUTOR_CONNECTION_STORAGE takes a DSN string that represents a connection to your storage device. Every scheme but file and local requires a host. For example:

Storage	DSN
Local filesystem	file://localhost
AWS S3	s3://access_key:access_secret@bucket_name.s3.us-east-1.amazonaws.com?region=us-east-1
S3-compatible (MinIO, Garage, etc.)	s3://access_key:access_secret@minio:9000/bucket_name?region=us-east-1&insecure=true
S3-compatible, endpoint given outright	s3://access_key:access_secret@localhost/bucket_name?region=us-east-1&url=http%3A%2F%2Fminio%3A9000

The DSN resolves to an endpoint of scheme://host[:port][/bucket], and every object key hangs off it. insecure=true makes that scheme http, and the port is used as given. The bucket is the path of the DSN, and it reaches the endpoint exactly once: it is appended for path-style addressing, and left alone where the endpoint already names it, either as the leading label of the host (AWS S3, DigitalOcean Spaces, Backblaze, Linode and Wasabi all address their buckets that way) or as the path of a url. url replaces the scheme, host and port, so the last two rows above address the same object.

A DSN that cannot be parsed, or whose scheme has no device, is rejected rather than quietly falling back to the local filesystem. Ask for local storage with file:// or local://, or leave the variable empty.

For backwards compatibility, executor also supports OPR_EXECUTOR_STORAGE_* variables as replacement for OPR_EXECUTOR_CONNECTION_STORAGE, as seen in Appwrite repository.

4. Start Docker container:

5. Prepare a function we will ask executor to run:

This created my-function.tar.gz that includes index.php with a simple Open Runtimes script.

5. Send a HTTP request to executor server:

6. Stop Docker containers:

API Endpoints

/v1/runtimes/{runtimeId}/logs

/v1/runtimes

/v1/runtimes/{runtimeId}

/v1/runtimes/{runtimeId}/executions

Environment variables

Contributing

All code contributions - including those of people having commit access - must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the contribution guide.

Security

For security issues, kindly email us at [email protected] instead of posting a public issue on GitHub.

Follow Us

Join our growing community around the world! See our official Blog. Follow us on Twitter, Facebook Page, Facebook Group , Dev Community or join our live Discord server for more help, ideas, and discussions.

License

This repository is available under the MIT License.