From 4689b08d5ddc163dea8f43eb93c1ac16d28b17e2 Mon Sep 17 00:00:00 2001 From: Leslie Cheung Date: Thu, 17 Apr 2025 19:55:06 -0400 Subject: [PATCH 1/2] Clarify are supported only for rolling and canary deployments --- reference/configuration.html.markerb | 4 +++- reference/health-checks.html.markerb | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/reference/configuration.html.markerb b/reference/configuration.html.markerb index f25cf272b8..340b3a0624 100644 --- a/reference/configuration.html.markerb +++ b/reference/configuration.html.markerb @@ -693,7 +693,9 @@ This example uses the `curl` image to run a test. It checks that the Machine is * `kill_signal`: The signal to send to the test process if it runs too long. Defaults to the signal of the image, if a custom image is set. * `kill_timeout`: The time to wait before sending the kill signal. Defaults to the timeout of the image, if a custom image is set. -Machine checks are especially useful for canary deploys. `flyctl` will spawn a new Machine, ensure all machine capabilities are functional, and then deploy the rest of the Machines in your app. +Machine checks are especially useful for `canary` deploys. `flyctl` will spawn a new Machine, ensure all machine capabilities are functional, and then deploy the rest of the Machines in your app. + +Machine checks are supported for apps using the `rolling` and `canary` deployment strategies. ## The `mounts` section diff --git a/reference/health-checks.html.markerb b/reference/health-checks.html.markerb index 404eb38cce..d0c7ac3cfc 100644 --- a/reference/health-checks.html.markerb +++ b/reference/health-checks.html.markerb @@ -43,7 +43,7 @@ Service-level checks are configured using the [`[[services.tcp_checks]]`](/docs/ ## Machine checks -Machine health checks run only during deployments. They run a custom command inside an ephemeral Machine and can be used to verify app behavior beyond port or endpoint availability. They're useful for validating app readiness in more complex scenarios, such as confirming database connectivity or verifying that a key background service is up. These checks don't impact routing, but if a Machine check fails, the deployment will be stopped. +Machine health checks run only during deploys and are supported for apps using the `rolling` and `canary` deployment strategies. They run a custom command inside an ephemeral Machine and can be used to verify app behavior beyond port or endpoint availability. They're useful for validating app readiness in more complex scenarios, such as confirming database connectivity or verifying that a key background service is up. These checks don't impact routing, but if a Machine check fails, the deployment will be stopped. Machine checks are configured using the [`[[services.machine_checks]]`](/docs/reference/configuration/#services-machine_checks) and [`[[http_service.machine_checks]]`](/docs/reference/configuration/#the-http_service-machine_checks-section) sections. From b94a95a65351a9bb97b07894bb039ee03602ebb2 Mon Sep 17 00:00:00 2001 From: Leslie Cheung Date: Thu, 17 Apr 2025 19:56:47 -0400 Subject: [PATCH 2/2] Fix broken link to section --- reference/configuration.html.markerb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/configuration.html.markerb b/reference/configuration.html.markerb index 340b3a0624..5f722b4985 100644 --- a/reference/configuration.html.markerb +++ b/reference/configuration.html.markerb @@ -415,7 +415,7 @@ Times are in milliseconds unless units are specified. ### The `http_service.machine_checks` section -You can use the same `machine_checks` section for HTTP services as for [`services`](#services-machine-checks). The `machine_checks` section defines parameters for checking the health of a service. +You can use the same `machine_checks` section for HTTP services as for [`services`](#services-machine_checks). The `machine_checks` section defines parameters for checking the health of a service. ```toml [[http_service.machine_checks]]