@ -16,65 +16,69 @@ limitations under the License.
package rules // import "helm.sh/helm/v3/pkg/lint/rules"
package rules // import "helm.sh/helm/v3/pkg/lint/rules"
import "fmt" import (
"fmt"
// deprecatedAPIs lists APIs that are deprecated (left) with suggested alternatives (right).
"k8s.io/apimachinery/pkg/runtime"
//
"k8s.io/apimachinery/pkg/runtime/schema"
// An empty rvalue indicates that the API is completely deprecated.
"k8s.io/apiserver/pkg/endpoints/deprecation"
var deprecatedAPIs = map [ string ] string { kscheme "k8s.io/client-go/kubernetes/scheme"
"extensions/v1beta1 Deployment" : "apps/v1 Deployment" ,
)
"extensions/v1beta1 DaemonSet" : "apps/v1 DaemonSet" ,
"extensions/v1beta1 ReplicaSet" : "apps/v1 ReplicaSet" ,
const (
"extensions/v1beta1 PodSecurityPolicy" : "policy/v1beta1 PodSecurityPolicy" ,
// This should be set in the Makefile based on the version of client-go being imported.
"extensions/v1beta1 NetworkPolicy" : "networking.k8s.io/v1beta1 NetworkPolicy" ,
// These constants will be overwritten with LDFLAGS
"extensions/v1beta1 Ingress" : "networking.k8s.io/v1beta1 Ingress" ,
k8sVersionMajor = 1
"apps/v1beta1 Deployment" : "apps/v1 Deployment" ,
k8sVersionMinor = 20
"apps/v1beta1 StatefulSet" : "apps/v1 StatefulSet" ,
)
"apps/v1beta1 ReplicaSet" : "apps/v1 ReplicaSet" ,
"apps/v1beta2 Deployment" : "apps/v1 Deployment" ,
"apps/v1beta2 StatefulSet" : "apps/v1 StatefulSet" ,
"apps/v1beta2 DaemonSet" : "apps/v1 DaemonSet" ,
"apps/v1beta2 ReplicaSet" : "apps/v1 ReplicaSet" ,
"apiextensions.k8s.io/v1beta1 CustomResourceDefinition" : "apiextensions.k8s.io/v1 CustomResourceDefinition" ,
"rbac.authorization.k8s.io/v1alpha1 ClusterRole" : "rbac.authorization.k8s.io/v1 ClusterRole" ,
"rbac.authorization.k8s.io/v1alpha1 ClusterRoleList" : "rbac.authorization.k8s.io/v1 ClusterRoleList" ,
"rbac.authorization.k8s.io/v1alpha1 ClusterRoleBinding" : "rbac.authorization.k8s.io/v1 ClusterRoleBinding" ,
"rbac.authorization.k8s.io/v1alpha1 ClusterRoleBindingList" : "rbac.authorization.k8s.io/v1 ClusterRoleBindingList" ,
"rbac.authorization.k8s.io/v1alpha1 Role" : "rbac.authorization.k8s.io/v1 Role" ,
"rbac.authorization.k8s.io/v1alpha1 RoleList" : "rbac.authorization.k8s.io/v1 RoleList" ,
"rbac.authorization.k8s.io/v1alpha1 RoleBinding" : "rbac.authorization.k8s.io/v1 RoleBinding" ,
"rbac.authorization.k8s.io/v1alpha1 RoleBindingList" : "rbac.authorization.k8s.io/v1 RoleBindingList" ,
"rbac.authorization.k8s.io/v1beta1 ClusterRole" : "rbac.authorization.k8s.io/v1 ClusterRole" ,
"rbac.authorization.k8s.io/v1beta1 ClusterRoleList" : "rbac.authorization.k8s.io/v1 ClusterRoleList" ,
"rbac.authorization.k8s.io/v1beta1 ClusterRoleBinding" : "rbac.authorization.k8s.io/v1 ClusterRoleBinding" ,
"rbac.authorization.k8s.io/v1beta1 ClusterRoleBindingList" : "rbac.authorization.k8s.io/v1 ClusterRoleBindingList" ,
"rbac.authorization.k8s.io/v1beta1 Role" : "rbac.authorization.k8s.io/v1 Role" ,
"rbac.authorization.k8s.io/v1beta1 RoleList" : "rbac.authorization.k8s.io/v1 RoleList" ,
"rbac.authorization.k8s.io/v1beta1 RoleBinding" : "rbac.authorization.k8s.io/v1 RoleBinding" ,
"rbac.authorization.k8s.io/v1beta1 RoleBindingList" : "rbac.authorization.k8s.io/v1 RoleBindingList" ,
}
// deprecatedAPIError indicates than an API is deprecated in Kubernetes
// deprecatedAPIError indicates than an API is deprecated in Kubernetes
type deprecatedAPIError struct { type deprecatedAPIError struct {
Deprecated string
Deprecated string
Alternative string
Message string
} }
func ( e deprecatedAPIError ) Error ( ) string { func ( e deprecatedAPIError ) Error ( ) string {
msg := fmt . Sprintf ( "the kind %q is deprecated" , e . Deprecated )
msg := e . Message
if e . Alternative != "" {
msg += fmt . Sprintf ( " in favor of %q" , e . Alternative )
}
return msg
return msg
} }
func validateNoDeprecations ( resource * K8sYamlStruct ) error { func validateNoDeprecations ( resource * K8sYamlStruct ) error {
// if `resource` does not have an APIVersion or Kind, we cannot test it for deprecation
if resource . APIVersion == "" {
return nil
}
if resource . Kind == "" {
return nil
}
runtimeObject , err := resourceToRuntimeObject ( resource )
if err != nil {
// do not error for non-kubernetes resources
if runtime . IsNotRegisteredError ( err ) {
return nil
}
return err
}
if ! deprecation . IsDeprecated ( runtimeObject , k8sVersionMajor , k8sVersionMinor ) {
return nil
}
gvk := fmt . Sprintf ( "%s %s" , resource . APIVersion , resource . Kind )
gvk := fmt . Sprintf ( "%s %s" , resource . APIVersion , resource . Kind )
if alt , ok := deprecatedAPIs [ gvk ] ; ok {
return deprecatedAPIError {
return deprecatedAPIError {
Deprecated : gvk ,
Deprecated : gvk ,
Alternative : alt ,
Message : deprecation . WarningMessage ( runtimeObject ) ,
}
}
} }
return nil
func resourceToRuntimeObject ( resource * K8sYamlStruct ) ( runtime . Object , error ) {
scheme := runtime . NewScheme ( )
kscheme . AddToScheme ( scheme )
gvk := schema . FromAPIVersionAndKind ( resource . APIVersion , resource . Kind )
out , err := scheme . New ( gvk )
if err != nil {
return nil , err
}
out . GetObjectKind ( ) . SetGroupVersionKind ( gvk )
return out , nil
} }
Joe Julian
5 years ago
committed by
GitHub