philipp/uncloud
1
0
Fork 0
mirror of https://github.com/psviderski/uncloud.git synced 2026-08-28 12:03:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: minor polish for rolling deployments doc

Browse Source
This commit is contained in:
Pasha Sviderski
2026-03-03 16:39:43 +10:00
parent 7b9bed0780
commit 3f1a772288
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
website/docs/4-guides/1-deployments/4-rolling-deployments.md
+6 -6
View File
@@ -76,9 +76,6 @@ is typically enough for a process in a container to initialise all its dependenc
You can change the monitoring period for a service with `deploy.update_config.monitor`. For example, increase it if your You can change the monitoring period for a service with `deploy.update_config.monitor`. For example, increase it if your
app takes longer to start or if you want to give it more time to recover from transient errors on startup. app takes longer to start or if you want to give it more time to recover from transient errors on startup.
Set it to `0s` to skip monitoring entirely if you are confident the new containers will start correctly and want to
speed up the deployment.
```yaml title="compose.yaml" ```yaml title="compose.yaml"
services: services:
app: app:
@@ -89,6 +86,9 @@ services:
monitor: 10s monitor: 10s
``` ```
Set it to `0s` to skip monitoring entirely if you are confident the new containers will start correctly and want to
speed up the deployment. A safer alternative is to configure a [health check](#health-checks) instead.
You can also change the default monitoring period (`5s`) for all services globally with an environment variable You can also change the default monitoring period (`5s`) for all services globally with an environment variable
`UNCLOUD_HEALTH_MONITOR_PERIOD`: `UNCLOUD_HEALTH_MONITOR_PERIOD`:
@@ -99,14 +99,14 @@ export UNCLOUD_HEALTH_MONITOR_PERIOD=10s
export UNCLOUD_HEALTH_MONITOR_PERIOD=0s export UNCLOUD_HEALTH_MONITOR_PERIOD=0s
``` ```
`deploy.update_config.monitor` overrides the global default for each service. `deploy.update_config.monitor` overrides the global default for that service.
### Health checks ### Health checks
If your container has a [`healthcheck`](https://github.com/compose-spec/compose-spec/blob/main/spec.md#healthcheck) If your service has a [`healthcheck`](https://github.com/compose-spec/compose-spec/blob/main/spec.md#healthcheck)
configured, Uncloud also checks its health status during and after the monitoring period. configured, Uncloud also checks its health status during and after the monitoring period.
If the container becomes `healthy` before the monitoring period ends, the deployment succeeds early and moves on to the If a container becomes `healthy` before the monitoring period ends, the deployment succeeds early and moves on to the
next container. If the container is `unhealthy` after the monitoring period, Uncloud next container. If the container is `unhealthy` after the monitoring period, Uncloud
[rolls it back](#rollback-on-failure) and fails the deployment. Transient `unhealthy` states during the monitoring [rolls it back](#rollback-on-failure) and fails the deployment. Transient `unhealthy` states during the monitoring
period are tolerated to give the container time to recover from startup issues. period are tolerated to give the container time to recover from startup issues.