ansible/ansible-collection-docker-compose-app
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

document new health check and compose project variables

Browse Source
This commit is contained in:
patrick
2026-07-16 17:01:43 -04:00
parent 05c933e2e0
commit 7f9758a924
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -2
View File
@@ -209,7 +209,7 @@ ansible-playbook --tags update site.yml
**Update process:** **Update process:**
1. Stops the application 1. Stops the application
2. Pulls latest images for all services 2. Pulls images according to `app_compose_pull` (defaults to `policy`; set to `always` to force fresh pulls)
3. Recreates containers with new images 3. Recreates containers with new images
4. Runs health checks (if enabled) 4. Runs health checks (if enabled)
@@ -309,8 +309,9 @@ The file will be copied as-is to the application directory without Jinja2 proces
| `app_compose_file` | - | Static compose file path | | `app_compose_file` | - | Static compose file path |
| `app_compose_content` | - | Inline compose content | | `app_compose_content` | - | Inline compose content |
| `app_compose_validate` | `true` | Validate compose syntax | | `app_compose_validate` | `true` | Validate compose syntax |
| `app_compose_pull` | `policy` | Image pull strategy | | `app_compose_pull` | `policy` | Image pull strategy (also used by `update` — set to `always` to force pulls on update) |
| `app_compose_recreate` | `auto` | Container recreate strategy | | `app_compose_recreate` | `auto` | Container recreate strategy |
| `app_compose_project_name` | `{{ app_dir \| basename }}` | Compose project name; override when your compose file sets a non-default project name |
### Backup Configuration ### Backup Configuration
@@ -335,6 +336,7 @@ The file will be copied as-is to the application directory without Jinja2 proces
|----------|---------|-------------| |----------|---------|-------------|
| `app_health_check` | `true` | Enable health checks | | `app_health_check` | `true` | Enable health checks |
| `app_health_check_method` | `docker` | Check method (`docker`/`http`) | | `app_health_check_method` | `docker` | Check method (`docker`/`http`) |
| `app_container_name` | `{{ app_name }}` | Container name inspected by the `docker` health check; override when your compose service uses a different `container_name` |
| `app_health_check_url` | - | HTTP endpoint for health check | | `app_health_check_url` | - | HTTP endpoint for health check |
| `app_health_check_retries` | `30` | Number of check retries | | `app_health_check_retries` | `30` | Number of check retries |
| `app_health_check_delay` | `10` | Delay between checks (seconds) | | `app_health_check_delay` | `10` | Delay between checks (seconds) |