From 3f1a7722889bd4b83b54e9f2218f884b63020705 Mon Sep 17 00:00:00 2001 From: Pasha Sviderski Date: Tue, 3 Mar 2026 16:39:43 +1000 Subject: [PATCH] docs: minor polish for rolling deployments doc --- .../4-guides/1-deployments/4-rolling-deployments.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/website/docs/4-guides/1-deployments/4-rolling-deployments.md b/website/docs/4-guides/1-deployments/4-rolling-deployments.md index 1df274ae..aa70e997 100644 --- a/website/docs/4-guides/1-deployments/4-rolling-deployments.md +++ b/website/docs/4-guides/1-deployments/4-rolling-deployments.md @@ -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 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" services: app: @@ -89,6 +86,9 @@ services: 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 `UNCLOUD_HEALTH_MONITOR_PERIOD`: @@ -99,14 +99,14 @@ export UNCLOUD_HEALTH_MONITOR_PERIOD=10s 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 -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. -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 [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.