feat: renamed to similarity requirement for scoring (#609)

Signed-off-by: AlexsJones <alexsimonjones@gmail.com>

Author: AlexsJones

AUTO_REMEDIATION.md

@@ -35,8 +35,8 @@ spec:
 
 `enabled`: A boolean value. If true, enables automatic remediation.
 
-`riskThreshold`: A string representing the risk threshold (e.g., "90"). 
-Issues with a risk score above this threshold will be automatically remediated.
+`similarityRequirement`: A string representing the required similarity with the original manifest (e.g., "90"). 
+New proposed manifests with a requirement above this threshold will be automatically remediated.
 
 `resources`: A list of Kubernetes resource types to consider for automatic remediation (e.g., Pod, Service, Deployment, Ingress).
 

api/v1alpha1/k8sgpt_types.go

@@ -101,7 +101,7 @@ type AutoRemediation struct {
 	Enabled bool `json:"enabled"`
 	// Defaults to 10%
 	// +kubebuilder:default="10"
-	RiskThreshold string `json:"riskThreshold"`
+	SimilarityRequirement string `json:"similarityRequirement"`
 	// Support Pod, Deployment, Service and Ingress
 	// +kubebuilder:default:={"Pod","Deployment","Service","Ingress"}
 	Resources []string `json:"resources"`
@@ -115,7 +115,7 @@ type AISpec struct {
 	BackOff *BackOff `json:"backOff,omitempty"`
 	BaseUrl string   `json:"baseUrl,omitempty"`
 	Region  string   `json:"region,omitempty"`
-	// +kubebuilder:default:=gpt-3.5-turbo
+	// +kubebuilder:default:=gpt-4o-mini
 	Model   string     `json:"model,omitempty"`
 	Engine  string     `json:"engine,omitempty"`
 	Secret  *SecretRef `json:"secret,omitempty"`

chart/operator/templates/mutation-crd.yaml

@@ -1,11 +1,12 @@
+---
 apiVersion: apiextensions.k8s.io/v1
 kind: CustomResourceDefinition
 metadata:
-  name: mutations.core.k8sgpt.ai
   annotations:
     controller-gen.kubebuilder.io/version: v0.14.0
   labels:
   {{- include "chart.labels" . | nindent 4 }}
+  name: mutations.core.k8sgpt.ai
 spec:
   group: core.k8sgpt.ai
   names:

config/crd/bases/core.k8sgpt.ai_k8sgpts.yaml

@@ -59,14 +59,14 @@ spec:
                         items:
                           type: string
                         type: array
-                      riskThreshold:
+                      similarityRequirement:
                         default: "10"
                         description: Defaults to 10%
                         type: string
                     required:
                     - enabled
                     - resources
-                    - riskThreshold
+                    - similarityRequirement
                     type: object
                   backOff:
                     properties:
@@ -106,7 +106,7 @@ spec:
                     default: "2048"
                     type: string
                   model:
-                    default: gpt-3.5-turbo
+                    default: gpt-4o-mini
                     type: string
                   providerId:
                     type: string

config/samples/autoremediation/valid_k8sgpt_remediation_sample.yaml

@@ -7,7 +7,7 @@ spec:
   ai:
     autoRemediation:
       enabled: true
-      riskThreshold: "90"
+      similarityRequirement: "90"
       resources:
         - Pod
         - Service

internal/controller/mutation/mutation_controller.go

@@ -166,13 +166,13 @@ func (r *MutationReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 			return ctrl.Result{RequeueAfter: util.ErrorRequeueTime}, nil
 		}
 		if r.K8sGPT != nil {
-			if r.K8sGPT.Spec.AI.AutoRemediation.RiskThreshold != "" {
+			if r.K8sGPT.Spec.AI.AutoRemediation.SimilarityRequirement != "" {
 				// If the current Similarity score is less than the riskThreshold, we should not apply the mutation
 				ss, err := strconv.ParseFloat(strings.TrimSpace(mutation.Spec.SimilarityScore), 64)
 				if err != nil {
 					mutationControllerLog.Error(err, "unable to parse similarity score", "mutation", mutation.Name)
 				} else {
-					rt, err := strconv.ParseFloat(r.K8sGPT.Spec.AI.AutoRemediation.RiskThreshold, 64)
+					rt, err := strconv.ParseFloat(r.K8sGPT.Spec.AI.AutoRemediation.SimilarityRequirement, 64)
 					if err != nil {
 						mutationControllerLog.Error(err, "unable to parse risk threshold", "mutation", mutation.Name)
 					} else {