new deploymentwatcher/doc.go for package level documentation

This commit is contained in:
Lang Martin 2019-05-10 11:15:35 -04:00
parent 2a026d7a7d
commit e1e28307be
1 changed files with 7 additions and 0 deletions

View File

@ -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