From 83d53ea1c2aeda3619c3aafeb9cf7e50c124058e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lucas=20K=C3=A4ldstr=C3=B6m?= Date: Thu, 6 Sep 2018 13:42:02 +0300 Subject: [PATCH] Standardize componentconfig code/comment patterns --- api/api-rules/violation_exceptions.list | 1 + .../app/apis/config/register.go | 2 +- .../app/apis/config/v1alpha1/register.go | 2 +- pkg/controller/apis/config/register.go | 8 +++---- pkg/controller/apis/config/v1alpha1/doc.go | 1 + .../apis/config/v1alpha1/register.go | 5 +++- .../config/v1alpha1/zz_generated.deepcopy.go | 21 ++++++++++++++++ pkg/kubelet/apis/config/doc.go | 2 +- pkg/kubelet/apis/config/register.go | 24 +++++++------------ pkg/kubelet/apis/config/v1beta1/register.go | 7 ++++-- pkg/proxy/apis/config/doc.go | 1 + pkg/proxy/apis/config/register.go | 24 +++++++------------ pkg/proxy/apis/config/v1alpha1/doc.go | 1 + pkg/proxy/apis/config/v1alpha1/register.go | 8 ++++--- pkg/scheduler/apis/config/doc.go | 1 + pkg/scheduler/apis/config/register.go | 18 +++++++------- pkg/scheduler/apis/config/v1alpha1/doc.go | 1 + .../apis/config/v1alpha1/register.go | 7 ++++-- .../pkg/apis/config/v1alpha1/register.go | 8 +++++-- .../pkg/apis/config/v1alpha1/register.go | 8 +++++-- .../config/v1alpha1/register.go | 8 +++---- .../k8s.io/kube-proxy/config/v1alpha1/doc.go | 2 ++ .../kube-proxy/config/v1alpha1/register.go | 18 +++++--------- .../src/k8s.io/kube-scheduler/Godeps/Readme | 5 ++++ staging/src/k8s.io/kube-scheduler/README.md | 12 +++++----- .../kube-scheduler/config/v1alpha1/doc.go | 2 ++ .../config/v1alpha1/register.go | 20 +++++----------- .../k8s.io/kubelet/config/v1beta1/register.go | 18 +++++--------- 28 files changed, 127 insertions(+), 108 deletions(-) create mode 100644 pkg/controller/apis/config/v1alpha1/zz_generated.deepcopy.go create mode 100644 staging/src/k8s.io/kube-scheduler/Godeps/Readme diff --git a/api/api-rules/violation_exceptions.list b/api/api-rules/violation_exceptions.list index 30b2a81e9e..4bb9079c92 100644 --- a/api/api-rules/violation_exceptions.list +++ b/api/api-rules/violation_exceptions.list @@ -162,6 +162,7 @@ API rule violation: names_match,k8s.io/kube-controller-manager/config/v1alpha1,V API rule violation: names_match,k8s.io/kube-controller-manager/config/v1alpha1,VolumeConfiguration,EnableDynamicProvisioning API rule violation: names_match,k8s.io/kube-controller-manager/config/v1alpha1,VolumeConfiguration,PersistentVolumeRecyclerConfiguration API rule violation: names_match,k8s.io/kube-controller-manager/config/v1alpha1,VolumeConfiguration,FlexVolumePluginDir +API rule violation: names_match,k8s.io/kube-proxy/config/v1alpha1,KubeProxyConfiguration,IPTables API rule violation: names_match,k8s.io/kubelet/config/v1beta1,KubeletConfiguration,ResolverConfig API rule violation: names_match,k8s.io/kubelet/config/v1beta1,KubeletConfiguration,IPTablesMasqueradeBit API rule violation: names_match,k8s.io/kubelet/config/v1beta1,KubeletConfiguration,IPTablesDropBit diff --git a/cmd/cloud-controller-manager/app/apis/config/register.go b/cmd/cloud-controller-manager/app/apis/config/register.go index ec81c6fc7f..c6f63f7b1c 100644 --- a/cmd/cloud-controller-manager/app/apis/config/register.go +++ b/cmd/cloud-controller-manager/app/apis/config/register.go @@ -21,7 +21,7 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" ) -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "cloudcontrollermanager.config.k8s.io" // SchemeGroupVersion is group version used to register these objects diff --git a/cmd/cloud-controller-manager/app/apis/config/v1alpha1/register.go b/cmd/cloud-controller-manager/app/apis/config/v1alpha1/register.go index e72a67a924..c862f5587b 100644 --- a/cmd/cloud-controller-manager/app/apis/config/v1alpha1/register.go +++ b/cmd/cloud-controller-manager/app/apis/config/v1alpha1/register.go @@ -33,7 +33,7 @@ var ( // localSchemeBuilder ïs a pointer to SchemeBuilder instance. Using localSchemeBuilder // defaulting and conversion init funcs are registered as well. localSchemeBuilder = &SchemeBuilder - // AddToScheme is a global function that registers this API group & version to a schema + // AddToScheme is a global function that registers this API group & version to a scheme AddToScheme = localSchemeBuilder.AddToScheme ) diff --git a/pkg/controller/apis/config/register.go b/pkg/controller/apis/config/register.go index 26a1e8f1af..6245336819 100644 --- a/pkg/controller/apis/config/register.go +++ b/pkg/controller/apis/config/register.go @@ -21,20 +21,20 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" ) -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubecontrollermanager.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal} var ( - // SchemeBuilder providers the handle of collects functions that add things to a scheme + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) - // AddToScheme applies all the stored functions to the scheme. A non-nil error - // indicates that one function failed and the attempt was abandoned. + // AddToScheme is a global function that registers this API group & version to a scheme AddToScheme = SchemeBuilder.AddToScheme ) +// addKnownTypes registers known types to the given scheme func addKnownTypes(scheme *runtime.Scheme) error { scheme.AddKnownTypes(SchemeGroupVersion, &KubeControllerManagerConfiguration{}, diff --git a/pkg/controller/apis/config/v1alpha1/doc.go b/pkg/controller/apis/config/v1alpha1/doc.go index fe43aa2330..a626d2095a 100644 --- a/pkg/controller/apis/config/v1alpha1/doc.go +++ b/pkg/controller/apis/config/v1alpha1/doc.go @@ -14,6 +14,7 @@ See the License for the specific language governing permissions and limitations under the License. */ +// +k8s:deepcopy-gen=package // +k8s:conversion-gen=k8s.io/kubernetes/pkg/controller/apis/config // +k8s:conversion-gen-external-types=k8s.io/kube-controller-manager/config/v1alpha1 // +k8s:defaulter-gen=TypeMeta diff --git a/pkg/controller/apis/config/v1alpha1/register.go b/pkg/controller/apis/config/v1alpha1/register.go index 23057ab166..b46f65b00b 100644 --- a/pkg/controller/apis/config/v1alpha1/register.go +++ b/pkg/controller/apis/config/v1alpha1/register.go @@ -28,8 +28,11 @@ const GroupName = "kubecontrollermanager.config.k8s.io" var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} var ( + // localSchemeBuilder extends the SchemeBuilder instance with the external types. In this package, + // defaulting and conversion init funcs are registered as well. localSchemeBuilder = &kubectrlmgrconfigv1alpha1.SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = localSchemeBuilder.AddToScheme ) func init() { diff --git a/pkg/controller/apis/config/v1alpha1/zz_generated.deepcopy.go b/pkg/controller/apis/config/v1alpha1/zz_generated.deepcopy.go new file mode 100644 index 0000000000..0ec19467c4 --- /dev/null +++ b/pkg/controller/apis/config/v1alpha1/zz_generated.deepcopy.go @@ -0,0 +1,21 @@ +// +build !ignore_autogenerated + +/* +Copyright The Kubernetes Authors. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +*/ + +// Code generated by deepcopy-gen. DO NOT EDIT. + +package v1alpha1 diff --git a/pkg/kubelet/apis/config/doc.go b/pkg/kubelet/apis/config/doc.go index a38c55abda..ad40e68340 100644 --- a/pkg/kubelet/apis/config/doc.go +++ b/pkg/kubelet/apis/config/doc.go @@ -15,6 +15,6 @@ limitations under the License. */ // +k8s:deepcopy-gen=package -// TODO: This file should also enable openapi-gen like the other packages +// +groupName=kubelet.config.k8s.io package config // import "k8s.io/kubernetes/pkg/kubelet/apis/config" diff --git a/pkg/kubelet/apis/config/register.go b/pkg/kubelet/apis/config/register.go index 450e5802fb..cbebd990ab 100644 --- a/pkg/kubelet/apis/config/register.go +++ b/pkg/kubelet/apis/config/register.go @@ -21,29 +21,21 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" ) -var ( - SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) - AddToScheme = SchemeBuilder.AddToScheme -) - -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubelet.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal} -// Kind takes an unqualified kind and returns a Group qualified GroupKind -func Kind(kind string) schema.GroupKind { - return SchemeGroupVersion.WithKind(kind).GroupKind() -} - -// Resource takes an unqualified resource and returns a Group qualified GroupResource -func Resource(resource string) schema.GroupResource { - return SchemeGroupVersion.WithResource(resource).GroupResource() -} +var ( + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package + SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = SchemeBuilder.AddToScheme +) +// addKnownTypes registers known types to the given scheme func addKnownTypes(scheme *runtime.Scheme) error { - // TODO this will get cleaned up with the scheme types are fixed scheme.AddKnownTypes(SchemeGroupVersion, &KubeletConfiguration{}, &SerializedNodeConfigSource{}, diff --git a/pkg/kubelet/apis/config/v1beta1/register.go b/pkg/kubelet/apis/config/v1beta1/register.go index b458bb4d97..1b981b5791 100644 --- a/pkg/kubelet/apis/config/v1beta1/register.go +++ b/pkg/kubelet/apis/config/v1beta1/register.go @@ -21,15 +21,18 @@ import ( kubeletconfigv1beta1 "k8s.io/kubelet/config/v1beta1" ) -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubelet.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"} var ( + // localSchemeBuilder extends the SchemeBuilder instance with the external types. In this package, + // defaulting and conversion init funcs are registered as well. localSchemeBuilder = &kubeletconfigv1beta1.SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = localSchemeBuilder.AddToScheme ) func init() { diff --git a/pkg/proxy/apis/config/doc.go b/pkg/proxy/apis/config/doc.go index efe1727555..64cad5ced1 100644 --- a/pkg/proxy/apis/config/doc.go +++ b/pkg/proxy/apis/config/doc.go @@ -15,5 +15,6 @@ limitations under the License. */ // +k8s:deepcopy-gen=package +// +groupName=kubeproxy.config.k8s.io package config // import "k8s.io/kubernetes/pkg/proxy/apis/config" diff --git a/pkg/proxy/apis/config/register.go b/pkg/proxy/apis/config/register.go index c4032da711..fda569221c 100644 --- a/pkg/proxy/apis/config/register.go +++ b/pkg/proxy/apis/config/register.go @@ -21,29 +21,21 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" ) -var ( - SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) - AddToScheme = SchemeBuilder.AddToScheme -) - -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubeproxy.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal} -// Kind takes an unqualified kind and returns a Group qualified GroupKind -func Kind(kind string) schema.GroupKind { - return SchemeGroupVersion.WithKind(kind).GroupKind() -} - -// Resource takes an unqualified resource and returns a Group qualified GroupResource -func Resource(resource string) schema.GroupResource { - return SchemeGroupVersion.WithResource(resource).GroupResource() -} +var ( + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package + SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = SchemeBuilder.AddToScheme +) +// addKnownTypes registers known types to the given scheme func addKnownTypes(scheme *runtime.Scheme) error { - // TODO this will get cleaned up with the scheme types are fixed scheme.AddKnownTypes(SchemeGroupVersion, &KubeProxyConfiguration{}, ) diff --git a/pkg/proxy/apis/config/v1alpha1/doc.go b/pkg/proxy/apis/config/v1alpha1/doc.go index a1e7d2c417..1a8eece234 100644 --- a/pkg/proxy/apis/config/v1alpha1/doc.go +++ b/pkg/proxy/apis/config/v1alpha1/doc.go @@ -20,4 +20,5 @@ limitations under the License. // +k8s:defaulter-gen=TypeMeta // +k8s:defaulter-gen-input=../../../../../vendor/k8s.io/kube-proxy/config/v1alpha1 // +groupName=kubeproxy.config.k8s.io + package v1alpha1 // import "k8s.io/kubernetes/pkg/proxy/apis/config/v1alpha1" diff --git a/pkg/proxy/apis/config/v1alpha1/register.go b/pkg/proxy/apis/config/v1alpha1/register.go index e21fa22982..a053b1e778 100644 --- a/pkg/proxy/apis/config/v1alpha1/register.go +++ b/pkg/proxy/apis/config/v1alpha1/register.go @@ -21,16 +21,18 @@ import ( kubeproxyconfigv1alpha1 "k8s.io/kube-proxy/config/v1alpha1" ) -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubeproxy.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} var ( - // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. + // localSchemeBuilder extends the SchemeBuilder instance with the external types. In this package, + // defaulting and conversion init funcs are registered as well. localSchemeBuilder = &kubeproxyconfigv1alpha1.SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = localSchemeBuilder.AddToScheme ) func init() { diff --git a/pkg/scheduler/apis/config/doc.go b/pkg/scheduler/apis/config/doc.go index 3f8e379d13..896eaa83b6 100644 --- a/pkg/scheduler/apis/config/doc.go +++ b/pkg/scheduler/apis/config/doc.go @@ -15,5 +15,6 @@ limitations under the License. */ // +k8s:deepcopy-gen=package +// +groupName=kubescheduler.config.k8s.io package config // import "k8s.io/kubernetes/pkg/scheduler/apis/config" diff --git a/pkg/scheduler/apis/config/register.go b/pkg/scheduler/apis/config/register.go index b697315e2f..bb2c6bad89 100644 --- a/pkg/scheduler/apis/config/register.go +++ b/pkg/scheduler/apis/config/register.go @@ -21,20 +21,20 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" ) -var ( - // SchemeBuilder the schema builder - SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) - // AddToScheme handler to add items to the schema - AddToScheme = SchemeBuilder.AddToScheme -) - -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubescheduler.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal} -// Adds the list of known types to the given scheme. +var ( + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package + SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = SchemeBuilder.AddToScheme +) + +// addKnownTypes registers known types to the given scheme func addKnownTypes(scheme *runtime.Scheme) error { scheme.AddKnownTypes(SchemeGroupVersion, &KubeSchedulerConfiguration{}, diff --git a/pkg/scheduler/apis/config/v1alpha1/doc.go b/pkg/scheduler/apis/config/v1alpha1/doc.go index 6fe59990c4..44518561fd 100644 --- a/pkg/scheduler/apis/config/v1alpha1/doc.go +++ b/pkg/scheduler/apis/config/v1alpha1/doc.go @@ -19,5 +19,6 @@ limitations under the License. // +k8s:conversion-gen-external-types=k8s.io/kube-scheduler/config/v1alpha1 // +k8s:defaulter-gen=TypeMeta // +k8s:defaulter-gen-input=../../../../../vendor/k8s.io/kube-scheduler/config/v1alpha1 +// +groupName=kubescheduler.config.k8s.io package v1alpha1 // import "k8s.io/kubernetes/pkg/scheduler/apis/config/v1alpha1" diff --git a/pkg/scheduler/apis/config/v1alpha1/register.go b/pkg/scheduler/apis/config/v1alpha1/register.go index 406d4fb60d..0e9db36a6b 100644 --- a/pkg/scheduler/apis/config/v1alpha1/register.go +++ b/pkg/scheduler/apis/config/v1alpha1/register.go @@ -21,15 +21,18 @@ import ( kubeschedulerconfigv1alpha1 "k8s.io/kube-scheduler/config/v1alpha1" ) -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubescheduler.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} var ( + // localSchemeBuilder extends the SchemeBuilder instance with the external types. In this package, + // defaulting and conversion init funcs are registered as well. localSchemeBuilder = &kubeschedulerconfigv1alpha1.SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = localSchemeBuilder.AddToScheme ) func init() { diff --git a/staging/src/k8s.io/apimachinery/pkg/apis/config/v1alpha1/register.go b/staging/src/k8s.io/apimachinery/pkg/apis/config/v1alpha1/register.go index c09c163897..ddc186c9aa 100644 --- a/staging/src/k8s.io/apimachinery/pkg/apis/config/v1alpha1/register.go +++ b/staging/src/k8s.io/apimachinery/pkg/apis/config/v1alpha1/register.go @@ -21,7 +21,11 @@ import ( ) var ( - SchemeBuilder runtime.SchemeBuilder + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package + SchemeBuilder runtime.SchemeBuilder + // localSchemeBuilder extends the SchemeBuilder instance with the external types. In this package, + // defaulting and conversion init funcs are registered as well. localSchemeBuilder = &SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = localSchemeBuilder.AddToScheme ) diff --git a/staging/src/k8s.io/apiserver/pkg/apis/config/v1alpha1/register.go b/staging/src/k8s.io/apiserver/pkg/apis/config/v1alpha1/register.go index c09c163897..ddc186c9aa 100644 --- a/staging/src/k8s.io/apiserver/pkg/apis/config/v1alpha1/register.go +++ b/staging/src/k8s.io/apiserver/pkg/apis/config/v1alpha1/register.go @@ -21,7 +21,11 @@ import ( ) var ( - SchemeBuilder runtime.SchemeBuilder + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package + SchemeBuilder runtime.SchemeBuilder + // localSchemeBuilder extends the SchemeBuilder instance with the external types. In this package, + // defaulting and conversion init funcs are registered as well. localSchemeBuilder = &SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = localSchemeBuilder.AddToScheme ) diff --git a/staging/src/k8s.io/kube-controller-manager/config/v1alpha1/register.go b/staging/src/k8s.io/kube-controller-manager/config/v1alpha1/register.go index 94710dd6e1..630b45bace 100644 --- a/staging/src/k8s.io/kube-controller-manager/config/v1alpha1/register.go +++ b/staging/src/k8s.io/kube-controller-manager/config/v1alpha1/register.go @@ -21,20 +21,20 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" ) -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubecontrollermanager.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} var ( - // SchemeBuilder providers the handle of collects functions that add things to a scheme. + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) - // AddToScheme applies all the stored functions to the scheme. A non-nil error - // indicates that one function failed and the attempt was abandoned. + // AddToScheme is a global function that registers this API group & version to a scheme AddToScheme = SchemeBuilder.AddToScheme ) +// addKnownTypes registers known types to the given scheme func addKnownTypes(scheme *runtime.Scheme) error { scheme.AddKnownTypes(SchemeGroupVersion, &KubeControllerManagerConfiguration{}, diff --git a/staging/src/k8s.io/kube-proxy/config/v1alpha1/doc.go b/staging/src/k8s.io/kube-proxy/config/v1alpha1/doc.go index 8c733a994c..cb62b1cc13 100644 --- a/staging/src/k8s.io/kube-proxy/config/v1alpha1/doc.go +++ b/staging/src/k8s.io/kube-proxy/config/v1alpha1/doc.go @@ -15,5 +15,7 @@ limitations under the License. */ // +k8s:deepcopy-gen=package +// +k8s:openapi-gen=true // +groupName=kubeproxy.config.k8s.io + package v1alpha1 // import "k8s.io/kube-proxy/config/v1alpha1" diff --git a/staging/src/k8s.io/kube-proxy/config/v1alpha1/register.go b/staging/src/k8s.io/kube-proxy/config/v1alpha1/register.go index 92d92c4c1c..16ed248fae 100644 --- a/staging/src/k8s.io/kube-proxy/config/v1alpha1/register.go +++ b/staging/src/k8s.io/kube-proxy/config/v1alpha1/register.go @@ -21,26 +21,20 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" ) -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubeproxy.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} var ( - // localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes. - SchemeBuilder runtime.SchemeBuilder - localSchemeBuilder = &SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package + SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = SchemeBuilder.AddToScheme ) -func init() { - // We only register manually written functions here. The registration of the - // generated functions takes place in the generated files. The separation - // makes the code compile even when the generated files are missing. - localSchemeBuilder.Register(addKnownTypes) -} - +// addKnownTypes registers known types to the given scheme func addKnownTypes(scheme *runtime.Scheme) error { scheme.AddKnownTypes(SchemeGroupVersion, &KubeProxyConfiguration{}, diff --git a/staging/src/k8s.io/kube-scheduler/Godeps/Readme b/staging/src/k8s.io/kube-scheduler/Godeps/Readme new file mode 100644 index 0000000000..4cdaa53d56 --- /dev/null +++ b/staging/src/k8s.io/kube-scheduler/Godeps/Readme @@ -0,0 +1,5 @@ +This directory tree is generated automatically by godep. + +Please do not edit. + +See https://github.com/tools/godep for more information. diff --git a/staging/src/k8s.io/kube-scheduler/README.md b/staging/src/k8s.io/kube-scheduler/README.md index d4e7f64c1f..4082eafed1 100644 --- a/staging/src/k8s.io/kube-scheduler/README.md +++ b/staging/src/k8s.io/kube-scheduler/README.md @@ -1,10 +1,10 @@ # kube-scheduler -## Coming Soon! -Implements https://github.com/luxas/community/blob/master/keps/sig-cluster-lifecycle/0014-20180707-componentconfig-api-types-to-staging.md#kube-scheduler-changes +Implements [KEP 14 - Moving ComponentConfig API types to staging repos](https://github.com/kubernetes/community/blob/master/keps/sig-cluster-lifecycle/0014-20180707-componentconfig-api-types-to-staging.md#kube-scheduler-changes) -It provides -* Provide a versioned API for configuring kube-scheduler. +This repo provides external, versioned ComponentConfig API types for configuring the kube-scheduler. +These external types can easily be vendored and used by any third-party tool writing Kubernetes +ComponentConfig objects. ## Compatibility @@ -12,5 +12,5 @@ HEAD of this repo will match HEAD of k8s.io/apiserver, k8s.io/apimachinery, and ## Where does it come from? -`kube-scheduler` is synced from https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/kube-scheduler. -Code changes are made in that location, merged into `k8s.io/kubernetes` and later synced here. +This repo is synced from https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/kube-scheduler. +Code changes are made in that location, merged into `k8s.io/kubernetes` and later synced here by a bot. diff --git a/staging/src/k8s.io/kube-scheduler/config/v1alpha1/doc.go b/staging/src/k8s.io/kube-scheduler/config/v1alpha1/doc.go index 4b4164d888..73c9b6734e 100644 --- a/staging/src/k8s.io/kube-scheduler/config/v1alpha1/doc.go +++ b/staging/src/k8s.io/kube-scheduler/config/v1alpha1/doc.go @@ -15,5 +15,7 @@ limitations under the License. */ // +k8s:deepcopy-gen=package +// +k8s:openapi-gen=true +// +groupName=kubescheduler.config.k8s.io package v1alpha1 // import "k8s.io/kube-scheduler/config/v1alpha1" diff --git a/staging/src/k8s.io/kube-scheduler/config/v1alpha1/register.go b/staging/src/k8s.io/kube-scheduler/config/v1alpha1/register.go index 47e8db909b..c42f8412fc 100644 --- a/staging/src/k8s.io/kube-scheduler/config/v1alpha1/register.go +++ b/staging/src/k8s.io/kube-scheduler/config/v1alpha1/register.go @@ -21,28 +21,20 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" ) -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubescheduler.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1alpha1"} var ( - // SchemeBuilder the schema builder - SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) - localSchemeBuilder = &SchemeBuilder - // AddToScheme handler to add items to the schema - AddToScheme = localSchemeBuilder.AddToScheme + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package + SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = SchemeBuilder.AddToScheme ) -func init() { - // We only register manually written functions here. The registration of the - // generated functions takes place in the generated files. The separation - // makes the code compile even when the generated files are missing. - localSchemeBuilder.Register(addKnownTypes) -} - -// Adds the list of known types to the given scheme. +// addKnownTypes registers known types to the given scheme func addKnownTypes(scheme *runtime.Scheme) error { scheme.AddKnownTypes(SchemeGroupVersion, &KubeSchedulerConfiguration{}, diff --git a/staging/src/k8s.io/kubelet/config/v1beta1/register.go b/staging/src/k8s.io/kubelet/config/v1beta1/register.go index c03c53ac58..914dfb25fa 100644 --- a/staging/src/k8s.io/kubelet/config/v1beta1/register.go +++ b/staging/src/k8s.io/kubelet/config/v1beta1/register.go @@ -21,26 +21,20 @@ import ( "k8s.io/apimachinery/pkg/runtime/schema" ) -// GroupName is the group name use in this package +// GroupName is the group name used in this package const GroupName = "kubelet.config.k8s.io" // SchemeGroupVersion is group version used to register these objects var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"} var ( - SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) - localSchemeBuilder = &SchemeBuilder - AddToScheme = localSchemeBuilder.AddToScheme + // SchemeBuilder is the scheme builder with scheme init functions to run for this API package + SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) + // AddToScheme is a global function that registers this API group & version to a scheme + AddToScheme = SchemeBuilder.AddToScheme ) -func init() { - // We only register manually written functions here. The registration of the - // generated functions takes place in the generated files. The separation - // makes the code compile even when the generated files are missing. - localSchemeBuilder.Register(addKnownTypes) -} - -// Adds the list of known types to the given scheme. +// addKnownTypes registers known types to the given scheme func addKnownTypes(scheme *runtime.Scheme) error { scheme.AddKnownTypes(SchemeGroupVersion, &KubeletConfiguration{},