Skip to content

Commit

Permalink
docs: update the comments of manager's Run and update workloadRef
Browse files Browse the repository at this point in the history
Signed-off-by: Hui Kang <[email protected]>
  • Loading branch information
Hui Kang committed May 10, 2021
1 parent 32d37d8 commit 0b24f26
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
5 changes: 2 additions & 3 deletions controller/controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -252,10 +252,9 @@ func NewManager(
return cm
}

// Run will set up the event handlers for types we are interested in, as well
// as syncing informer caches and starting workers. It will block until stopCh
// Run will sync informer caches and start controllers. It will block until stopCh
// is closed, at which point it will shutdown the workqueue and wait for
// workers to finish processing their current work items.
// controllers to finish processing their current work items.
func (c *Manager) Run(rolloutThreadiness, serviceThreadiness, ingressThreadiness, experimentThreadiness, analysisThreadiness int, stopCh <-chan struct{}) error {
defer runtime.HandleCrash()
defer c.serviceWorkqueue.ShutDown()
Expand Down
1 change: 1 addition & 0 deletions docs/migrating.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ Instead of removing Deployment you can scale-down in to zero and reference from
1. Create a Rollout resource.
1. Reference an existing Deployment using `workloadRef` field.
1. Scale-down existing Deployment by changing `replicas` field of an existing Deployment to zero.
1. To perform an update, the change should be made to the Pod template field of the Deployment.

Below is an example of a Rollout resource referencing a Deployment.

Expand Down

0 comments on commit 0b24f26

Please sign in to comment.