Document defaults

dmcgowan · dmcgowan · commit bae47820d71f · 2017-11-21T16:12:10.000-08:00
Signed-off-by: Derek McGowan &lt;derek@mcgstyle.net&gt;
diff --git a/api/services/images/v1/images.pb.go b/api/services/images/v1/images.pb.go
diff --git a/api/services/images/v1/images.proto b/api/services/images/v1/images.proto
@@ -118,5 +118,7 @@ message DeleteImageRequest {
 
 	// Sync indicates that the delete and cleanup should be done
 	// synchronously before returning to the caller
+	//
+	// Default is false
 	bool sync = 2;
 }
diff --git a/gc/scheduler/scheduler.go b/gc/scheduler/scheduler.go
@@ -230,6 +230,7 @@ func (s *gcScheduler) run(ctx context.Context) {
 		interval    = time.Second
 		gcTime      time.Duration
 		collections int
+		// TODO(dmcg): expose collection stats as metrics
 
 		triggered bool
 		deletions int
@@ -270,6 +271,7 @@ func (s *gcScheduler) run(ctx context.Context) {
 					(s.mutationThreshold > 0 && mutations >= s.mutationThreshold))) {
 				// Check if not already scheduled before delay threshold
 				if nextCollection == nil || nextCollection.After(time.Now().Add(s.scheduleDelay)) {
+					// TODO(dmcg): track re-schedules for tuning schedule config
 					schedC, nextCollection = schedule(s.scheduleDelay)
 				}
 			}
diff --git a/services/images/service.go b/services/images/service.go
@@ -36,7 +36,7 @@ func init() {
 				return nil, err
 			}
 
-			return NewService(m.(*metadata.DB), g.(gcScheduler), ic.Events), nil
+			return NewService(m.(*metadata.DB), ic.Events, g.(gcScheduler)), nil
 		},
 	})
 }
@@ -52,7 +52,7 @@ type service struct {
 }
 
 // NewService returns the GRPC image server
-func NewService(db *metadata.DB, gc gcScheduler, publisher events.Publisher) imagesapi.ImagesServer {
+func NewService(db *metadata.DB, publisher events.Publisher, gc gcScheduler) imagesapi.ImagesServer {
 	return &service{
 		db:        db,
 		gc:        gc,

Original file line number	Diff line number	Diff line change
`@@ -118,5 +118,7 @@ message DeleteImageRequest {`
`118`	`118`
`119`	`119`	`// Sync indicates that the delete and cleanup should be done`
`120`	`120`	`// synchronously before returning to the caller`
	`121`	`+ //`
	`122`	`+ // Default is false`
`121`	`123`	`bool sync = 2;`
`122`	`124`	`}`
Original file line number	Diff line number	Diff line change
`@@ -230,6 +230,7 @@ func (s *gcScheduler) run(ctx context.Context) {`
`230`	`230`	`interval = time.Second`
`231`	`231`	`gcTime time.Duration`
`232`	`232`	`collections int`
	`233`	`+ // TODO(dmcg): expose collection stats as metrics`
`233`	`234`
`234`	`235`	`triggered bool`
`235`	`236`	`deletions int`
`@@ -270,6 +271,7 @@ func (s *gcScheduler) run(ctx context.Context) {`
`270`	`271`	`(s.mutationThreshold > 0 && mutations >= s.mutationThreshold))) {`
`271`	`272`	`// Check if not already scheduled before delay threshold`
`272`	`273`	`if nextCollection == nil \|\| nextCollection.After(time.Now().Add(s.scheduleDelay)) {`
	`274`	`+ // TODO(dmcg): track re-schedules for tuning schedule config`
`273`	`275`	`schedC, nextCollection = schedule(s.scheduleDelay)`
`274`	`276`	`}`
`275`	`277`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ func init() {`
`36`	`36`	`return nil, err`
`37`	`37`	`}`
`38`	`38`
`39`		`- return NewService(m.(*metadata.DB), g.(gcScheduler), ic.Events), nil`
	`39`	`+ return NewService(m.(*metadata.DB), ic.Events, g.(gcScheduler)), nil`
`40`	`40`	`},`
`41`	`41`	`})`
`42`	`42`	`}`
`@@ -52,7 +52,7 @@ type service struct {`
`52`	`52`	`}`
`53`	`53`
`54`	`54`	`// NewService returns the GRPC image server`
`55`		`-func NewService(db *metadata.DB, gc gcScheduler, publisher events.Publisher) imagesapi.ImagesServer {`
	`55`	`+func NewService(db *metadata.DB, publisher events.Publisher, gc gcScheduler) imagesapi.ImagesServer {`
`56`	`56`	`return &service{`
`57`	`57`	`db: db,`
`58`	`58`	`gc: gc,`