Appwrite Runtimes
Appwrite repository for Cloud Function runtimes that contains the configurations and tests for all of the Appwrite runtime environments. This library is maintained by the Appwrite team.
Getting Started
Install using composer:
composer require appwrite/php-runtimes
<?php
require_once '../vendor/autoload.php';
use Appwrite\Runtimes\Runtimes;
$runtimes = new Runtime();
// returns all supported cloud function runtimes
Runtimes::getAll();
Adding a new Runtime
1. Docker
The first thing to do is to create a Dockerfile under runtimes/.
Important features for a base image are small sizes (Alpine preferred), multi-architecture (x86, ARM, PPC) and active maintenance.
Example for a Dockerfile looks like this:
# Base image
FROM mcr.microsoft.com/dotnet/runtime:5.0-alpine
# Maintainer label
LABEL maintainer="[email protected]"
# Add tar (required for uncompressing functions)
RUN apk add tar
# Set working directory to /usr/local/src/
WORKDIR /usr/local/src/
After that the build command must be added to the build.sh script.
2. Add Runtime
After the Docker image is created, this must be added to the main class of this library.
References to this must be added to the constructor of src/Runtimes/Runtimes.php.
Example:
$dotnet = new Runtime('dotnet', '.NET');
$dotnet->addVersion('5.0', 'mcr.microsoft.com/dotnet/runtime:5.0-alpine', 'appwrite/env-dotnet-5.0:1.0.0', [System::X86, System::ARM]);
$runtimes[] = $dotnet;
3. Add Tests
First of all, a script for the runtime environment must be created. Plenty of examples can be found under tests/resources.
After that start options must be added to the setUp() method found in tests/Runtimes/RuntimesTest.php.
Authors
Torsten Dittmann
Copyright and license
BSD 3-Clause License https://opensource.org/licenses/BSD-3-Clause
5 Jan 25, 2022
493 Dec 16, 2022
804 Dec 19, 2022
135 Dec 29, 2022
0 Jul 15, 2022
21 Nov 30, 2022
4 Oct 16, 2021
1 Oct 15, 2021
10 Jan 5, 2023
55.9k Dec 31, 2022
907 Jan 8, 2023
81 Apr 5, 2022
7.1k Dec 23, 2022
142 Dec 25, 2022
304 Jan 6, 2023
22 Nov 24, 2022
4 Jan 9, 2022
11 Sep 9, 2022
5 Dec 14, 2022