document "Deployments" in the Concepts section

[wimax-grapl]

Proposal

I'd like to see a minimal description of a Deployment on https://www.nomadproject.io/docs/concepts/architecture that compare-contrasts it to, say, an Allocation.

Use-cases

My use case is the following: I was trying to reverse-engineer the job-success monitoring that goes on when you nomad job run, which was introduced here:
#10661
It relies on the Deployment api, which is not well documented publicly. Or rather, you'll get stuff like "The /deployment endpoints are used to query for and interact with deployments.", which skirts telling you what concept this represents!

While it looks like it's a collection of Allocation IDs, I'm genuinely just unsure.

Attempted Solutions

this is a documentation request

[schmichael]

Great idea! We're hoping to have a little docs sprint soon, and this is on our TODO list.

[wimax-grapl]

Glad to hear!

…

On Wed, Jul 13, 2022, 5:30 PM Michael Schurter ***@***.***> wrote: Great idea! We're hoping to have a little docs sprint soon, and this is on our TODO list. — Reply to this email directly, view it on GitHub <#13731 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AQOPO7ICTIBK7QEAJ33ZECTVT4YPJANCNFSM53MVXLWA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[tgross]

Notes from dupe #10581:

The deployment logic is currently hand-wavy and interactions: canaries, deployment timeouts, node health, etc. Create concept documentation for deployments that contains diagrams showing the state transitions that occur during deployments.

[tgross]

Fixed by #14750

[github-actions]

I'm going to lock this issue because it has been closed for 120 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.