From 0893020e4e988173768b9bd052b33ae3d28a793f Mon Sep 17 00:00:00 2001 From: Florent Huck Date: Tue, 15 Apr 2025 09:36:19 +0200 Subject: [PATCH 1/4] adding unit for --- .../app-reference/single-runtime-image.md | 16 ++++++++-------- sites/platform/src/languages/php/_index.md | 14 +++++++------- .../app-reference/single-runtime-image.md | 16 ++++++++-------- sites/upsun/src/languages/php/_index.md | 14 +++++++------- 4 files changed, 30 insertions(+), 30 deletions(-) diff --git a/sites/platform/src/create-apps/app-reference/single-runtime-image.md b/sites/platform/src/create-apps/app-reference/single-runtime-image.md index b3bfaf0f27..2798871c30 100644 --- a/sites/platform/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/platform/src/create-apps/app-reference/single-runtime-image.md @@ -1211,14 +1211,14 @@ Run the following command: The following table presents the various possible modifications to your PHP or Lisp runtime: -| Name | Type | Language | Description | -|-----------------------------|------------------------------------------------------------|----------|--------------------------------------------------------------------------------------------| -| `extensions` | List of `string`s OR [extensions definitions](#extensions) | PHP | [PHP extensions](/languages/php/extensions.md) to enable. | -| `disabled_extensions` | List of `string`s | PHP | [PHP extensions](/languages/php/extensions.md) to disable. | -| `request_terminate_timeout` | `integer` | PHP | The timeout for serving a single request after which the PHP-FPM worker process is killed. | -| `sizing_hints` | A [sizing hints definition](#sizing-hints) | PHP | The assumptions for setting the number of workers in your PHP-FPM runtime. | -| `xdebug` | An Xdebug definition | PHP | The setting to turn on [Xdebug](/languages/php/xdebug.md). | -| `quicklisp` | Distribution definitions | Lisp | [Distributions for QuickLisp](/languages/lisp.md#quicklisp-options) to use. | +| Name | Type | Language | Description | +|-----------------------------|------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------| +| `extensions` | List of `string`s OR [extensions definitions](#extensions) | PHP | [PHP extensions](/languages/php/extensions.md) to enable. | +| `disabled_extensions` | List of `string`s | PHP | [PHP extensions](/languages/php/extensions.md) to disable. | +| `request_terminate_timeout` | `integer` | PHP | The timeout (in seconds) for serving a single request after which the PHP-FPM worker process is killed. | +| `sizing_hints` | A [sizing hints definition](#sizing-hints) | PHP | The assumptions for setting the number of workers in your PHP-FPM runtime. | +| `xdebug` | An Xdebug definition | PHP | The setting to turn on [Xdebug](/languages/php/xdebug.md). | +| `quicklisp` | Distribution definitions | Lisp | [Distributions for QuickLisp](/languages/lisp.md#quicklisp-options) to use. | You can also set your [app's runtime timezone](/create-apps/timezone.md). diff --git a/sites/platform/src/languages/php/_index.md b/sites/platform/src/languages/php/_index.md index 670a51282c..1b18795566 100644 --- a/sites/platform/src/languages/php/_index.md +++ b/sites/platform/src/languages/php/_index.md @@ -617,13 +617,13 @@ The following table presents the possible modifications you can make to your PHP Each modification should be listed below the stack chosen (i.e. `extensions` are enabled under `.applications.frontend.stack[0]["php@8.3"].extensions` for PHP 8.3). See the example below for more details. -| Name | Type | Description | -|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| -| `extensions` | List of `string`s OR [extensions definitions](/create-apps/app-reference/composable-image.md#php-extensions-and-python-packages) | [PHP extensions](/languages/php/extensions.md) to enable. | -| `disabled_extensions` | List of `string`s | [PHP extensions](/languages/php/extensions.md) to disable. | -| `request_terminate_timeout` | `integer` | The timeout for serving a single request after which the PHP-FPM worker process is killed. | -| `sizing_hints` | A [sizing hints definition](/create-apps/app-reference/composable-image.md#sizing-hints) | The assumptions for setting the number of workers in your PHP-FPM runtime. | -| `xdebug` | An Xdebug definition | The setting to turn on [Xdebug](/languages/php/xdebug.md). | +| Name | Type | Description | +|-----------------------------|----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| +| `extensions` | List of `string`s OR [extensions definitions](/create-apps/app-reference/composable-image.md#php-extensions-and-python-packages) | [PHP extensions](/languages/php/extensions.md) to enable. | +| `disabled_extensions` | List of `string`s | [PHP extensions](/languages/php/extensions.md) to disable. | +| `request_terminate_timeout` | `integer` | The timeout (in seconds) for serving a single request after which the PHP-FPM worker process is killed. | +| `sizing_hints` | A [sizing hints definition](/create-apps/app-reference/composable-image.md#sizing-hints) | The assumptions for setting the number of workers in your PHP-FPM runtime. | +| `xdebug` | An Xdebug definition | The setting to turn on [Xdebug](/languages/php/xdebug.md). | Here is an example configuration: diff --git a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md index 97993cdbe1..b6a567e785 100644 --- a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md @@ -1332,14 +1332,14 @@ Run the following command: The following table presents the various possible modifications to your PHP or Lisp runtime: -| Name | Type | Language | Description | -|-----------------------------|------------------------------------------------------------|----------|--------------------------------------------------------------------------------------------| -| `extensions` | List of `string`s OR [extensions definitions](#extensions) | PHP | [PHP extensions](/languages/php/extensions.md) to enable. | -| `disabled_extensions` | List of `string`s | PHP | [PHP extensions](/languages/php/extensions.md) to disable. | -| `request_terminate_timeout` | `integer` | PHP | The timeout for serving a single request after which the PHP-FPM worker process is killed. | -| `sizing_hints` | A [sizing hints definition](#sizing-hints) | PHP | The assumptions for setting the number of workers in your PHP-FPM runtime. | -| `xdebug` | An Xdebug definition | PHP | The setting to turn on [Xdebug](/languages/php/xdebug.md). | -| `quicklisp` | Distribution definitions | Lisp | [Distributions for QuickLisp](/languages/lisp.md#quicklisp-options) to use. | +| Name | Type | Language | Description | +|-----------------------------|------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------| +| `extensions` | List of `string`s OR [extensions definitions](#extensions) | PHP | [PHP extensions](/languages/php/extensions.md) to enable. | +| `disabled_extensions` | List of `string`s | PHP | [PHP extensions](/languages/php/extensions.md) to disable. | +| `request_terminate_timeout` | `integer` | PHP | The timeout (in seconds) for serving a single request after which the PHP-FPM worker process is killed. | +| `sizing_hints` | A [sizing hints definition](#sizing-hints) | PHP | The assumptions for setting the number of workers in your PHP-FPM runtime. | +| `xdebug` | An Xdebug definition | PHP | The setting to turn on [Xdebug](/languages/php/xdebug.md). | +| `quicklisp` | Distribution definitions | Lisp | [Distributions for QuickLisp](/languages/lisp.md#quicklisp-options) to use. | You can also set your [app's runtime timezone](/create-apps/timezone.md). diff --git a/sites/upsun/src/languages/php/_index.md b/sites/upsun/src/languages/php/_index.md index 3cf708eee6..6d7a87195e 100644 --- a/sites/upsun/src/languages/php/_index.md +++ b/sites/upsun/src/languages/php/_index.md @@ -642,13 +642,13 @@ The following table presents the possible modifications you can make to your PHP Each modification should be listed below the stack chosen (i.e. `extensions` are enabled under `.applications.frontend.stack[0]["php@8.3"].extensions` for PHP 8.3). See the example below for more details. -| Name | Type | Description | -|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| -| `extensions` | List of `string`s OR [extensions definitions](/create-apps/app-reference/composable-image#php-extensions-and-python-packages) | [PHP extensions](/languages/php/extensions.md) to enable. | -| `disabled_extensions` | List of `string`s | [PHP extensions](/languages/php/extensions.md) to disable. | -| `request_terminate_timeout` | `integer` | The timeout for serving a single request after which the PHP-FPM worker process is killed. | -| `sizing_hints` | A [sizing hints definition](/create-apps/app-reference/composable-image.md#sizing-hints) | The assumptions for setting the number of workers in your PHP-FPM runtime. | -| `xdebug` | An Xdebug definition | The setting to turn on [Xdebug](/languages/php/xdebug.md). | +| Name | Type | Description | +|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| +| `extensions` | List of `string`s OR [extensions definitions](/create-apps/app-reference/composable-image#php-extensions-and-python-packages) | [PHP extensions](/languages/php/extensions.md) to enable. | +| `disabled_extensions` | List of `string`s | [PHP extensions](/languages/php/extensions.md) to disable. | +| `request_terminate_timeout` | `integer` | The timeout (in seconds) for serving a single request after which the PHP-FPM worker process is killed. | +| `sizing_hints` | A [sizing hints definition](/create-apps/app-reference/composable-image.md#sizing-hints) | The assumptions for setting the number of workers in your PHP-FPM runtime. | +| `xdebug` | An Xdebug definition | The setting to turn on [Xdebug](/languages/php/xdebug.md). | Here is an example configuration: From 028a86165763bac42c74bc653efe1f12a1fa4145 Mon Sep 17 00:00:00 2001 From: Florent Huck Date: Tue, 15 Apr 2025 10:31:58 +0200 Subject: [PATCH 2/4] adding (Runtime Operations) to the top-level properties --- .../app-reference/composable-image.md | 38 ++++++++-------- .../app-reference/single-runtime-image.md | 44 +++++++++---------- .../app-reference/composable-image.md | 31 ++++++------- .../app-reference/single-runtime-image.md | 37 ++++++++-------- 4 files changed, 77 insertions(+), 73 deletions(-) diff --git a/sites/platform/src/create-apps/app-reference/composable-image.md b/sites/platform/src/create-apps/app-reference/composable-image.md index cd787ba4d1..8564bb7069 100644 --- a/sites/platform/src/create-apps/app-reference/composable-image.md +++ b/sites/platform/src/create-apps/app-reference/composable-image.md @@ -37,24 +37,26 @@ The following table presents all the properties you can use at the top level of The column _Set in instance?_ defines whether the given property can be overridden within a `web` or `workers` instance. To override any part of a property, you have to provide the entire property. -| Name | Type | Required | Set in instance? | Description | -|--------------------|-----------------------------------------------------|----------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `name` | `string` | Yes | No | A unique name for the app. Must be lowercase alphanumeric characters. Changing the name destroys data associated with the app. | -| `stack` | An array of [Nix packages](#stack) | Yes | No | A list of packages from the {{% vendor/name %}} collection of [supported runtimes](#supported-nix-packages) and/or from [Nixpkgs](https://search.nixos.org/packages). | -| `size` | A [size](#sizes) | | Yes | How much resources to devote to the app. Defaults to `AUTO` in production environments. | -| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | -| `disk` | `integer` or `null` | | Yes | The size of the disk space for the app in [MB](/glossary/_index.md#mb). Minimum value is `128`. Defaults to `null`, meaning no disk is available. See [note on available space](#available-disk-space) | -| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. If set as a local source, `disk` is required. | -| `web` | A [web instance](#web) | | N/A | How the web application is served. | -| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | -| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](/create-apps/timezone.md) | -| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | -| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | -| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | -| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | -| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | -| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | -| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| Name | Type | Required | Set in instance? | Description | +|--------------------|--------------------------------------------------------------------------|----------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `name` | `string` | Yes | No | A unique name for the app. Must be lowercase alphanumeric characters. Changing the name destroys data associated with the app. | +| `stack` | An array of [Nix packages](#stack) | Yes | No | A list of packages from the {{% vendor/name %}} collection of [supported runtimes](#supported-nix-packages) and/or from [Nixpkgs](https://search.nixos.org/packages). | +| `size` | A [size](#sizes) | | Yes | How much resources to devote to the app. Defaults to `AUTO` in production environments. | +| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | +| `disk` | `integer` or `null` | | Yes | The size of the disk space for the app in [MB](/glossary/_index.md#mb). Minimum value is `128`. Defaults to `null`, meaning no disk is available. See [note on available space](#available-disk-space) | +| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. If set as a local source, `disk` is required. | +| `web` | A [web instance](#web) | | N/A | How the web application is served. | +| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | +| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](/create-apps/timezone.md) | +| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | +| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | +| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | +| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | +| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | +| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | +| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | Yes | Runtime operations for the application. | + {{% note %}} The ``type``, ``build``, ``dependencies``, and ``runtime`` keys are only supported when using a [single-runtime image](/create-apps/app-reference/single-runtime-image.md). They are **not** supported when using the composable image. diff --git a/sites/platform/src/create-apps/app-reference/single-runtime-image.md b/sites/platform/src/create-apps/app-reference/single-runtime-image.md index 2798871c30..7be857d969 100644 --- a/sites/platform/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/platform/src/create-apps/app-reference/single-runtime-image.md @@ -24,28 +24,28 @@ The following table presents all properties available at the top level of the YA The column _Set in instance?_ defines whether the given property can be overridden within a `web` or `workers` instance. To override any part of a property, you have to provide the entire property. - -| Name | Type | Required | Set in instance? | Description | -| ------------------ | --------------------------------------------------- | -------- | ---------------- |----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `name` | `string` | Yes | No | A unique name for the app. Must be lowercase alphanumeric characters. Changing the name destroys data associated with the app. | -| `type` | A [type](#types) | Yes | No | The base image to use with a specific app language. Format: `runtime:version`. | -| `size` | A [size](#sizes) | | Yes | How much resources to devote to the app. Defaults to `AUTO` in production environments. | -| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | -| `disk` | `integer` or `null` | | Yes | The size of the disk space for the app in [MB](/glossary/_index.md#mb). Minimum value is `128`. Defaults to `null`, meaning no disk is available. See [note on available space](#available-disk-space) | -| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. If set as a local source, `disk` is required. | -| `web` | A [web instance](#web) | | N/A | How the web application is served. | -| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | -| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](/create-apps/timezone.md) | -| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | -| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | -| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | -| `build` | A [build dictionary](#build) | | No | What happens when the app is built. | -| `dependencies` | A [dependencies dictionary](#dependencies) | | No | What global dependencies to install before the `build` hook is run. | -| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | -| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | -| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | -| `runtime` | A [runtime dictionary](#runtime) | | No | Customizations to your PHP or Lisp runtime. | -| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| Name | Type | Required | Set in instance? | Description | +|--------------------|--------------------------------------------------------------------------|----------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `name` | `string` | Yes | No | A unique name for the app. Must be lowercase alphanumeric characters. Changing the name destroys data associated with the app. | +| `type` | A [type](#types) | Yes | No | The base image to use with a specific app language. Format: `runtime:version`. | +| `size` | A [size](#sizes) | | Yes | How much resources to devote to the app. Defaults to `AUTO` in production environments. | +| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | +| `disk` | `integer` or `null` | | Yes | The size of the disk space for the app in [MB](/glossary/_index.md#mb). Minimum value is `128`. Defaults to `null`, meaning no disk is available. See [note on available space](#available-disk-space) | +| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. If set as a local source, `disk` is required. | +| `web` | A [web instance](#web) | | N/A | How the web application is served. | +| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | +| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](/create-apps/timezone.md) | +| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | +| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | +| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | +| `build` | A [build dictionary](#build) | | No | What happens when the app is built. | +| `dependencies` | A [dependencies dictionary](#dependencies) | | No | What global dependencies to install before the `build` hook is run. | +| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | +| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | +| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | +| `runtime` | A [runtime dictionary](#runtime) | | No | Customizations to your PHP or Lisp runtime. | +| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | Yes | Runtime operations for the application. | ## Root directory diff --git a/sites/upsun/src/create-apps/app-reference/composable-image.md b/sites/upsun/src/create-apps/app-reference/composable-image.md index 60213ce871..2545c63f06 100644 --- a/sites/upsun/src/create-apps/app-reference/composable-image.md +++ b/sites/upsun/src/create-apps/app-reference/composable-image.md @@ -58,21 +58,22 @@ above). The column _Set in instance?_ defines whether the given property can be overridden within a `web` or `workers` instance. To override any part of a property, you have to provide the entire property. -| Name | Type | Required | Set in instance? | Description | -|--------------------|-----------------------------------------------------|----------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `stack` | An array of [Nix packages](#stack) | Yes | No | A list of packages from the {{% vendor/name %}} collection of [supported runtimes](#supported-nix-packages) and/or from [NixPkgs](https://search.nixos.org/packages). | -| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | -| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. Allocated disk for mounts is defined with a separate resource configuration call using `{{% vendor/cli %}} resources:set`. | -| `web` | A [web instance](#web) | | N/A | How the web application is served. | -| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | -| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](../timezone.md) | -| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | -| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | -| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | -| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | -| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | -| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | -| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| Name | Type | Required | Set in instance? | Description | +|--------------------|--------------------------------------------------------------------------|----------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `stack` | An array of [Nix packages](#stack) | Yes | No | A list of packages from the {{% vendor/name %}} collection of [supported runtimes](#supported-nix-packages) and/or from [NixPkgs](https://search.nixos.org/packages). | +| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | +| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. Allocated disk for mounts is defined with a separate resource configuration call using `{{% vendor/cli %}} resources:set`. | +| `web` | A [web instance](#web) | | N/A | How the web application is served. | +| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | +| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](../timezone.md) | +| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | +| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | +| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | +| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | +| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | +| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | +| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | Yes | Runtime operations for the application. | {{% note %}} The ``type``, ``build``, ``dependencies``, and ``runtime`` keys are only supported when using a [single-runtime image](/create-apps/app-reference/single-runtime-image.md). diff --git a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md index b6a567e785..487baa7452 100644 --- a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md @@ -37,24 +37,25 @@ and `backend` above). The column _Set in instance?_ defines whether the given property can be overridden within a `web` or `workers` instance. To override any part of a property, you have to provide the entire property. -| Name | Type | Required | Set in instance? | Description | -|--------------------|-----------------------------------------------------|----------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | A [type](#types) | Yes | No | The base image to use with a specific app language. Format: `runtime:version`. | -| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | -| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. Allocated disk for mounts is defined with a separate resource configuration call using `{{% vendor/cli %}} resources:set`. | -| `web` | A [web instance](#web) | | N/A | How the web application is served. | -| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | -| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](../timezone.md) | -| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | -| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | -| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | -| `build` | A [build dictionary](#build) | | No | What happens when the app is built. | -| `dependencies` | A [dependencies dictionary](#dependencies) | | No | What global dependencies to install before the `build` hook is run. | -| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | -| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | -| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | -| `runtime` | A [runtime dictionary](#runtime) | | No | Customizations to your PHP or Lisp runtime. | -| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| Name | Type | Required | Set in instance? | Description | +|--------------------|--------------------------------------------------------------------------|----------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `type` | A [type](#types) | Yes | No | The base image to use with a specific app language. Format: `runtime:version`. | +| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | +| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. Allocated disk for mounts is defined with a separate resource configuration call using `{{% vendor/cli %}} resources:set`. | +| `web` | A [web instance](#web) | | N/A | How the web application is served. | +| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | +| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](../timezone.md) | +| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | +| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | +| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | +| `build` | A [build dictionary](#build) | | No | What happens when the app is built. | +| `dependencies` | A [dependencies dictionary](#dependencies) | | No | What global dependencies to install before the `build` hook is run. | +| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | +| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | +| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | +| `runtime` | A [runtime dictionary](#runtime) | | No | Customizations to your PHP or Lisp runtime. | +| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | Yes | Runtime operations for the application. | ## Root directory From c3b1bbd8f5b67a88734c52a202aef5e0062f009d Mon Sep 17 00:00:00 2001 From: Florent Huck Date: Tue, 15 Apr 2025 10:46:07 +0200 Subject: [PATCH 3/4] adding top level key on Upsun --- .../app-reference/composable-image.md | 2 +- .../app-reference/single-runtime-image.md | 2 +- .../app-reference/composable-image.md | 33 ++++++++-------- .../app-reference/single-runtime-image.md | 39 ++++++++++--------- 4 files changed, 39 insertions(+), 37 deletions(-) diff --git a/sites/platform/src/create-apps/app-reference/composable-image.md b/sites/platform/src/create-apps/app-reference/composable-image.md index 8564bb7069..99e3288cf0 100644 --- a/sites/platform/src/create-apps/app-reference/composable-image.md +++ b/sites/platform/src/create-apps/app-reference/composable-image.md @@ -55,7 +55,7 @@ To override any part of a property, you have to provide the entire property. | `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | | `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | | `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | -| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | Yes | Runtime operations for the application. | +| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | No | Runtime operations for the application. | {{% note %}} The ``type``, ``build``, ``dependencies``, and ``runtime`` keys are only supported when using a [single-runtime image](/create-apps/app-reference/single-runtime-image.md). diff --git a/sites/platform/src/create-apps/app-reference/single-runtime-image.md b/sites/platform/src/create-apps/app-reference/single-runtime-image.md index 7be857d969..6bcbffbf10 100644 --- a/sites/platform/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/platform/src/create-apps/app-reference/single-runtime-image.md @@ -45,7 +45,7 @@ To override any part of a property, you have to provide the entire property. | `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | | `runtime` | A [runtime dictionary](#runtime) | | No | Customizations to your PHP or Lisp runtime. | | `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | -| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | Yes | Runtime operations for the application. | +| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | No | Runtime operations for the application. | ## Root directory diff --git a/sites/upsun/src/create-apps/app-reference/composable-image.md b/sites/upsun/src/create-apps/app-reference/composable-image.md index 2545c63f06..af4beb44eb 100644 --- a/sites/upsun/src/create-apps/app-reference/composable-image.md +++ b/sites/upsun/src/create-apps/app-reference/composable-image.md @@ -58,22 +58,23 @@ above). The column _Set in instance?_ defines whether the given property can be overridden within a `web` or `workers` instance. To override any part of a property, you have to provide the entire property. -| Name | Type | Required | Set in instance? | Description | -|--------------------|--------------------------------------------------------------------------|----------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `stack` | An array of [Nix packages](#stack) | Yes | No | A list of packages from the {{% vendor/name %}} collection of [supported runtimes](#supported-nix-packages) and/or from [NixPkgs](https://search.nixos.org/packages). | -| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | -| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. Allocated disk for mounts is defined with a separate resource configuration call using `{{% vendor/cli %}} resources:set`. | -| `web` | A [web instance](#web) | | N/A | How the web application is served. | -| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | -| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](../timezone.md) | -| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | -| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | -| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | -| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | -| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | -| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | -| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | -| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | Yes | Runtime operations for the application. | +| Name | Type | Required | Set in instance? | Description | +|----------------------|------------------------------------------------------------------------------------------|----------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `stack` | An array of [Nix packages](#stack) | Yes | No | A list of packages from the {{% vendor/name %}} collection of [supported runtimes](#supported-nix-packages) and/or from [NixPkgs](https://search.nixos.org/packages). | +| `container_profile` | A [container profile](/manage-resources/adjust-resources.md#advanced-container-profiles) | | Yes | Container profile of the application. | +| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | +| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. Allocated disk for mounts is defined with a separate resource configuration call using `{{% vendor/cli %}} resources:set`. | +| `web` | A [web instance](#web) | | N/A | How the web application is served. | +| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | +| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](../timezone.md) | +| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | +| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | +| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | +| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | +| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | +| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | +| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | No | Runtime operations for the application. | {{% note %}} The ``type``, ``build``, ``dependencies``, and ``runtime`` keys are only supported when using a [single-runtime image](/create-apps/app-reference/single-runtime-image.md). diff --git a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md index 487baa7452..e0c50370c1 100644 --- a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md @@ -37,25 +37,26 @@ and `backend` above). The column _Set in instance?_ defines whether the given property can be overridden within a `web` or `workers` instance. To override any part of a property, you have to provide the entire property. -| Name | Type | Required | Set in instance? | Description | -|--------------------|--------------------------------------------------------------------------|----------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `type` | A [type](#types) | Yes | No | The base image to use with a specific app language. Format: `runtime:version`. | -| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | -| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. Allocated disk for mounts is defined with a separate resource configuration call using `{{% vendor/cli %}} resources:set`. | -| `web` | A [web instance](#web) | | N/A | How the web application is served. | -| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | -| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](../timezone.md) | -| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | -| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | -| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | -| `build` | A [build dictionary](#build) | | No | What happens when the app is built. | -| `dependencies` | A [dependencies dictionary](#dependencies) | | No | What global dependencies to install before the `build` hook is run. | -| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | -| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | -| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | -| `runtime` | A [runtime dictionary](#runtime) | | No | Customizations to your PHP or Lisp runtime. | -| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | -| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | Yes | Runtime operations for the application. | +| Name | Type | Required | Set in instance? | Description | +|---------------------|--------------------------------------------------------------------------------------------|----------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `type` | A [type](#types) | Yes | No | The base image to use with a specific app language. Format: `runtime:version`. | +| `container_profile` | A [container profile](/manage-resources/adjust-resources.md#advanced-container-profiles) | | Yes | Container profile of the application. | +| `relationships` | A dictionary of [relationships](#relationships) | | Yes | Connections to other services and apps. | +| `mounts` | A dictionary of [mounts](#mounts) | | Yes | Directories that are writable even after the app is built. Allocated disk for mounts is defined with a separate resource configuration call using `{{% vendor/cli %}} resources:set`. | +| `web` | A [web instance](#web) | | N/A | How the web application is served. | +| `workers` | A [worker instance](#workers) | | N/A | Alternate copies of the application to run as background processes. | +| `timezone` | `string` | | No | The timezone for crons to run. Format: a [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Defaults to `UTC`, which is the timezone used for all logs no matter the value here. See also [app runtime timezones](../timezone.md) | +| `access` | An [access dictionary](#access) | | Yes | Access control for roles accessing app environments. | +| `variables` | A [variables dictionary](#variables) | | Yes | Variables to control the environment. | +| `firewall` | A [firewall dictionary](#firewall) | | Yes | Outbound firewall rules for the application. | +| `build` | A [build dictionary](#build) | | No | What happens when the app is built. | +| `dependencies` | A [dependencies dictionary](#dependencies) | | No | What global dependencies to install before the `build` hook is run. | +| `hooks` | A [hooks dictionary](#hooks) | | No | What commands run at different stages in the build and deploy process. | +| `crons` | A [cron dictionary](#crons) | | No | Scheduled tasks for the app. | +| `source` | A [source dictionary](#source) | | No | Information on the app's source code and operations that can be run on it. | +| `runtime` | A [runtime dictionary](#runtime) | | No | Customizations to your PHP or Lisp runtime. | +| `additional_hosts` | An [additional hosts dictionary](#additional-hosts) | | Yes | Maps of hostnames to IP addresses. | +| `operations` | A [dictionary of Runtime operations](/create-apps/runtime-operations.md) | | No | Runtime operations for the application. | ## Root directory From 80f06bee7f41cd5d4519ff6f891750f0c1fbf63c Mon Sep 17 00:00:00 2001 From: Florent Huck Date: Tue, 15 Apr 2025 10:53:14 +0200 Subject: [PATCH 4/4] adding rules in the list of exception for possible rules properties --- .../src/create-apps/app-reference/composable-image.md | 4 ++-- .../src/create-apps/app-reference/single-runtime-image.md | 4 ++-- sites/upsun/src/create-apps/app-reference/composable-image.md | 4 ++-- .../src/create-apps/app-reference/single-runtime-image.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/sites/platform/src/create-apps/app-reference/composable-image.md b/sites/platform/src/create-apps/app-reference/composable-image.md index 99e3288cf0..c168e20a5f 100644 --- a/sites/platform/src/create-apps/app-reference/composable-image.md +++ b/sites/platform/src/create-apps/app-reference/composable-image.md @@ -829,8 +829,8 @@ The key of each item is a regular expression to match paths exactly. If an incoming request matches the rule, it's handled by the properties under the rule, overriding any conflicting rules from the rest of the `locations` dictionary. -Under `rules`, you can set all of the other possible [`locations` properties](#locations) -except `root`, `index` and `request_buffering`. +Under `rules`, you can set all the other possible [`locations` properties](#locations) +except `root`, `index`, `rules` and `request_buffering`. In the following example, the `allow` key disallows requests for static files anywhere in the site. This is overridden by a rule that explicitly allows common image file formats. diff --git a/sites/platform/src/create-apps/app-reference/single-runtime-image.md b/sites/platform/src/create-apps/app-reference/single-runtime-image.md index 6bcbffbf10..150a5bd1f5 100644 --- a/sites/platform/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/platform/src/create-apps/app-reference/single-runtime-image.md @@ -647,8 +647,8 @@ The key of each item is a regular expression to match paths exactly. If an incoming request matches the rule, it's handled by the properties under the rule, overriding any conflicting rules from the rest of the `locations` dictionary. -Under `rules`, you can set all of the other possible [`locations` properties](#locations) -except `root`, `index` and `request_buffering`. +Under `rules`, you can set all the other possible [`locations` properties](#locations) +except `root`, `index`, `rules` and `request_buffering`. In the following example, the `allow` key disallows requests for static files anywhere in the site. This is overridden by a rule that explicitly allows common image file formats. diff --git a/sites/upsun/src/create-apps/app-reference/composable-image.md b/sites/upsun/src/create-apps/app-reference/composable-image.md index af4beb44eb..6edcd118e4 100644 --- a/sites/upsun/src/create-apps/app-reference/composable-image.md +++ b/sites/upsun/src/create-apps/app-reference/composable-image.md @@ -907,8 +907,8 @@ The key of each item is a regular expression to match paths exactly. If an incoming request matches the rule, it's handled by the properties under the rule, overriding any conflicting rules from the rest of the `locations` dictionary. -Under `rules`, you can set all of the other possible [`locations` properties](#locations) -except `root`, `index` and `request_buffering`. +Under `rules`, you can set all the other possible [`locations` properties](#locations) +except `root`, `index`, `rules` and `request_buffering`. In the following example, the `allow` key disallows requests for static files anywhere in the site. This is overridden by a rule that explicitly allows common image file formats. diff --git a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md index e0c50370c1..92026b5f1d 100644 --- a/sites/upsun/src/create-apps/app-reference/single-runtime-image.md +++ b/sites/upsun/src/create-apps/app-reference/single-runtime-image.md @@ -719,8 +719,8 @@ The key of each item is a regular expression to match paths exactly. If an incoming request matches the rule, it's handled by the properties under the rule, overriding any conflicting rules from the rest of the `locations` dictionary. -Under `rules`, you can set all of the other possible [`locations` properties](#locations) -except `root`, `index` and `request_buffering`. +Under `rules`, you can set all the other possible [`locations` properties](#locations) +except `root`, `index`, `rules` and `request_buffering`. In the following example, the `allow` key disallows requests for static files anywhere in the site. This is overridden by a rule that explicitly allows common image file formats.