| // Copyright Istio 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. |
| |
| package maturity |
| |
| import ( |
| "strings" |
| ) |
| |
| import ( |
| "istio.io/api/annotation" |
| ) |
| |
| import ( |
| "github.com/apache/dubbo-go-pixiu/pkg/config/analysis" |
| "github.com/apache/dubbo-go-pixiu/pkg/config/analysis/analyzers/util" |
| "github.com/apache/dubbo-go-pixiu/pkg/config/analysis/msg" |
| "github.com/apache/dubbo-go-pixiu/pkg/config/resource" |
| "github.com/apache/dubbo-go-pixiu/pkg/config/schema/collection" |
| "github.com/apache/dubbo-go-pixiu/pkg/config/schema/collections" |
| ) |
| |
| // AlphaAnalyzer checks for alpha Istio annotations in K8s resources |
| type AlphaAnalyzer struct{} |
| |
| // the alpha analyzer is currently explicitly left out of the default collection of analyzers to run, as it results |
| // in too much noise for users, with annotations that are set by default. Once the noise dies down, this should be |
| // added to the CombinedAnalyzers() function. |
| |
| var istioAnnotations = annotation.AllResourceAnnotations() |
| |
| // Metadata implements analyzer.Analyzer |
| func (*AlphaAnalyzer) Metadata() analysis.Metadata { |
| return analysis.Metadata{ |
| Name: "annotations.AlphaAnalyzer", |
| Description: "Checks for alpha Istio annotations in Kubernetes resources", |
| Inputs: collection.Names{ |
| collections.K8SCoreV1Namespaces.Name(), |
| collections.K8SCoreV1Services.Name(), |
| collections.K8SCoreV1Pods.Name(), |
| collections.K8SAppsV1Deployments.Name(), |
| }, |
| } |
| } |
| |
| // Analyze implements analysis.Analyzer |
| func (fa *AlphaAnalyzer) Analyze(ctx analysis.Context) { |
| ctx.ForEach(collections.K8SCoreV1Namespaces.Name(), func(r *resource.Instance) bool { |
| fa.allowAnnotations(r, ctx, collections.K8SCoreV1Namespaces.Name()) |
| return true |
| }) |
| ctx.ForEach(collections.K8SCoreV1Services.Name(), func(r *resource.Instance) bool { |
| fa.allowAnnotations(r, ctx, collections.K8SCoreV1Services.Name()) |
| return true |
| }) |
| ctx.ForEach(collections.K8SCoreV1Pods.Name(), func(r *resource.Instance) bool { |
| fa.allowAnnotations(r, ctx, collections.K8SCoreV1Pods.Name()) |
| return true |
| }) |
| ctx.ForEach(collections.K8SAppsV1Deployments.Name(), func(r *resource.Instance) bool { |
| fa.allowAnnotations(r, ctx, collections.K8SAppsV1Deployments.Name()) |
| return true |
| }) |
| } |
| |
| func (*AlphaAnalyzer) allowAnnotations(r *resource.Instance, ctx analysis.Context, collectionType collection.Name) { |
| if len(r.Metadata.Annotations) == 0 { |
| return |
| } |
| |
| // It is fine if the annotation is kubectl.kubernetes.io/last-applied-configuration. |
| for ann := range r.Metadata.Annotations { |
| if !istioAnnotation(ann) { |
| continue |
| } |
| |
| if annotationDef := lookupAnnotation(ann); annotationDef != nil { |
| if annotationDef.FeatureStatus == annotation.Alpha { |
| // this annotation is set by default in istiod, don't alert on it. |
| if annotationDef.Name == annotation.SidecarStatus.Name { |
| continue |
| } |
| m := msg.NewAlphaAnnotation(r, ann) |
| util.AddLineNumber(r, ann, m) |
| |
| ctx.Report(collectionType, m) |
| } |
| } |
| } |
| } |
| |
| // istioAnnotation is true if the annotation is in Istio's namespace |
| func istioAnnotation(ann string) bool { |
| // We document this Kubernetes annotation, we should analyze it as well |
| if ann == "kubernetes.io/ingress.class" { |
| return true |
| } |
| |
| parts := strings.Split(ann, "/") |
| if len(parts) == 0 { |
| return false |
| } |
| |
| if !strings.HasSuffix(parts[0], "istio.io") { |
| return false |
| } |
| |
| return true |
| } |
| |
| func lookupAnnotation(ann string) *annotation.Instance { |
| for _, candidate := range istioAnnotations { |
| if candidate.Name == ann { |
| return candidate |
| } |
| } |
| |
| return nil |
| } |