github.com/khulnasoft-lab/defsec@v1.0.5-0.20230827010352-5e9f46893d95/rules/cloud/policies/google/gke/use_cluster_labels.go (about)

     1  package gke
     2  
     3  import (
     4  	"github.com/khulnasoft-lab/defsec/internal/rules"
     5  	"github.com/khulnasoft-lab/defsec/pkg/providers"
     6  	"github.com/khulnasoft-lab/defsec/pkg/scan"
     7  	"github.com/khulnasoft-lab/defsec/pkg/severity"
     8  	"github.com/khulnasoft-lab/defsec/pkg/state"
     9  )
    10  
    11  var CheckUseClusterLabels = rules.Register(
    12  	scan.Rule{
    13  		AVDID:       "AVD-GCP-0051",
    14  		Provider:    providers.GoogleProvider,
    15  		Service:     "gke",
    16  		ShortCode:   "use-cluster-labels",
    17  		Summary:     "Clusters should be configured with Labels",
    18  		Impact:      "Asset management can be limited/more difficult",
    19  		Resolution:  "Set cluster resource labels",
    20  		Explanation: `Labels make it easier to manage assets and differentiate between clusters and environments, allowing the mapping of computational resources to the wider organisational structure.`,
    21  		Links:       []string{},
    22  		Terraform: &scan.EngineMetadata{
    23  			GoodExamples:        terraformUseClusterLabelsGoodExamples,
    24  			BadExamples:         terraformUseClusterLabelsBadExamples,
    25  			Links:               terraformUseClusterLabelsLinks,
    26  			RemediationMarkdown: terraformUseClusterLabelsRemediationMarkdown,
    27  		},
    28  		Severity: severity.Low,
    29  	},
    30  	func(s *state.State) (results scan.Results) {
    31  		for _, cluster := range s.Google.GKE.Clusters {
    32  			if cluster.Metadata.IsUnmanaged() {
    33  				continue
    34  			}
    35  			if cluster.ResourceLabels.Len() == 0 {
    36  				results.Add(
    37  					"Cluster does not use GCE resource labels.",
    38  					cluster.ResourceLabels,
    39  				)
    40  			} else {
    41  				results.AddPassed(&cluster)
    42  			}
    43  		}
    44  		return
    45  	},
    46  )