From 80e28a5c1772a1b5f25c43d85880c4448cf342fa Mon Sep 17 00:00:00 2001 From: Tim Gross Date: Wed, 17 Feb 2021 14:03:06 -0500 Subject: [PATCH] docs updates and changelog entry --- CHANGELOG.md | 1 + .../content/docs/job-specification/update.mdx | 21 +++++++++++-------- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5aae22c0a243..a5835f6ac8ef 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,6 +23,7 @@ BUG FIXES: * consul/connect: Fixed a bug preventing more than one connect gateway per Nomad client [[GH-9849](https://github.com/hashicorp/nomad/pull/9849)] * consul/connect: Fixed a bug where connect sidecar services would be re-registered unnecessarily. [[GH-10059](https://github.com/hashicorp/nomad/pull/10059)] * consul/connect: Fixed a bug where the sidecar health checks would fail if `host_network` was defined. [[GH-9975](https://github.com/hashicorp/nomad/issues/9975)] + * deployments: Fixed a bug where deployments with multiple task groups and manual promotion would fail if promoted after the progress deadline. [[GH-10042](https://github.com/hashicorp/nomad/issues/10042)] * drivers/docker: Fixed a bug preventing multiple ports to be mapped to the same container port [[GH-9951](https://github.com/hashicorp/nomad/issues/9951)] * driver/qemu: Fixed a bug where network namespaces were not supported for QEMU workloads [[GH-9861](https://github.com/hashicorp/nomad/pull/9861)] * nomad/structs: Fixed a bug where static ports with the same value but different `host_network` were invalid [[GH-9946](https://github.com/hashicorp/nomad/issues/9946)] diff --git a/website/content/docs/job-specification/update.mdx b/website/content/docs/job-specification/update.mdx index 2f316afd1a39..74a5bd9146f5 100644 --- a/website/content/docs/job-specification/update.mdx +++ b/website/content/docs/job-specification/update.mdx @@ -83,20 +83,23 @@ a future release. - `progress_deadline` `(string: "10m")` - Specifies the deadline in which an allocation must be marked as healthy. The deadline begins when the first allocation for the deployment is created and is reset whenever an allocation - as part of the deployment transitions to a healthy state. If no allocation - transitions to the healthy state before the progress deadline, the deployment - is marked as failed. If the `progress_deadline` is set to `0`, the first - allocation to be marked as unhealthy causes the deployment to fail. This is - specified using a label suffix like "2m" or "1h". + as part of the deployment transitions to a healthy state or when a + deployment is manually promoted. If no allocation transitions to the healthy + state before the progress deadline, the deployment is marked as failed. If + the `progress_deadline` is set to `0`, the first allocation to be marked as + unhealthy causes the deployment to fail. This is specified using a label + suffix like "2m" or "1h". - `auto_revert` `(bool: false)` - Specifies if the job should auto-revert to the last stable job on deployment failure. A job is marked as stable if all the allocations as part of its deployment were marked healthy. -- `auto_promote` `(bool: false)` - Specifies if the job should auto-promote to the - canary version when all canaries become healthy during a deployment. Defaults to - false which means canaries must be manually updated with the `nomad deployment promote` - command. +- `auto_promote` `(bool: false)` - Specifies if the job should auto-promote to + the canary version when all canaries become healthy during a + deployment. Defaults to false which means canaries must be manually updated + with the `nomad deployment promote` command. If a job has multiple task + groups, all must be set to `auto_promote = true` in order for the deployment + to be promoted automatically. - `canary` `(int: 0)` - Specifies that changes to the job that would result in destructive updates should create the specified number of canaries without