Skip to content

Commit 2b19a4d

Browse files
committed
fix cmd/kube-controller-manager's golint failures
1 parent f01c140 commit 2b19a4d

File tree

5 files changed

+15
-5
lines changed

5 files changed

+15
-5
lines changed

cmd/kube-controller-manager/app/controllermanager.go

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,19 @@ import (
7272
)
7373

7474
const (
75-
// Jitter used when starting controller managers
75+
// ControllerStartJitter is the Jitter used when starting controller managers
7676
ControllerStartJitter = 1.0
7777
// ConfigzName is the name used for register kube-controller manager /configz, same with GroupName.
7878
ConfigzName = "kubecontrollermanager.config.k8s.io"
7979
)
8080

81+
// ControllerLoopMode is the kube-controller-manager's mode of running controller loops that are cloud provider dependent
8182
type ControllerLoopMode int
8283

8384
const (
85+
// IncludeCloudLoops means the kube-controller-manager include the controller loops that are cloud provider dependent
8486
IncludeCloudLoops ControllerLoopMode = iota
87+
// ExternalLoops means the kube-controller-manager exclude the controller loops that are cloud provider dependent
8588
ExternalLoops
8689
)
8790

@@ -284,6 +287,7 @@ func Run(c *config.CompletedConfig, stopCh <-chan struct{}) error {
284287
panic("unreachable")
285288
}
286289

290+
// ControllerContext defines the context object for controller
287291
type ControllerContext struct {
288292
// ClientBuilder will provide a client for this controller to use
289293
ClientBuilder controller.ControllerClientBuilder
@@ -328,6 +332,7 @@ type ControllerContext struct {
328332
ResyncPeriod func() time.Duration
329333
}
330334

335+
// IsControllerEnabled checks if the context's controllers enabled or not
331336
func (c ControllerContext) IsControllerEnabled(name string) bool {
332337
return genericcontrollermanager.IsControllerEnabled(name, ControllersDisabledByDefault, c.ComponentConfig.Generic.Controllers)
333338
}
@@ -337,6 +342,7 @@ func (c ControllerContext) IsControllerEnabled(name string) bool {
337342
// The bool indicates whether the controller was enabled.
338343
type InitFunc func(ctx ControllerContext) (debuggingHandler http.Handler, enabled bool, err error)
339344

345+
// KnownControllers returns all known controllers's name
340346
func KnownControllers() []string {
341347
ret := sets.StringKeySet(NewControllerInitializers(IncludeCloudLoops))
342348

@@ -351,6 +357,7 @@ func KnownControllers() []string {
351357
return ret.List()
352358
}
353359

360+
// ControllersDisabledByDefault is the set of controllers which is disabled by default
354361
var ControllersDisabledByDefault = sets.NewString(
355362
"bootstrapsigner",
356363
"tokencleaner",
@@ -405,8 +412,9 @@ func NewControllerInitializers(loopMode ControllerLoopMode) map[string]InitFunc
405412
return controllers
406413
}
407414

415+
// GetAvailableResources gets the map which contains all available resources of the apiserver
408416
// TODO: In general, any controller checking this needs to be dynamic so
409-
// users don't have to restart their controller manager if they change the apiserver.
417+
// users don't have to restart their controller manager if they change the apiserver.
410418
// Until we get there, the structure here needs to be exposed for the construction of a proper ControllerContext.
411419
func GetAvailableResources(clientBuilder controller.ControllerClientBuilder) (map[schema.GroupVersionResource]bool, error) {
412420
client := clientBuilder.ClientOrDie("controller-discovery")
@@ -484,6 +492,7 @@ func CreateControllerContext(s *config.CompletedConfig, rootClientBuilder, clien
484492
return ctx, nil
485493
}
486494

495+
// StartControllers starts a set of controllers with a specified ControllerContext
487496
func StartControllers(ctx ControllerContext, startSATokenController InitFunc, controllers map[string]InitFunc, unsecuredMux *mux.PathRecorderMux) error {
488497
// Always start the SA token controller first using a full-power client, since it needs to mint tokens for the rest
489498
// If this fails, just return here and fail since other controllers won't be able to get credentials.

cmd/kube-controller-manager/app/import_known_versions.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,13 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
*/
1616

17+
// Package app imports the API groups that the client will support
1718
// TODO: Remove this file when namespace controller and garbage collector
1819
// stops using legacyscheme.Registry.RESTMapper()
1920
package app
2021

21-
// These imports are the API groups the client will support.
2222
import (
23+
// These imports are the API groups the client will support.
2324
_ "k8s.io/kubernetes/pkg/apis/apps/install"
2425
_ "k8s.io/kubernetes/pkg/apis/authentication/install"
2526
_ "k8s.io/kubernetes/pkg/apis/authorization/install"

cmd/kube-controller-manager/app/plugins.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ import (
2727

2828
// Cloud providers
2929
cloudprovider "k8s.io/cloud-provider"
30+
// ensure the cloud providers are installed
3031
_ "k8s.io/kubernetes/pkg/cloudprovider/providers"
3132
// Volume plugins
3233
"k8s.io/kubernetes/pkg/volume"

hack/.golint_failures

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
cmd/cloud-controller-manager/app/apis/config/v1alpha1
22
cmd/kube-apiserver/app
3-
cmd/kube-controller-manager/app
43
cmd/kubeadm/app/apis/kubeadm/v1beta1
54
cmd/kubeadm/app/apis/kubeadm/v1beta2
65
pkg/apis/abac/latest

test/integration/apiserver/admissionwebhook/broken_webhook_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ func exampleDeployment(name string) *appsv1.Deployment {
150150

151151
func brokenWebhookConfig(name string) *admissionregistrationv1beta1.ValidatingWebhookConfiguration {
152152
var path string
153-
var failurePolicy = admissionregistrationv1beta1.Fail
153+
failurePolicy := admissionregistrationv1beta1.Fail
154154
return &admissionregistrationv1beta1.ValidatingWebhookConfiguration{
155155
ObjectMeta: metav1.ObjectMeta{
156156
Name: name,

0 commit comments

Comments
 (0)