github.com/khulnasoft-lab/defsec@v1.0.5-0.20230827010352-5e9f46893d95/rules/cloud/policies/digitalocean/compute/kubernetes_surge_upgrades.go (about)

     1  package compute
     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 CheckKubernetesSurgeUpgrades = rules.Register(
    12  	scan.Rule{
    13  		AVDID:       "AVD-DIG-0005",
    14  		Provider:    providers.DigitalOceanProvider,
    15  		Service:     "compute",
    16  		ShortCode:   "surge-upgrades-not-enabled",
    17  		Summary:     "The Kubernetes cluster does not enable surge upgrades",
    18  		Impact:      "Upgrades may influence availability of your Kubernetes cluster",
    19  		Resolution:  "Enable surge upgrades in your Kubernetes cluster",
    20  		Explanation: `While upgrading your cluster, workloads will temporarily be moved to new nodes. A small cost will follow, but as a bonus, you won't experience downtime.`,
    21  		Links: []string{
    22  			"https://docs.digitalocean.com/products/kubernetes/how-to/upgrade-cluster/#surge-upgrades",
    23  		},
    24  		Terraform: &scan.EngineMetadata{
    25  			GoodExamples:        terraformKubernetesClusterSurgeUpgradesGoodExamples,
    26  			BadExamples:         terraformKubernetesClusterSurgeUpgradesBadExamples,
    27  			Links:               terraformKubernetesClusterSurgeUpgradeLinks,
    28  			RemediationMarkdown: terraformKubernetesClusterSurgeUpgradesMarkdown,
    29  		},
    30  		Severity: severity.Medium,
    31  	},
    32  	func(s *state.State) (results scan.Results) {
    33  		for _, kc := range s.DigitalOcean.Compute.KubernetesClusters {
    34  			if kc.Metadata.IsUnmanaged() {
    35  				continue
    36  			}
    37  			if kc.SurgeUpgrade.IsFalse() {
    38  				results.Add(
    39  					"Surge upgrades are disabled in your Kubernetes cluster. Please enable this feature.",
    40  					kc.SurgeUpgrade,
    41  				)
    42  			} else {
    43  				results.AddPassed(&kc)
    44  			}
    45  		}
    46  		return
    47  	},
    48  )