From e1e28307be33a9c6e1e463edb82d40b771f6828c Mon Sep 17 00:00:00 2001 From: Lang Martin Date: Fri, 10 May 2019 11:15:35 -0400 Subject: [PATCH] new deploymentwatcher/doc.go for package level documentation --- nomad/deploymentwatcher/doc.go | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 nomad/deploymentwatcher/doc.go diff --git a/nomad/deploymentwatcher/doc.go b/nomad/deploymentwatcher/doc.go new file mode 100644 index 000000000..e1f366b3c --- /dev/null +++ b/nomad/deploymentwatcher/doc.go @@ -0,0 +1,7 @@ +// deploymentwatcher creates and tracks Deployments, which hold meta data describing the +// process of upgrading a running job to a new set of Allocations. This encompasses settings +// for canary deployments and blue/green rollouts. +// +// - The watcher is only enabled on the active raft leader. +// - func (w *deploymentWatcher) watch() is the main deploymentWatcher process +package deploymentwatcher