-
- hostname
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | hostname |
+
+ The unique service identifier.
+
+ The hostname of the new database will be set to the `hostname` value.
+
+ Limitations:
+
- duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
+
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
|
-
- The unique service identifier.
The hostname of the new database will be set to the `hostname` value.
Limitations:
- duplicate services with the same name in the same project are forbidden
- - maximum 25 characters
- - must contain only lowercase ASCII letters (a-z) or numbers (0-9)
- |
-
-
+
- | type |
- Specifies the service type `java` and version.
Set type: `java@<version>` or `java@latest`
Limitations:
Following Java major versions are currently supported: 1.22 |
+ type |
+
+ Specifies the service type `java` and version.
+
+ Set type: `java@` or `java@latest`
+
+ Limitations:
+
+ Following Java major versions are currently supported: 1.22
+ |
-
-{" "}
-
-
- |
- verticalAutoscaling
- |
-
- Optional. Defines{' '}
-
- custom vertical auto scaling parameters
-
- .
- All verticalAutoscaling attributes are optional. Not specified attributes
- will be set to their default values.
- |
-
-
- |
- - cpuMode
- |
-
- Optional. Accepts `SHARED`, `DEDICATED` values.
- Default is `SHARED`
- |
-
-
- |
- - minCpu/maxCpu
- |
-
- Optional. Set the minCpu or maxCpu in CPU cores (integer).
- |
-
-
- |
- - minRam/maxRam
- |
-
- Optional. Set the minRam or maxRam in GB (float).
- |
-
-
- |
- - minDisk/maxDisk
- |
-
- Optional. Set the minDisk or maxDisk in GB (float).
- |
-
-
-{" "}
-
-
- |
- minContainers
- |
-
- Defines the minimum number of containers for{' '}
-
- horizontal autoscaling
-
- .
-
- Limitations:
-
- Current maximum value = 6.
- |
-
-
-{" "}
-
-
- |
- maxContainers
- |
-
- Optional. Default = 1. Defines the maximum number of containers for{' '}
-
- horizontal autoscaling
-
- .
-
- Limitations:
-
- Current maximum value = 6.
- |
-
-
-
- | envSecrets |
- Optional. Defines one or more secret env variables as a key value map. See env variable restrictions. |
-
-
+
+ | verticalAutoscaling |
+
+ Optional. Defines custom vertical auto scaling parameters.
+
+ All verticalAutoscaling attributes are optional. Not specified attributes will be set to their default values.
+ |
+
+
+ | - cpuMode |
+
+ Optional. Accepts `SHARED`, `DEDICATED` values. Default is `SHARED`
+ |
+
+
+ | - minCpu/maxCpu |
+
+ Optional. Set the minCpu or maxCpu in CPU cores (integer).
+ |
+
+
+ | - minRam/maxRam |
+
+ Optional. Set the minRam or maxRam in GB (float).
+ |
+
+
+ | - minDisk/maxDisk |
+
+ Optional. Set the minDisk or maxDisk in GB (float).
+ |
+
+
+ | minContainers |
+
+ Optional. Default = 1. Defines the minimum number of containers for horizontal autoscaling.
+
+ Limitations:
+
+ Current maximum value = 6.
+ |
+
+
+ | maxContainers |
+
+ Defines the maximum number of containers for horizontal autoscaling.
+
+ Limitations:
+
+ Current maximum value = 6.
+ |
+
+
+ | envSecrets |
+
+ Optional. Defines one or more secret env variables as a key value map. See env variable restrictions.
+ |
+
+
### Create a project based on the description.yml
diff --git a/apps/docs/content/java/how-to/env-variables.mdx b/apps/docs/content/java/how-to/env-variables.mdx
index 522c0f08..8b69837d 100644
--- a/apps/docs/content/java/how-to/env-variables.mdx
+++ b/apps/docs/content/java/how-to/env-variables.mdx
@@ -11,11 +11,33 @@ In Zerops you do not have to create a `.env` file manually. Zerops handles the e
There are 3 different sets of env variables in Zerops:
-| environment | type | defined in |
-| ----------- | ------ | ------------------------------------------------------------------------------- |
-| build | basic | [zerops.yml](/java/how-to/build-pipeline#envvariables) |
-| runtime | basic | [zerops.yml](/java/how-to/build-pipeline#envvariables-1) |
-| runtime | secret | [Zerops GUI](/java/how-to/env-variables#set-secret-env-variables-in-zerops-gui) |
+
+
+
+ | Type |
+ Environment |
+ Defined in |
+
+
+
+
+ | basic |
+ build |
+ zerops.yml |
+
+
+ | basic |
+ runtime |
+ zerops.yml |
+
+
+ | secret |
+ runtime |
+ Zerops GUI |
+
+
+
+
Use the [secret env variables](/java/how-to/create#set-secret-env-variables) for all sensitive data you don't want to store in your application code. Secret env variables are also useful if you need for testing where you need to change the value of some env variables frequently. Secret variables are managed in Zerops GUI and you don't have to redeploy your application.
diff --git a/apps/docs/content/java/how-to/scaling.mdx b/apps/docs/content/java/how-to/scaling.mdx
index 19015391..1580a4a0 100644
--- a/apps/docs/content/java/how-to/scaling.mdx
+++ b/apps/docs/content/java/how-to/scaling.mdx
@@ -66,11 +66,33 @@ The CPU mode doesn't change automatically.
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
Java service always starts with the minimal resources.
diff --git a/apps/docs/content/keydb/how-to/create.mdx b/apps/docs/content/keydb/how-to/create.mdx
index dfa00be2..84a70f17 100644
--- a/apps/docs/content/keydb/how-to/create.mdx
+++ b/apps/docs/content/keydb/how-to/create.mdx
@@ -11,9 +11,26 @@ First, set up a project in Zerops GUI. Then go to the project dashboard page and
**// TODO screenshot (add a new service page)**
-| Parameter | Description | Limitations |
-| ------------ | --------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **hostname** | A unique service identifier like `keydb`, `db` etc. | - duplicate services with the same name in the same project are forbidden
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9) |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | hostname |
+ A unique service identifier like `keydb`, `db` etc. |
+
+
- duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
+
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
+ |
+
+
+
:::caution
The hostname is fixed after the service is created. It can't be changed later.
@@ -81,11 +98,33 @@ Choose the CPU mode when starting a new service or change it later. The CPU mode
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
For most cases, the default parameters will work without issues. If you need to limit the cost of the KeyDB service, lower the maximal resources. Zerops will never scale above the selected maximums.
@@ -189,136 +228,117 @@ The hostname of the second service will be set to `keydb2`. The [single containe
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | |
-| **description** | **Optional.** Description of the new project. | Maximum 255 characters. |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ |
+
+
+ | description |
+ Optional. Description of the new project. |
+ Maximum 255 characters. |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
+
At least one service in `services:` section is required. You can create a project with multiple services. The example above contains only KeyDB services but you can create a `description.yml` with [different types] of services.
-
+
- | Parameter |
- Description |
+ Parameter |
+ Description |
- |
- hostname
- |
-
+ | hostname |
+
The unique service identifier.
-
-
- The hostname of the new database will be set to the{' '}
- `hostname` value.
-
- Limitations:
-
- duplicate services with the same name in the same project are
- forbidden
-
- - maximum 25 characters
+
+ The hostname of the new database will be set to the `hostname` value.
+
+ Limitations:
+
- duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
|
- |
- type
- |
-
+ | type |
+
Specifies the service type `keydb` and version.
- Set type:{' '}
- `
- keydb@XXX
- `
- |
-
- Currently only KeyDB XXX is available.
+ Set type: `keydb@6`
+
+ Limitations:
+
+ Currently only KeyDB 6 is available.
|
- |
- mode
- |
-
+ | mode |
+
Defines the operation mode of KeyDB service.
+
+ HA
+ Creates a KeyDB cluster with 2 database containers. This mode is suited for production.
+
+ Zerops always keeps the 2 database containers on different physical machines. All your data is stored redundantly in 2 identical copies. In case of a failure of a container or the underlying physical machine, Zerops automatically disconnects the failed container from the cluster, creates a new container and syncs all data from the remaining copy. Finally the broken container is automatically deleted.
+
+ NON_HA
- HA
-
- Creates a KeyDB cluster with 2 database containers. This mode is suited
- for production.
-
-
- Zerops always keeps the 2 database containers on different physical
- machines. All your data is stored redundantly in 2 identical copies. In
- case of a failure of a container or the underlying physical machine,
- Zerops automatically disconnects the failed container from the cluster,
- creates a new container and syncs all data from the remaining copy.
- Finally the broken container is automatically deleted.
-
-
- NON_HA
-
- Zerops will create a KeyDB database installed in a single container.
- Useful for non-essential data or dev environments.
-
-
- Your data is stored only in a single container. If the container or the
- underlying physical machine fails, your data since the last backup are
- lost. Zerops doesn't provide any automatic repairs of single node KeyDB
- services.
+ Zerops will create a KeyDB database installed in a single container. Useful for non-essential data or dev environments.
+
+ Your data is stored only in a single container. If the container or the underlying physical machine fails, your data since the last backup are lost. Zerops doesn't provide any automatic repairs of single node KeyDB services.
|
- |
- verticalAutoscaling
- |
-
- Optional. Defines{' '}
-
- custom vertical auto scaling parameters
-
- .
- All verticalAutoscaling attributes are optional. Not specified
- attributes will be set to their default values.
+ | verticalAutoscaling |
+
+ Optional. Defines custom vertical auto scaling parameters.
+
+ All verticalAutoscaling attributes are optional. Not specified attributes will be set to their default values.
|
- |
- - cpuMode
- |
-
- Optional. Accepts `SHARED`, `DEDICATED`{' '}
- values. Default is `SHARED`
+ | - cpuMode |
+
+ Optional. Accepts `SHARED`, `DEDICATED` values. Default is `SHARED`
|
- |
- - minCpu/maxCpu
- |
-
- Optional. Set the minCpu or maxCpu in CPU cores (integer).
+ | - minCpu/maxCpu |
+
+ Optional. Set the minCpu or maxCpu in CPU cores (integer).
|
- |
- - minRam/maxRam
- |
-
- Optional. Set the minRam or maxRam in GB (float).
+ | - minRam/maxRam |
+
+ Optional. Set the minRam or maxRam in GB (float).
|
- |
- - minDisk/maxDisk
- |
-
- Optional. Set the minDisk or maxDisk in GB (float).
+ | - minDisk/maxDisk |
+
+ Optional. Set the minDisk or maxDisk in GB (float).
|
diff --git a/apps/docs/content/keydb/how-to/scale.mdx b/apps/docs/content/keydb/how-to/scale.mdx
index f689fecd..f4b4b549 100644
--- a/apps/docs/content/keydb/how-to/scale.mdx
+++ b/apps/docs/content/keydb/how-to/scale.mdx
@@ -38,11 +38,33 @@ Choose the CPU mode when starting a new service or change it later. The CPU mode
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
For most cases, the default parameters will work without issues. If you need to limit the cost of the KeyDB service, lower the maximal resources. Zerops will never scale above the selected maximums.
diff --git a/apps/docs/content/mariadb/how-to/create.mdx b/apps/docs/content/mariadb/how-to/create.mdx
index ced27c65..5ae31620 100644
--- a/apps/docs/content/mariadb/how-to/create.mdx
+++ b/apps/docs/content/mariadb/how-to/create.mdx
@@ -15,9 +15,27 @@ First, set up a project in Zerops GUI. Then go to the project dashboard page and
**// TODO screenshot (add a new service page)**
-| Parameter | Description | Limitations |
-| ------------ | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **hostname** | A unique service identifier like `mariadb`,`sql`, `db` etc. | - duplicate services with the same name in the same project are forbidden
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9) |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | hostname |
+ A unique service identifier like `mariadb`,`sql`, `db` etc. |
+
+
- duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
+
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
+ |
+
+
+
+
:::caution
The hostname is fixed after the service is created. It can't be changed later.
@@ -83,11 +101,32 @@ Choose the CPU mode when starting a new service or change it later. The CPU mode
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.5 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.5 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
For most cases, the default parameters will work without issues. If you need to limit the cost of the MariaDB service, lower the maximal resources. Zerops will never scale above the selected maximums.
@@ -191,67 +230,71 @@ The hostname of the second service will be set to `mariadb2`. The [single contai
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | |
-| **description** | **Optional.** Description of the new project. | Maximum 255 characters. |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ |
+
+
+ | description |
+ Optional. Description of the new project. |
+ Maximum 255 characters. |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
+
At least one service in `services:` section is required. You can create a project with multiple services. The example above contains only MariaDB services but you can create a `description.yml` with [different types] of services.
-
+
- | Parameter |
- Description |
+ Parameter |
+ Description |
+ Limitations |
- |
- hostname
- |
-
- The unique service identifier.
-
-
- The hostname of the new database will be set to the{' '}
- `hostname` value.
-
- Limitations:
-
- duplicate services with the same name in the same project are
- forbidden
-
- - maximum 25 characters
+ | hostname |
+ A unique service identifier like `mariadb`,`sql`, `db` etc. |
+
+ - duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
|
- |
- type
- |
-
- Specifies the service type `mariadb` and version.
-
+ | type |
+ Specifies the service type `mariadb` and version. |
+
Set type:{' '}
`
mariadb@10.4
`
- Limitations:
-
Currently only MariaDB 10.4 is available.
|
- |
- mode
- |
-
- Defines the operation mode of MariaDB service.
-
-
+ | mode |
+ Defines the operation mode of MariaDB service. |
+
HA
Zerops will create a MariaDB cluster with 3 database containers and 2
@@ -266,12 +309,6 @@ At least one service in `services:` section is required. You can create a projec
the broken container is automatically deleted.
- Limitations:
-
- Learn more about
- specific behaviour and technical limitations of the MariaDB cluster.
-
-
NON_HA
Zerops will create a MariaDB database installed in a single container.
@@ -285,51 +322,32 @@ At least one service in `services:` section is required. You can create a projec
|
- |
- verticalAutoscaling
- |
-
- Optional. Defines{' '}
-
- custom vertical auto scaling parameters
-
- .
+ | verticalAutoscaling |
+ Defines custom vertical auto scaling parameters |
+
All verticalAutoscaling attributes are optional. Not specified
attributes will be set to their default values.
|
- |
- - cpuMode
- |
-
- Optional. Accepts `SHARED`, `DEDICATED`{' '}
- values. Default is `SHARED`
- |
+ - cpuMode |
+ Accepts `SHARED`, `DEDICATED` values. Default is `SHARED` |
+ |
- |
- - minCpu/maxCpu
- |
-
- Optional. Set the minCpu or maxCpu in CPU cores (integer).
- |
+ - minCpu/maxCpu |
+ Set the minCpu or maxCpu in CPU cores (integer). |
+ |
- |
- - minRam/maxRam
- |
-
- Optional. Set the minRam or maxRam in GB (float).
- |
+ - minRam/maxRam |
+ Set the minRam or maxRam in GB (float). |
+ |
- |
- - minDisk/maxDisk
- |
-
- Optional. Set the minDisk or maxDisk in GB (float).
- |
+ - minDisk/maxDisk |
+ Set the minDisk or maxDisk in GB (float). |
+ |
diff --git a/apps/docs/content/nginx/how-to/build-pipeline.mdx b/apps/docs/content/nginx/how-to/build-pipeline.mdx
index 59e3d159..b4457b33 100644
--- a/apps/docs/content/nginx/how-to/build-pipeline.mdx
+++ b/apps/docs/content/nginx/how-to/build-pipeline.mdx
@@ -5,18 +5,23 @@ description: Learn more about how you can configure your nginx service for build
import data from '@site/static/data.json';
import UnorderedCodeList from '@site/src/components/UnorderedCodeList';
+import GroupCards from '@site/src/components/GroupCards';
+
+export const languages = [
+ { name: "Node.js", link: "/nodejs/how-to/build-pipeline" },
+ { name: "PHP", link: "/php/how-to/build-pipeline" },
+ { name: "Python", link: "/python/how-to/build-pipeline" },
+ { name: "Go", link: "/go/how-to/build-pipeline" },
+ { name: ".NET", link: "/dotnet/how-to/build-pipeline" },
+ { name: "Rust", link: "/rust/how-to/build-pipeline" },
+ { name: "Java", link: "/java/how-to/build-pipeline" },
+]
Zerops provides a customizable build and runtime environment for your static content.
Zerops supports different build environments:
-- [Node.js](/nodejs/how-to/build-pipeline)
-- [PHP](/php/how-to/build-pipeline)
-- [Python](/python/how-to/build-pipeline)
-- [Go](/go/how-to/build-pipeline)
-- [.NET](/dotnet/how-to/build-pipeline)
-- [Rust](/rust/how-to/build-pipeline)
-- [Java](/java/how-to/build-pipeline)
+
If you just need to deploy your static content, use the [manual deploy](/nginx/how-to/trigger-pipeline#manual-deploy-using-zerops-cli) via Zerops CLI.
@@ -106,20 +111,6 @@ zerops:
Each service configuration contains at least two sections: **build** and **run**. Both sections are required to build and deploy your Nginx application in Zerops. If you'd like to use a readiness check, add an optional **deploy** section.
-## Build pipeline configuration
-
-Zerops supports different build environments:
-
-- [Node.js](/nodejs/how-to/build-pipeline)
-- [PHP](/php/how-to/build-pipeline)
-- [Python](/python/how-to/build-pipeline)
-- [Go](/go/how-to/build-pipeline)
-- [.NET](/dotnet/how-to/build-pipeline)
-- [Rust](/rust/how-to/build-pipeline)
-- [Java](/java/how-to/build-pipeline)
-
-If you just need to deploy your static content, use the [manual deploy](/nginx/how-to/trigger-pipeline#manual-deploy-using-zerops-cli) via Zerops CLI.
-
## Runtime configuration
### base
@@ -227,11 +218,28 @@ Do not use the port **:443**. All the incoming traffic is terminated on the Zero
Each port has following attributes:
-| parameter | description |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| port | Defines the port number. You can set any port number between _10_ and _65435_. Ports outside this interval are reserved for internal Zerops systems. |
-| protocol | **Optional.** Defines the protocol. Allowed values are `TCP` or `UDP`. Default value is `TCP`. |
-| httpSupport | **Optional.** `httpSupport = true` is the default setting for TCP protocol. Set `httpSupport = false` if a web server isn't running on the port. Zerops uses this information for the configuration of [public access](/features/access). `httpSupport = true` is available only in combination with the TCP protocol. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | port |
+ Defines the port number. You can set any port number between 10 and 65435. Ports outside this interval are reserved for internal Zerops systems. |
+
+
+ | protocol |
+ Optional. Defines the protocol. Allowed values are TCP or UDP. Default value is TCP. |
+
+
+ | httpSupport |
+ Optional. httpSupport = true is the default setting for TCP protocol. Set httpSupport = false if a web server isn't running on the port. Zerops uses this information for the configuration of public access. httpSupport = true is available only in combination with the TCP protocol. |
+
+
+
### prepareCommands
@@ -473,9 +481,24 @@ Read more about how the [health check works] in Zerops.
Configures the health check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/nginx/how-to/create#set-environment-variables) as your Nginx application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your Nginx application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
**Example:**
@@ -553,9 +576,24 @@ Read more about how the [readiness check works](/nginx/how-to/deploy-process#rea
Configures the readiness check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/nginx/how-to/create#set-environment-variables) as your Nginx application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your Nginx application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
**Example:**
diff --git a/apps/docs/content/nginx/how-to/create.mdx b/apps/docs/content/nginx/how-to/create.mdx
index e7012d53..b93d2dba 100644
--- a/apps/docs/content/nginx/how-to/create.mdx
+++ b/apps/docs/content/nginx/how-to/create.mdx
@@ -77,11 +77,33 @@ Choose the CPU mode when starting a new service or change it later. The CPU mode
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
Nginx static service always starts with the minimal resources.
@@ -240,11 +262,33 @@ S3_ACCESS_SECRET="ogFthuiLYki8XoL73opSCQ"
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | |
-| **description** | **Optional.** Description of the new project. | Maximum 255 characters. |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ |
+
+
+ | description |
+ Optional. Description of the new project. |
+ Maximum 255 characters. |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
+
At least one service in `services:` section is required. You can create a project with multiple services. The example above contains an Nginx static service but you can create a `description.yml` with your own combination of [services](/features/infrastructure).
diff --git a/apps/docs/content/nginx/how-to/env-variables.mdx b/apps/docs/content/nginx/how-to/env-variables.mdx
index 3f93bfc1..01362ea4 100644
--- a/apps/docs/content/nginx/how-to/env-variables.mdx
+++ b/apps/docs/content/nginx/how-to/env-variables.mdx
@@ -11,11 +11,33 @@ In Zerops you do not have to create a `.env` file manually. Zerops handles the e
There are 3 different sets of env variables in Zerops:
-| environment | type | defined in |
-| ----------- | ------ | -------------------------------------------------------------------------------- |
-| build | basic | [zerops.yml](/nginx/how-to/build-pipeline#envvariables) |
-| runtime | basic | [zerops.yml](/nginx/how-to/build-pipeline#envvariables-1) |
-| runtime | secret | [Zerops GUI](/nginx/how-to/env-variables#set-secret-env-variables-in-zerops-gui) |
+
+
+
+ | Type |
+ Environment |
+ Defined in |
+
+
+
+
+ | basic |
+ build |
+ zerops.yml |
+
+
+ | basic |
+ runtime |
+ zerops.yml |
+
+
+ | secret |
+ runtime |
+ Zerops GUI |
+
+
+
+
Use the [secret env variables](/nginx/how-to/create#set-secret-env-variables) for all sensitive data you don't want to store in your application code. Secret env variables are also useful if you need for testing where you need to change the value of some env variables frequently. Secret variables are managed in Zerops GUI and you don't have to redeploy your application.
diff --git a/apps/docs/content/nginx/how-to/scaling.mdx b/apps/docs/content/nginx/how-to/scaling.mdx
index cb975b6c..9b053e4d 100644
--- a/apps/docs/content/nginx/how-to/scaling.mdx
+++ b/apps/docs/content/nginx/how-to/scaling.mdx
@@ -66,11 +66,33 @@ The CPU mode doesn't change automatically.
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
Nginx static service always starts with the minimal resources.
diff --git a/apps/docs/content/nodejs/how-to/build-pipeline.mdx b/apps/docs/content/nodejs/how-to/build-pipeline.mdx
index 8ea6a483..886efcc8 100644
--- a/apps/docs/content/nodejs/how-to/build-pipeline.mdx
+++ b/apps/docs/content/nodejs/how-to/build-pipeline.mdx
@@ -512,11 +512,28 @@ For example, to connect to a Node.js service with hostname = "app" and port = 30
Each port has following attributes:
-| parameter | description |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| port | Defines the port number. You can set any port number between _10_ and _65435_. Ports outside this interval are reserved for internal Zerops systems. |
-| protocol | **Optional.** Defines the protocol. Allowed values are `TCP` or `UDP`. Default value is `TCP`. |
-| httpSupport | **Optional.** `httpSupport = true` is the default setting for TCP protocol. Set `httpSupport = false` if a web server isn't running on the port. Zerops uses this information for the configuration of [public access](/features/access). `httpSupport = true` is available only in combination with the TCP protocol. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | port |
+ Defines the port number. You can set any port number between 10 and 65435. Ports outside this interval are reserved for internal Zerops systems. |
+
+
+ | protocol |
+ Optional. Defines the protocol. Allowed values are TCP or UDP. Default value is TCP. |
+
+
+ | httpSupport |
+ Optional. httpSupport = true is the default setting for TCP protocol. Set httpSupport = false if a web server isn't running on the port. Zerops uses this information for the configuration of public access. httpSupport = true is available only in combination with the TCP protocol. |
+
+
+
### prepareCommands
@@ -735,9 +752,24 @@ Read more about how the [health check works] in Zerops.
Configures the health check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/nodejs/how-to/create#set-environment-variables) as your Node.js application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your Node.js application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
**Example:**
@@ -814,9 +846,24 @@ Read more about how the [readiness check works](/nodejs/how-to/deploy-process#re
Configures the readiness check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/nodejs/how-to/create#set-environment-variables) as your Node.js application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your Node.js application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
**Example:**
diff --git a/apps/docs/content/nodejs/how-to/create.mdx b/apps/docs/content/nodejs/how-to/create.mdx
index 7dce4a57..ee87a709 100644
--- a/apps/docs/content/nodejs/how-to/create.mdx
+++ b/apps/docs/content/nodejs/how-to/create.mdx
@@ -87,11 +87,32 @@ You can choose the CPU mode when starting a new service or change it later. The
Vertical auto scaling has the following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
Node.js services always start with the minimal resources.
@@ -113,19 +134,21 @@ When a container needs more CPU or RAM but is already consuming the maximum reso
Horizontal auto scaling has the following default configuration:
-
+
+
+
+ | Parameter |
+ Value |
+
+
- |
- Minimum containers
- |
- 1 |
+ Minimum containers |
+ 1 |
- |
- Maximum containers
- |
- 6 |
+ Maximum containers |
+ 6 |
@@ -259,155 +282,124 @@ The hostname of the PostgreSQL service will be set to "db". The [single containe
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | |
-| **description** | **Optional.** Description of the new project. | Maximum 255 characters. |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ |
+
+
+ | description |
+ Optional. Description of the new project. |
+ Maximum 255 characters. |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
At least one service in `services:` section is required. You can create a project with multiple services. The example above contains Node.js and PostgreSQL services but you can create a `description.yml` with your own combination of [services](/features/infrastructure).
-
+
- | Parameter |
- Description |
+ Parameter |
+ Description |
- |
- hostname
- |
-
+ | hostname |
+
The unique service identifier.
-
-
- The hostname of the new database will be set to the{' '}
- `hostname` value.
-
- Limitations:
-
- duplicate services with the same name in the same project are
- forbidden
-
- - maximum 25 characters
+
+ The hostname of the new database will be set to the `hostname` value.
+
+ Limitations:
+
- duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
|
- |
- type
- |
-
+ | type |
+
Specifies the service type `nodejs` and version.
- Set type:{' '}
- `
- nodejs@<version>
- `{' '}
- or{' '}
- `
- nodejs@latest
- `
-
+ Set type: `nodejs@` or `nodejs@latest`
+
+ Limitations:
- Limitations:
-
- Following Node.js major versions are currently supported: 20,
- 18,16
+ Following Node.js major versions are currently supported: 20, 18, 16
|
- |
- verticalAutoscaling
- |
-
- Optional. Defines{' '}
-
- custom vertical auto scaling parameters
-
- .
- All verticalAutoscaling attributes are optional. Not specified
- attributes will be set to their default values.
+ | verticalAutoscaling |
+
+ Optional. Defines custom vertical auto scaling parameters.
+
+ All verticalAutoscaling attributes are optional. Not specified attributes will be set to their default values.
|
- |
- - cpuMode
- |
-
- Optional. Accepts `SHARED`, `DEDICATED`{' '}
- values. Default is `SHARED`
+ | - cpuMode |
+
+ Optional. Accepts `SHARED`, `DEDICATED` values. Default is `SHARED`
|
- |
- - minCpu/maxCpu
- |
-
- Optional. Set the minCpu or maxCpu in CPU cores (integer).
+ | - minCpu/maxCpu |
+
+ Optional. Set the minCpu or maxCpu in CPU cores (integer).
|
- |
- - minRam/maxRam
- |
-
- Optional. Set the minRam or maxRam in GB (float).
+ | - minRam/maxRam |
+
+ Optional. Set the minRam or maxRam in GB (float).
|
- |
- - minDisk/maxDisk
- |
-
- Optional. Set the minDisk or maxDisk in GB (float).
+ | - minDisk/maxDisk |
+
+ Optional. Set the minDisk or maxDisk in GB (float).
|
- |
- minContainers
- |
-
- Optional. Default = 1. Defines the minimum number of containers
- for{' '}
-
- horizontal autoscaling
-
- .
-
- Limitations:
+ | minContainers |
+
+ Optional. Default = 1. Defines the minimum number of containers for horizontal autoscaling.
+
+ Limitations:
Current maximum value = 6.
|
- |
- maxContainers
- |
-
- Defines the maximum number of containers for{' '}
-
- horizontal autoscaling
-
- .
-
- Limitations:
+ | maxContainers |
+
+ Defines the maximum number of containers for horizontal autoscaling.
+
+ Limitations:
Current maximum value = 6.
|
- |
- envSecrets
- |
-
- Optional. Defines one or more secret env variables as a key value
- map. See env variable{' '}
-
- restrictions
-
- .
+ | envSecrets |
+
+ Optional. Defines one or more secret env variables as a key value map. See env variable restrictions.
|
diff --git a/apps/docs/content/nodejs/how-to/env-variables.mdx b/apps/docs/content/nodejs/how-to/env-variables.mdx
index 74dff90f..d62ac85a 100644
--- a/apps/docs/content/nodejs/how-to/env-variables.mdx
+++ b/apps/docs/content/nodejs/how-to/env-variables.mdx
@@ -11,11 +11,32 @@ In Zerops you do not have to create a `.env` file manually. Zerops handles the e
There are 3 different sets of env variables in Zerops:
-| environment | type | defined in |
-| ----------- | ------ | --------------------------------------------------------------------------------- |
-| build | basic | [zerops.yml](/nodejs/how-to/build-pipeline#envvariables) |
-| runtime | basic | [zerops.yml](/nodejs/how-to/build-pipeline#envvariables-1) |
-| runtime | secret | [Zerops GUI](/nodejs/how-to/env-variables#set-secret-env-variables-in-zerops-gui) |
+
+
+
+ | Type |
+ Environment |
+ Defined in |
+
+
+
+
+ | basic |
+ build |
+ zerops.yml |
+
+
+ | basic |
+ runtime |
+ zerops.yml |
+
+
+ | secret |
+ runtime |
+ Zerops GUI |
+
+
+
Use the [secret env variables](/nodejs/how-to/create#set-secret-env-variables) for all sensitive data you don't want to store in your application code. Secret env variables are also useful if you need for testing where you need to change the value of some env variables frequently. Secret variables are managed in Zerops GUI and you don't have to redeploy your application.
diff --git a/apps/docs/content/nodejs/how-to/scaling.mdx b/apps/docs/content/nodejs/how-to/scaling.mdx
index a51d950b..33fe4088 100644
--- a/apps/docs/content/nodejs/how-to/scaling.mdx
+++ b/apps/docs/content/nodejs/how-to/scaling.mdx
@@ -66,11 +66,33 @@ The CPU mode doesn't change automatically.
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
Node.js service always starts with the minimal resources.
diff --git a/apps/docs/content/object-storage/how-to/create.mdx b/apps/docs/content/object-storage/how-to/create.mdx
index 42eee182..b036b89f 100644
--- a/apps/docs/content/object-storage/how-to/create.mdx
+++ b/apps/docs/content/object-storage/how-to/create.mdx
@@ -53,13 +53,58 @@ Bucket will be created with a name based on the given service name and a random
Select one of the basic policy templates:
-| Template | Description |
-| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| Public read | Allows anyone:- to read the bucket's location `(s3:GetBucketLocation)`
- to list all bucket's objects `(s3:ListBucket)`
- to get any object of the bucket `(s3:GetObject)`
|
-| Public objects read | Allows anyone:- to read the bucket's location `(s3:GetBucketLocation)`
- to get any object of the bucket `(s3:GetObject)`
|
-| Public read write | Allows anyone:- to read the bucket's location `(s3:GetBucketLocation)`
- to list all bucket's objects `(s3:ListBucket)`
- to get any object of the bucket `(s3:GetObject)`
- to create a new object in the bucket `(s3:PutObject,s3:ListMultipartUploadParts, s3:AbortMultipartUpload, s3:ListBucketMultipartUploads)`
- to delete any object of the bucket `(s3:DeleteObject)`
|
-| Public write | Allows anyone to create objects in the bucket `(PutObject action)` |
-| Private | Denies the access to unauthenticated users. |
+
+
+
+ | Template |
+ Description |
+
+
+
+
+ | Public read |
+
+ Allows anyone:
+
+ - to read the bucket's location `(s3:GetBucketLocation)`
+ - to list all bucket's objects `(s3:ListBucket)`
+ - to get any object of the bucket `(s3:GetObject)`
+
+ |
+
+
+ | Public objects read |
+
+ Allows anyone:
+
+ - to read the bucket's location `(s3:GetBucketLocation)`
+ - to get any object of the bucket `(s3:GetObject)`
+
+ |
+
+
+ | Public read write |
+
+ Allows anyone:
+
+ - to read the bucket's location `(s3:GetBucketLocation)`
+ - to list all bucket's objects `(s3:ListBucket)`
+ - to get any object of the bucket `(s3:GetObject)`
+ - to create a new object in the bucket `(s3:PutObject,s3:ListMultipartUploadParts, s3:AbortMultipartUpload, s3:ListBucketMultipartUploads)`
+ - to delete any object of the bucket `(s3:DeleteObject)`
+
+ |
+
+
+ | Public write |
+ Allows anyone to create objects in the bucket `(PutObject action)` |
+
+
+ | Private |
+ Denies the access to unauthenticated users. |
+
+
+
Or you can set your own access policy in the [IAM Policy JSON format](https://min.io/docs/minio/linux/administration/identity-access-management/policy-based-access-control.html#policy-document-structure).
@@ -159,21 +204,106 @@ The yaml file describes your future project infrastructure. The project will con
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | Maximum 255 characters |
-| **description** | **Optional.** Description of the new project. | |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. | |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ Maximum 255 characters |
+
+
+ | description |
+ Optional. Description of the new project. |
+ |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
At least one service in `services:` section is required. You can create a project with multiple services. The example above contains only Object storage service but you can create a description.yml with different types of services.
-| Parameter | Description |
-| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **hostname** | The unique service identifier.
The name of the new Object storage will be set to the hostname value.
**Limitations:**
- duplicate services with the same name in the same project are forbidden
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
|
-| **type** | Specifies the Object storage type objectstorage and version.
Set type: `objectstorage`
**Limitations:** Currently `objectstorage` or `object-storage` is available. |
-| **objectStorageSize** | The size of the bucket quota in GB.
**Limitations:** Set a whole number between 1 and 100. |
-| **objectStoragePolicy** | **Optional.** Either `objectStoragePolicy` or `objectStorageRawPolicy` is required.
Set one of allowed values:- `public-read`
- `public-objects-read`
- `public-read-write`
- `public-write`
- `private`
Read more about [the basic policy templates]. |
-| **objectStorageRawPolicy** | **Optional.** Either `objectStoragePolicy` or `objectStorageRawPolicy` is required.
Set your own access policy in the [IAM Policy JSON format].
The `{{ .BucketName }}` variable will be replaced by the bucket name. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | hostname |
+
+ The unique service identifier.
+
+ The name of the new Object storage will be set to the hostname value.
+
+ Limitations:
+
- duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
+
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
+ |
+
+
+ | type |
+
+ Specifies the Object storage type objectstorage and version.
+
+ Set type: `objectstorage`
+
+ Limitations:
+
+ Currently `objectstorage` or `object-storage` is available.
+ |
+
+
+ | objectStorageSize |
+
+ The size of the bucket quota in GB.
+
+ Limitations:
+
+ Set a whole number between 1 and 100.
+ |
+
+
+ | objectStoragePolicy |
+
+ Optional. Either `objectStoragePolicy` or `objectStorageRawPolicy` is required.
+
+ Set one of allowed values:
+
+ - `public-read`
+ - `public-objects-read`
+ - `public-read-write`
+ - `public-write`
+ - `private`
+
+ Read more about the basic policy templates.
+ |
+
+
+ | objectStorageRawPolicy |
+
+ Optional. Either `objectStoragePolicy` or `objectStorageRawPolicy` is required.
+
+ Set your own access policy in the IAM Policy JSON format.
+
+ The `{{ .BucketName }}` variable will be replaced by the bucket name.
+ |
+
+
+
Zerops creates one bucket automatically for each new Object storage service.
diff --git a/apps/docs/content/php/how-to/build-pipeline.mdx b/apps/docs/content/php/how-to/build-pipeline.mdx
index c12a5a30..278ca3df 100644
--- a/apps/docs/content/php/how-to/build-pipeline.mdx
+++ b/apps/docs/content/php/how-to/build-pipeline.mdx
@@ -519,11 +519,28 @@ Do not use the port **:443**. All the incoming traffic is terminated on the Zero
Each port has following attributes:
-| parameter | description |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| port | Defines the port number. You can set any port number between _10_ and _65435_. Ports outside this interval are reserved for internal Zerops systems. |
-| protocol | **Optional.** Defines the protocol. Allowed values are `TCP` or `UDP`. Default value is `TCP`. |
-| httpSupport | **Optional.** `httpSupport = true` is the default setting for TCP protocol. Set `httpSupport = false` if a web server isn't running on the port. Zerops uses this information for the configuration of [public access](/features/access). `httpSupport = true` is available only in combination with the TCP protocol. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | port |
+ Defines the port number. You can set any port number between 10 and 65435. Ports outside this interval are reserved for internal Zerops systems. |
+
+
+ | protocol |
+ Optional. Defines the protocol. Allowed values are TCP or UDP. Default value is TCP. |
+
+
+ | httpSupport |
+ Optional. httpSupport = true is the default setting for TCP protocol. Set httpSupport = false if a web server isn't running on the port. Zerops uses this information for the configuration of public access. httpSupport = true is available only in combination with the TCP protocol. |
+
+
+
### prepareCommands
@@ -766,9 +783,24 @@ Read more about how the [health check works] in Zerops.
Configures the health check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/php/how-to/create#set-environment-variables) as your PHP application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your PHP application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
**Example:**
@@ -846,9 +878,24 @@ Read more about how the [readiness check works](/php/how-to/deploy-process#readi
Configures the readiness check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/php/how-to/create#set-environment-variables) as your PHP application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your PHP application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
**Example:**
diff --git a/apps/docs/content/php/how-to/create.mdx b/apps/docs/content/php/how-to/create.mdx
index dd3bc477..2176f998 100644
--- a/apps/docs/content/php/how-to/create.mdx
+++ b/apps/docs/content/php/how-to/create.mdx
@@ -77,11 +77,33 @@ Choose the CPU mode when starting a new service or change it later. The CPU mode
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
PHP service always starts with the minimal resources.
@@ -103,19 +125,21 @@ When a container needs more CPU or RAM but already consumes maximal resources de
Horizontal auto scaling has following default configuration:
-
+
+
+
+ | Parameter |
+ Value |
+
+
- |
- minimum containers
- |
- 1 |
+ minimum containers |
+ 1 |
- |
- maximum containers
- |
- 6 |
+ maximum containers |
+ 6 |
@@ -250,164 +274,125 @@ The hostname of the PostgreSQL service will be set to "db". The [single containe
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | |
-| **description** | **Optional.** Description of the new project. | Maximum 255 characters. |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ |
+
+
+ | description |
+ Optional. Description of the new project. |
+ Maximum 255 characters. |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
+
At least one service in `services:` section is required. You can create a project with multiple services. The example above contains PHP and PostgreSQL services but you can create a `description.yml` with your own combination of [services](/features/infrastructure).
-
+
- | Parameter |
- Description |
+ Parameter |
+ Description |
- |
- hostname
- |
-
+ | hostname |
+
The unique service identifier.
-
-
- The hostname of the new database will be set to the{' '}
- `hostname` value.
-
- Limitations:
-
- duplicate services with the same name in the same project are
- forbidden
-
- - maximum 25 characters
+
+ The hostname of the new service will be set to the `hostname` value.
+
+ Limitations:
+
- duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
|
- |
- type
- |
-
- Specifies the service type `php-apache` or{' '}
- `php-nginx` and version.
-
- Set type:{' '}
- `
- php-apache@<version>
- `
- ,{' '}
- `
- php-nginx@<version>
- `
- ,{' '}
- `
- php-apache@latest
- `{' '}
- or{' '}
- `
- php-nginx@latest
- `
+ | type |
+
+ Specifies the service type `php-apache` or `php-nginx` and version.
+ Set type: `php-apache@`, `php-nginx@`, `php-apache@latest` or `php-nginx@latest`
+
+ Limitations:
- Limitations:
-
- Following PHP major versions are currently supported: 7.4,
- 8.0,8.1
+ Following PHP major versions are currently supported: 7.4, 8.0, 8.1
|
- |
- verticalAutoscaling
- |
-
- Optional. Defines{' '}
-
- custom vertical auto scaling parameters
-
- .
- All verticalAutoscaling attributes are optional. Not specified
- attributes will be set to their default values.
+ | verticalAutoscaling |
+
+ Optional. Defines custom vertical auto scaling parameters.
+
+ All verticalAutoscaling attributes are optional. Not specified attributes will be set to their default values.
|
- |
- - cpuMode
- |
-
- Optional. Accepts `SHARED`, `DEDICATED`{' '}
- values. Default is `SHARED`
+ | - cpuMode |
+
+ Optional. Accepts `SHARED`, `DEDICATED` values. Default is `SHARED`
|
- |
- - minCpu/maxCpu
- |
-
- Optional. Set the minCpu or maxCpu in CPU cores (integer).
+ | - minCpu/maxCpu |
+
+ Optional. Set the minCpu or maxCpu in CPU cores (integer).
|
- |
- - minRam/maxRam
- |
-
- Optional. Set the minRam or maxRam in GB (float).
+ | - minRam/maxRam |
+
+ Optional. Set the minRam or maxRam in GB (float).
|
- |
- - minDisk/maxDisk
- |
-
- Optional. Set the minDisk or maxDisk in GB (float).
+ | - minDisk/maxDisk |
+
+ Optional. Set the minDisk or maxDisk in GB (float).
|
- |
- minContainers
- |
-
- Optional. Default = 1. Defines the minimum number of containers
- for{' '}
-
- horizontal autoscaling
-
- .
-
- Limitations:
+ | minContainers |
+
+ Optional. Default = 1. Defines the minimum number of containers for horizontal autoscaling.
+
+ Limitations:
Current maximum value = 6.
|
- |
- maxContainers
- |
-
- Defines the maximum number of containers for{' '}
-
- horizontal autoscaling
-
- .
-
- Limitations:
+ | maxContainers |
+
+ Defines the maximum number of containers for horizontal autoscaling.
+
+ Limitations:
Current maximum value = 6.
|
- |
- envSecrets
- |
-
- Optional. Defines one or more secret env variables as a key value
- map. See env variable{' '}
-
- restrictions
-
- .
+ | envSecrets |
+
+ Optional. Defines one or more secret env variables as a key value map. See env variable restrictions.
|
diff --git a/apps/docs/content/php/how-to/env-variables.mdx b/apps/docs/content/php/how-to/env-variables.mdx
index c6528435..0e4cd5a8 100644
--- a/apps/docs/content/php/how-to/env-variables.mdx
+++ b/apps/docs/content/php/how-to/env-variables.mdx
@@ -11,11 +11,33 @@ In Zerops you do not have to create a `.env` file manually. Zerops handles the e
There are 3 different sets of env variables in Zerops:
-| environment | type | defined in |
-| ----------- | ------ | ------------------------------------------------------------------------------ |
-| build | basic | [zerops.yml](/php/how-to/build-pipeline#envvariables) |
-| runtime | basic | [zerops.yml](/php/how-to/build-pipeline#envvariables-1) |
-| runtime | secret | [Zerops GUI](/php/how-to/env-variables#set-secret-env-variables-in-zerops-gui) |
+
+
+
+ | Type |
+ Environment |
+ Defined in |
+
+
+
+
+ | basic |
+ build |
+ zerops.yml |
+
+
+ | basic |
+ runtime |
+ zerops.yml |
+
+
+ | secret |
+ runtime |
+ Zerops GUI |
+
+
+
+
Use the [secret env variables](/php/how-to/create#set-secret-env-variables) for all sensitive data you don't want to store in your application code. Secret env variables are also useful if you need for testing where you need to change the value of some env variables frequently. Secret variables are managed in Zerops GUI and you don't have to redeploy your application.
diff --git a/apps/docs/content/php/how-to/scaling.mdx b/apps/docs/content/php/how-to/scaling.mdx
index 28b41ff8..19f8bb6c 100644
--- a/apps/docs/content/php/how-to/scaling.mdx
+++ b/apps/docs/content/php/how-to/scaling.mdx
@@ -66,11 +66,33 @@ The CPU mode doesn't change automatically.
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
PHP service always starts with the minimal resources.
diff --git a/apps/docs/content/postgresql/how-to/create.mdx b/apps/docs/content/postgresql/how-to/create.mdx
index 2d38176b..10a90afc 100644
--- a/apps/docs/content/postgresql/how-to/create.mdx
+++ b/apps/docs/content/postgresql/how-to/create.mdx
@@ -11,9 +11,26 @@ First, set up a project in Zerops GUI. Then go to the project dashboard page and
**// TODO screenshot (add a new service page)**
-| Parameter | Description | Limitations |
-| ------------ | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **hostname** | A unique service identifier like `postgresql`,`sql`, `db` etc. | - duplicate services with the same name in the same project are forbidden
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9) |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | hostname |
+ A unique service identifier like `postgresql`,`sql`, `db` etc. |
+
+ - duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
+
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
+ |
+
+
+
:::caution
The hostname is fixed after the service is created. It can't be changed later.
@@ -189,11 +206,33 @@ The hostname of the second service will be set to `postgresql2`. The [single con
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | |
-| **description** | **Optional.** Description of the new project. | Maximum 255 characters. |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ |
+
+
+ | description |
+ Optional. Description of the new project. |
+ Maximum 255 characters. |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
+
At least one service in the `services:` section is required. You can create a project with multiple services. The example above contains only PostgreSQL services but you can create a `description.yml` with [different types] of services.
diff --git a/apps/docs/content/python/how-to/build-pipeline.mdx b/apps/docs/content/python/how-to/build-pipeline.mdx
index c190478c..913d7b32 100644
--- a/apps/docs/content/python/how-to/build-pipeline.mdx
+++ b/apps/docs/content/python/how-to/build-pipeline.mdx
@@ -461,11 +461,28 @@ For example, to connect to a Python service with hostname = "app" and port = 800
Each port has following attributes:
-| parameter | description |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| port | Defines the port number. You can set any port number between _10_ and _65435_. Ports outside this interval are reserved for internal Zerops systems. |
-| protocol | **Optional.** Defines the protocol. Allowed values are `TCP` or `UDP`. Default value is `TCP`. |
-| httpSupport | **Optional.** `httpSupport = true` is the default setting for TCP protocol. Set `httpSupport = false` if a web server isn't running on the port. Zerops uses this information for the configuration of [public access](/features/access). `httpSupport = true` is available only in combination with the TCP protocol. |
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | port |
+ Defines the port number. You can set any port number between 10 and 65435. Ports outside this interval are reserved for internal Zerops systems. |
+
+
+ | protocol |
+ Optional. Defines the protocol. Allowed values are TCP or UDP. Default value is TCP. |
+
+
+ | httpSupport |
+ Optional. httpSupport = true is the default setting for TCP protocol. Set httpSupport = false if a web server isn't running on the port. Zerops uses this information for the configuration of public access. httpSupport = true is available only in combination with the TCP protocol. |
+
+
+
### prepareCommands
@@ -681,9 +698,26 @@ Read more about how the [health check works] in Zerops.
Configures the health check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/python/how-to/create#set-environment-variables) as your Python application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your Python application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
+
**Example:**
@@ -760,9 +794,26 @@ Read more about how the [readiness check works](/python/how-to/deploy-process#re
Configures the readiness check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/python/how-to/create#set-environment-variables) as your Python application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your Python application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
+
**Example:**
diff --git a/apps/docs/content/python/how-to/create.mdx b/apps/docs/content/python/how-to/create.mdx
index f72a6b02..a9451494 100644
--- a/apps/docs/content/python/how-to/create.mdx
+++ b/apps/docs/content/python/how-to/create.mdx
@@ -77,11 +77,32 @@ Choose the CPU mode when starting a new service or change it later. The CPU mode
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 5 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 5 GB |
+ 100 GB |
+
+
+
Python service always starts with the minimal resources.
@@ -103,19 +124,21 @@ When a container needs more CPU or RAM but already consumes maximal resources de
Horizontal auto scaling has following default configuration:
-
+
+
+
+ | Parameter |
+ Value |
+
+
- |
- minimum containers
- |
- 1 |
+ minimum containers |
+ 1 |
- |
- maximum containers
- |
- 6 |
+ maximum containers |
+ 6 |
@@ -250,155 +273,125 @@ The hostname of the PostgreSQL service will be set to "db". The [single containe
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | |
-| **description** | **Optional.** Description of the new project. | Maximum 255 characters. |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ |
+
+
+ | description |
+ Optional. Description of the new project. |
+ Maximum 255 characters. |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
+
At least one service in `services:` section is required. You can create a project with multiple services. The example above contains Python and PostgreSQL services but you can create a `description.yml` with your own combination of [services](/features/infrastructure).
-
+
- | Parameter |
- Description |
+ Parameter |
+ Description |
- |
- hostname
- |
-
+ | hostname |
+
The unique service identifier.
-
-
- The hostname of the new database will be set to the{' '}
- `hostname` value.
-
- Limitations:
-
- duplicate services with the same name in the same project are
- forbidden
-
- - maximum 25 characters
+
+ The hostname of the new service will be set to the `hostname` value.
+
+ Limitations:
+
- duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
|
- |
- type
- |
-
+ | type |
+
Specifies the service type `python` and version.
- Set type:{' '}
- `
- python@<version>
- `{' '}
- or{' '}
- `
- python@latest
- `
+ Set type: `python@` or `python@latest`
+
+ Limitations:
-
- Limitations:
-
- Following Python major versions are currently supported: 3.8,
- 3.9,3.10,3.11,3.12
+ Following Python major versions are currently supported: 3.8, 3.9, 3.10, 3.11, 3.12
|
- |
- verticalAutoscaling
- |
-
- Optional. Defines{' '}
-
- custom vertical auto scaling parameters
-
- .
- All verticalAutoscaling attributes are optional. Not specified
- attributes will be set to their default values.
+ | verticalAutoscaling |
+
+ Optional. Defines custom vertical auto scaling parameters.
+
+ All verticalAutoscaling attributes are optional. Not specified attributes will be set to their default values.
|
- |
- - cpuMode
- |
-
- Optional. Accepts `SHARED`, `DEDICATED`{' '}
- values. Default is `SHARED`
+ | - cpuMode |
+
+ Optional. Accepts `SHARED`, `DEDICATED` values. Default is `SHARED`
|
- |
- - minCpu/maxCpu
- |
-
- Optional. Set the minCpu or maxCpu in CPU cores (integer).
+ | - minCpu/maxCpu |
+
+ Optional. Set the minCpu or maxCpu in CPU cores (integer).
|
- |
- - minRam/maxRam
- |
-
- Optional. Set the minRam or maxRam in GB (float).
+ | - minRam/maxRam |
+
+ Optional. Set the minRam or maxRam in GB (float).
|
- |
- - minDisk/maxDisk
- |
-
- Optional. Set the minDisk or maxDisk in GB (float).
+ | - minDisk/maxDisk |
+
+ Optional. Set the minDisk or maxDisk in GB (float).
|
- |
- minContainers
- |
-
- Optional. Default = 1. Defines the minimum number of containers
- for{' '}
-
- horizontal autoscaling
-
- .
-
- Limitations:
+ | minContainers |
+
+ Optional. Default = 1. Defines the minimum number of containers for horizontal autoscaling.
+
+ Limitations:
Current maximum value = 6.
|
- |
- maxContainers
- |
-
- Defines the maximum number of containers for{' '}
-
- horizontal autoscaling
-
- .
-
- Limitations:
+ | maxContainers |
+
+ Defines the maximum number of containers for horizontal autoscaling.
+
+ Limitations:
Current maximum value = 6.
|
- |
- envSecrets
- |
-
- Optional. Defines one or more secret env variables as a key value
- map. See env variable{' '}
-
- restrictions
-
- .
+ | envSecrets |
+
+ Optional. Defines one or more secret env variables as a key value map. See env variable restrictions.
|
diff --git a/apps/docs/content/python/how-to/env-variables.mdx b/apps/docs/content/python/how-to/env-variables.mdx
index 33f5d098..4fba2d41 100644
--- a/apps/docs/content/python/how-to/env-variables.mdx
+++ b/apps/docs/content/python/how-to/env-variables.mdx
@@ -11,11 +11,33 @@ In Zerops you do not have to create a `.env` file manually. Zerops handles the e
There are 3 different sets of env variables in Zerops:
-| environment | type | defined in |
-| ----------- | ------ | --------------------------------------------------------------------------------- |
-| build | basic | [zerops.yml](/python/how-to/build-pipeline#envvariables) |
-| runtime | basic | [zerops.yml](/python/how-to/build-pipeline#envvariables-1) |
-| runtime | secret | [Zerops GUI](/python/how-to/env-variables#set-secret-env-variables-in-zerops-gui) |
+
+
+
+ | Type |
+ Environment |
+ Defined in |
+
+
+
+
+ | basic |
+ build |
+ zerops.yml |
+
+
+ | basic |
+ runtime |
+ zerops.yml |
+
+
+ | secret |
+ runtime |
+ Zerops GUI |
+
+
+
+
Use the [secret env variables](/python/how-to/create#set-secret-env-variables) for all sensitive data you don't want to store in your application code. Secret env variables are also useful if you need for testing where you need to change the value of some env variables frequently. Secret variables are managed in Zerops GUI and you don't have to redeploy your application.
diff --git a/apps/docs/content/python/how-to/scaling.mdx b/apps/docs/content/python/how-to/scaling.mdx
index 7d56029b..cc853e2b 100644
--- a/apps/docs/content/python/how-to/scaling.mdx
+++ b/apps/docs/content/python/how-to/scaling.mdx
@@ -66,11 +66,33 @@ The CPU mode doesn't change automatically.
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
Python service always starts with the minimal resources.
diff --git a/apps/docs/content/rabbitmq/how-to/create.mdx b/apps/docs/content/rabbitmq/how-to/create.mdx
index 76475c8a..9262c43a 100644
--- a/apps/docs/content/rabbitmq/how-to/create.mdx
+++ b/apps/docs/content/rabbitmq/how-to/create.mdx
@@ -11,9 +11,26 @@ First, set up a project in Zerops GUI. Then go to the project dashboard page and
**// TODO screenshot (add a new service page)**
-| Parameter | Description | Limitations |
-| ------------ | ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **hostname** | A unique service identifier like `rabbitmq`, `db` etc. | - duplicate services with the same name in the same project are forbidden
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9) |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | hostname |
+ A unique service identifier like `rabbitmq`, `db` etc. |
+
+ - duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
+
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
+ |
+
+
+
:::caution
The hostname is fixed after the service is created. It can't be changed later.
@@ -58,11 +75,32 @@ Zerops scales the RabbitMQ services automatically by raising or lowering the har
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.5 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.5 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
For most cases, the default parameters will work without issues. If you need to limit the cost of the RabbitMQ service, lower the maximal resources. Zerops will never scale above the selected maximums.
@@ -162,103 +200,89 @@ The hostname of the second service will be set to `rabbitmq2`. The [single conta
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | |
-| **description** | **Optional.** Description of the new project. | Maximum 255 characters. |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ |
+
+
+ | description |
+ Optional. Description of the new project. |
+ Maximum 255 characters. |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
+
At least one service in `services:` section is required. You can create a project with multiple services. The example above contains only RabbitMQ services but you can create a `description.yml` with [different types] of services.
-
+
- | Parameter |
- Description |
+ Parameter |
+ Description |
+ Limitations |
- |
- hostname
- |
-
- The unique service identifier.
-
-
- The hostname of the new service will be set to the
- `hostname` value.
-
- Limitations:
-
- duplicate services with the same name in the same project are
- forbidden
-
- - maximum 25 characters
+ | hostname |
+ A unique service identifier like `rabbitmq`, `db` etc. |
+
+ - duplicate services with the same name in the same project are forbidden
+
- maximum 25 characters
- must contain only lowercase ASCII letters (a-z) or numbers (0-9)
|
- |
- type
- |
-
+ | type |
+
Specifies the service type `rabbitmq` and version.
- Set type:{' '}
- `
- rabbitmq@XXX
- `
- |
-
- Currently only RabbitMQ XXX is available.
+ Set type: `rabbitmq@3`
+
+ Limitations:
+
+ Currently only RabbitMQ 3.9.13 is available.
|
- |
- mode
- |
-
+ | mode |
+
Defines the operation mode of RabbitMQ service.
+
+ HA
+ Creates a RabbitMQ cluster with 3 message queue containers and 2 free database proxies. This mode is suited for production.
+
+ Zerops always keeps the 3 message queue containers on different physical machines. All your data is stored redundantly in 3 identical copies. In case of a failure of a container or the underlying physical machine, Zerops automatically disconnects the failed container from the cluster, creates a new container and syncs all data from the remaining 2 copies. Finally the broken container is automatically deleted.
+
+ NON_HA
- HA
-
- Creates a RabbitMQ cluster with 3 message queue containers and 2 free
- database proxies. This mode is suited for production.
-
-
- Zerops always keeps the 3 message queue containers on different physical
- machines. All your data is stored redundantly in 3 identical copies. In
- case of a failure of a container or the underlying physical machine,
- Zerops automatically disconnects the failed container from the cluster,
- creates a new container and syncs all data from the remaining 2 copies.
- Finally the broken container is automatically deleted.
-
-
- NON_HA
-
- Zerops will create a RabbitMQ message broker installed in a single
- container. Useful for non-essential data or dev environments.
-
-
- Your data is stored only in a single container. If the container or the
- underlying physical machine fails, your data since the last backup are
- lost. Zerops doesn't provide any automatic repairs of single node
- RabbitMQ services.
+ Zerops will create a RabbitMQ message broker installed in a single container. Useful for non-essential data or dev environments.
+
+ Your data is stored only in a single container. If the container or the underlying physical machine fails, your data since the last backup are lost. Zerops doesn't provide any automatic repairs of single node RabbitMQ services.
|
- |
- verticalAutoscaling
- |
-
- Optional. Defines{' '}
-
- custom auto scaling parameters
-
- .
+ | verticalAutoscaling |
+
+ Optional. Defines custom auto scaling parameters.
|
- |
diff --git a/apps/docs/content/references/ssh.mdx b/apps/docs/content/references/ssh.mdx
index 88322f92..1a550d1c 100644
--- a/apps/docs/content/references/ssh.mdx
+++ b/apps/docs/content/references/ssh.mdx
@@ -8,20 +8,20 @@ SSH access is available only for runtime services and web servers.
Database services, message brokers, and object storage are not accessible via SSH.
:::
-# Prerequisites
+## Prerequisites
Before establishing an SSH connection to your runtime service, you must first connect to the [Zerops VPN](/references/vpn).
-# Setting Up Your Connection
+## Setting Up Your Connection
-## 1. Configure VPN Access
+### 1. Configure VPN Access
The [Zerops CLI (zCLI)](/references/cli) comes bundled with the [Zerops VPN](/references/vpn) client. To connect to your [Zerops project](/features/infrastructure#project):
1. [Install and configure zCLI](/references/cli)
2. [Initialize the Zerops VPN connection](/references/vpn#start-the-vpn)
-## 2. Establish SSH Connection
+### 2. Establish SSH Connection
Once your VPN session is active, you can connect to any [service](/features/infrastructure#services--containers) using its hostname:
@@ -45,7 +45,7 @@ Are you sure you want to continue connecting (yes/no/[fingerprint])?
Type `yes` to trust the host and prevent future prompts.
-# Advanced Connection Options
+## Advanced Connection Options
@@ -68,7 +68,7 @@ ssh node-id-1.runtime.app.zerops
When using [HA mode](/features/scaling-ha), connecting to the service hostname will route you to a random container within that service.
:::
-# Container Naming Conventions
+## Container Naming Conventions
Each container in your project has a unique hostname following these patterns:
@@ -85,9 +85,9 @@ When your application [scales horizontally](https://docs.zerops.io/features/scal
Never connect to containers using their local IP addresses, as these addresses are dynamic and may change.
:::
-# Important Considerations
+## Important Considerations
-## Non-Persistent Changes
+### Non-Persistent Changes
SSH connections should not be used for making persistent changes to your service:
diff --git a/apps/docs/content/references/zeropsyml.mdx b/apps/docs/content/references/zeropsyml.mdx
index 007e663f..3ea937d2 100644
--- a/apps/docs/content/references/zeropsyml.mdx
+++ b/apps/docs/content/references/zeropsyml.mdx
@@ -5,22 +5,25 @@ description: Learn how you can configure your zerops yaml and use the available
import data from '@site/static/data.json';
import UnorderedCodeList from '@site/src/components/UnorderedCodeList';
+import GroupCards from '@site/src/components/GroupCards';
+
+export const languages = [
+ { name: "Node.js", link: "/nodejs/how-to/build-pipeline" },
+ { name: "PHP", link: "/php/how-to/build-pipeline" },
+ { name: "Python", link: "/python/how-to/build-pipeline" },
+ { name: "Go", link: "/go/how-to/build-pipeline" },
+ { name: ".NET", link: "/dotnet/how-to/build-pipeline" },
+ { name: "Rust", link: "/rust/how-to/build-pipeline" },
+ { name: "Java", link: "/java/how-to/build-pipeline" },
+ { name: "Nginx", link: "/nginx/how-to/build-pipeline" }
+]
The `zerops.yml` file is crucial for defining how Zerops should [build and deploy](/features/pipeline) your application.
Add the `zerops.yml` file to the **root of your repository** and customize it to suit your application's needs.
---
-## Quick Links to Runtime-Specific Guides
-
-- [Node.js](/nodejs/how-to/build-pipeline)
-- [PHP](/php/how-to/build-pipeline)
-- [Python](/python/how-to/build-pipeline)
-- [Go](/go/how-to/build-pipeline)
-- [.NET](/dotnet/how-to/build-pipeline)
-- [Rust](/rust/how-to/build-pipeline)
-- [Java](/java/how-to/build-pipeline)
-- [nginx static](/nginx/how-to/build-pipeline)
+
## Basic Structure
diff --git a/apps/docs/content/rust/how-to/build-pipeline.mdx b/apps/docs/content/rust/how-to/build-pipeline.mdx
index 6f8a68bf..ef169094 100644
--- a/apps/docs/content/rust/how-to/build-pipeline.mdx
+++ b/apps/docs/content/rust/how-to/build-pipeline.mdx
@@ -494,11 +494,30 @@ For example, to connect to a Rust service with hostname = "app" and port = 8080
Each port has following attributes:
-| parameter | description |
-| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| port | Defines the port number. You can set any port number between _10_ and _65435_. Ports outside this interval are reserved for internal Zerops systems. |
-| protocol | **Optional.** Defines the protocol. Allowed values are `TCP` or `UDP`. Default value is `TCP`. |
-| httpSupport | **Optional.** `httpSupport = true` is the default setting for TCP protocol. Set `httpSupport = false` if a web server isn't running on the port. Zerops uses this information for the configuration of [public access](/features/access). `httpSupport = true` is available only in combination with the TCP protocol. |
+
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | port |
+ Defines the port number. You can set any port number between 10 and 65435. Ports outside this interval are reserved for internal Zerops systems. |
+
+
+ | protocol |
+ Optional. Defines the protocol. Allowed values are TCP or UDP. Default value is TCP. |
+
+
+ | httpSupport |
+ Optional. httpSupport = true is the default setting for TCP protocol. Set httpSupport = false if a web server isn't running on the port. Zerops uses this information for the configuration of public access. httpSupport = true is available only in combination with the TCP protocol. |
+
+
+
+
### prepareCommands
@@ -722,9 +741,26 @@ Read more about how the [health check works] in Zerops.
Configures the health check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/rust/how-to/create#set-environment-variables) as your Rust application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your Rust application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
+
**Example:**
@@ -801,9 +837,26 @@ Read more about how the [readiness check works](/rust/how-to/deploy-process#read
Configures the readiness check to run a local command.
Following attributes are available:
-| Parameter | Description |
-| ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **command** | Defines a local command to be run.
The command has access to the same [environment variables](/rust/how-to/create#set-environment-variables) as your Rust application.
A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below. |
+
+
+
+
+ | Parameter |
+ Description |
+
+
+
+
+ | command |
+
+ Defines a local command to be run.
+ The command has access to the same environment variables as your Rust application.
+ A single string is required. If you need to run multiple commands create a shell script or, use a multiline format as in the example below.
+ |
+
+
+
+
**Example:**
diff --git a/apps/docs/content/rust/how-to/create.mdx b/apps/docs/content/rust/how-to/create.mdx
index 4227ca60..69f30bf4 100644
--- a/apps/docs/content/rust/how-to/create.mdx
+++ b/apps/docs/content/rust/how-to/create.mdx
@@ -77,11 +77,33 @@ Choose the CPU mode when starting a new service or change it later. The CPU mode
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
Rust service always starts with the minimal resources.
@@ -103,19 +125,21 @@ When a container needs more CPU or RAM but already consumes maximal resources de
Horizontal auto scaling has following default configuration:
-
+
+
+
+ | Parameter |
+ Value |
+
+
- |
- minimum containers
- |
- 1 |
+ minimum containers |
+ 1 |
- |
- maximum containers
- |
- 6 |
+ maximum containers |
+ 6 |
@@ -250,11 +274,33 @@ The hostname of the PostgreSQL service will be set to "db". The [single containe
The `project:` section is required. Only one project can be defined.
-| Parameter | Description | Limitations |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| **name** | The name of the new project. Duplicates are allowed. | |
-| **description** | **Optional.** Description of the new project. | Maximum 255 characters. |
-| **tags** | **Optional.** One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+
+
+
+ | Parameter |
+ Description |
+ Limitations |
+
+
+
+
+ | name |
+ The name of the new project. Duplicates are allowed. |
+ |
+
+
+ | description |
+ Optional. Description of the new project. |
+ Maximum 255 characters. |
+
+
+ | tags |
+ Optional. One or more string tags. Tags do not have a functional meaning, they only provide better orientation in projects. |
+ |
+
+
+
+
At least one service in `services:` section is required. You can create a project with multiple services. The example above contains Rust and PostgreSQL services but you can create a `description.yml` with your own combination of [services](/features/infrastructure).
diff --git a/apps/docs/content/rust/how-to/env-variables.mdx b/apps/docs/content/rust/how-to/env-variables.mdx
index b8748930..fbcca3fb 100644
--- a/apps/docs/content/rust/how-to/env-variables.mdx
+++ b/apps/docs/content/rust/how-to/env-variables.mdx
@@ -11,11 +11,32 @@ In Zerops you do not have to create a `.env` file manually. Zerops handles the e
There are 3 different sets of env variables in Zerops:
-| environment | type | defined in |
-| ----------- | ------ | ------------------------------------------------------------------------------- |
-| build | basic | [zerops.yml](/rust/how-to/build-pipeline#envvariables) |
-| runtime | basic | [zerops.yml](/rust/how-to/build-pipeline#envvariables-1) |
-| runtime | secret | [Zerops GUI](/rust/how-to/env-variables#set-secret-env-variables-in-zerops-gui) |
+
+
+
+ | Type |
+ Environment |
+ Defined in |
+
+
+
+
+ | basic |
+ build |
+ zerops.yml |
+
+
+ | basic |
+ runtime |
+ zerops.yml |
+
+
+ | secret |
+ runtime |
+ Zerops GUI |
+
+
+
Use the [secret env variables](/rust/how-to/create#set-secret-env-variables) for all sensitive data you don't want to store in your application code. Secret env variables are also useful if you need for testing where you need to change the value of some env variables frequently. Secret variables are managed in Zerops GUI and you don't have to redeploy your application.
diff --git a/apps/docs/content/rust/how-to/scaling.mdx b/apps/docs/content/rust/how-to/scaling.mdx
index a09da59d..6471a846 100644
--- a/apps/docs/content/rust/how-to/scaling.mdx
+++ b/apps/docs/content/rust/how-to/scaling.mdx
@@ -66,11 +66,33 @@ The CPU mode doesn't change automatically.
Vertical auto scaling has following default configuration:
-| | Minimum resource | Maximum resource |
-| ------------- | ---------------- | ---------------- |
-| **CPU cores** | 1 | 5 |
-| **RAM** | 0.25 GB | 32 GB |
-| **Disk** | 1 GB | 100 GB |
+
+
+
+ | Resources Type |
+ Minimum resource |
+ Maximum resource |
+
+
+
+
+ | CPU cores |
+ 1 |
+ 5 |
+
+
+ | RAM |
+ 0.25 GB |
+ 32 GB |
+
+
+ | Disk |
+ 1 GB |
+ 100 GB |
+
+
+
+
Rust service always starts with the minimal resources.
diff --git a/apps/docs/src/components/GroupCards/index.tsx b/apps/docs/src/components/GroupCards/index.tsx
new file mode 100644
index 00000000..02d4858a
--- /dev/null
+++ b/apps/docs/src/components/GroupCards/index.tsx
@@ -0,0 +1,36 @@
+import React from "react";
+
+interface CardItem {
+ name: string;
+ link: string;
+}
+
+interface GroupCardsProps {
+ emoji?: string;
+ heading: string;
+ items: CardItem[];
+}
+
+const GroupCards: React.FC = ({ items, heading, emoji }) => {
+ return (
+
+
+ {emoji}
+ {heading}
+
+
+ |