Issue 280 (#282)

* Add ImagePullSecrets to K8sGPTSpec. Signed-off-by: JuHyung-Son <sonju0427@gmail.com> * Add image pull secrets to service account Signed-off-by: JuHyung-Son <sonju0427@gmail.com> * add spec to README Signed-off-by: JuHyung-Son <sonju0427@gmail.com> * lint Signed-off-by: JuHyung-Son <sonju0427@gmail.com> * fix readme Signed-off-by: JuHyung-Son <sonju0427@gmail.com> --------- Signed-off-by: JuHyung-Son <sonju0427@gmail.com>
k8sgpt-ai · Dec 22, 2023 · f4673cc · f4673cc
1 parent a9bc7bf
commit f4673cc
Show file tree

Hide file tree

Showing 6 changed files with 92 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -155,7 +155,7 @@ spec:
       name: k8sgpt-sample-secret
       key: openai-api-key
   noCache: false
-  repository: ghcr.io/k8sgpt-ai/k8gpt
+  repository: ghcr.io/k8sgpt-ai/k8sgpt
   version: v0.3.8
   remoteCache:
     credentials:
@@ -200,7 +200,7 @@ spec:
     baseUrl: https://k8sgpt.openai.azure.com/
     engine: llm
   noCache: false
-  repository: ghcr.io/k8sgpt-ai/k8gpt
+  repository: ghcr.io/k8sgpt-ai/k8sgpt
   version: v0.3.8
 EOF
 ```
@@ -231,7 +231,7 @@ spec:
     backend: localai
     baseUrl: http://local-ai.local-ai.svc.cluster.local:8080/v1
   noCache: false
-  repository: ghcr.io/k8sgpt-ai/k8gpt
+  repository: ghcr.io/k8sgpt-ai/k8sgpt
   version: v0.3.8
 EOF
 ```
@@ -241,10 +241,43 @@ EOF
 
 </details>
 
+## K8sGPT Configuration Options
+
+<details>
+
+<summary>ImagePullSecrets</summary>
+You can use custom k8sgpt image by modifying `repository`, `version`, `imagePullSecrets`.
+`version` actually works as image tag.
+
+```sh
+kubectl apply -f - << EOF
+apiVersion: core.k8sgpt.ai/v1alpha1
+kind: K8sGPT
+metadata:
+  name: k8sgpt-sample
+  namespace: k8sgpt-operator-system
+spec:
+  ai:
+    enabled: true
+    model: gpt-3.5-turbo
+    backend: openai
+    secret:
+      name: k8sgpt-sample-secret
+      key: openai-api-key
+  noCache: false
+  repository: sample.repository/k8sgpt
+  version: sample-tag
+  imagePullSecrets:
+    - name: sample-secret
+EOF
+```
+
+</details>
+
 ## Helm values
 
 For details please see [here](chart/operator/values.yaml)
 
 
 ## License
-[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgit.luolix.top%2Fk8sgpt-ai%2Fk8sgpt-operator.svg?type=large)](https://app.fossa.com/projects/git%2Bgit.luolix.top%2Fk8sgpt-ai%2Fk8sgpt-operator?ref=badge_large)
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgit.luolix.top%2Fk8sgpt-ai%2Fk8sgpt-operator.svg?type=large)](https://app.fossa.com/projects/git%2Bgit.luolix.top%2Fk8sgpt-ai%2Fk8sgpt-operator?ref=badge_large)
diff --git a/api/v1alpha1/k8sgpt_types.go b/api/v1alpha1/k8sgpt_types.go
@@ -94,19 +94,24 @@ type Integrations struct {
 	Trivy *Trivy `json:"trivy,omitempty"`
 }
 
+type ImagePullSecrets struct {
+	Name string `json:"name,omitempty"`
+}
+
 // K8sGPTSpec defines the desired state of K8sGPT
 type K8sGPTSpec struct {
 	Version string `json:"version,omitempty"`
 	// +kubebuilder:default:=ghcr.io/k8sgpt-ai/k8sgpt
-	Repository   string            `json:"repository,omitempty"`
-	NoCache      bool              `json:"noCache,omitempty"`
-	Filters      []string          `json:"filters,omitempty"`
-	ExtraOptions *ExtraOptionsRef  `json:"extraOptions,omitempty"`
-	Sink         *WebhookRef       `json:"sink,omitempty"`
-	AI           *AISpec           `json:"ai,omitempty"`
-	RemoteCache  *RemoteCacheRef   `json:"remoteCache,omitempty"`
-	Integrations *Integrations     `json:"integrations,omitempty"`
-	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
+	Repository       string             `json:"repository,omitempty"`
+	ImagePullSecrets []ImagePullSecrets `json:"imagePullSecrets,omitempty"`
+	NoCache          bool               `json:"noCache,omitempty"`
+	Filters          []string           `json:"filters,omitempty"`
+	ExtraOptions     *ExtraOptionsRef   `json:"extraOptions,omitempty"`
+	Sink             *WebhookRef        `json:"sink,omitempty"`
+	AI               *AISpec            `json:"ai,omitempty"`
+	RemoteCache      *RemoteCacheRef    `json:"remoteCache,omitempty"`
+	Integrations     *Integrations      `json:"integrations,omitempty"`
+	NodeSelector     map[string]string  `json:"nodeSelector,omitempty"`
 }
 
 const (

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/chart/operator/templates/k8sgpt-crd.yaml b/chart/operator/templates/k8sgpt-crd.yaml
@@ -84,6 +84,13 @@ spec:
                 items:
                   type: string
                 type: array
+              imagePullSecrets:
+                items:
+                  properties:
+                    name:
+                      type: string
+                  type: object
+                type: array
               integrations:
                 properties:
                   trivy:

diff --git a/config/crd/bases/core.k8sgpt.ai_k8sgpts.yaml b/config/crd/bases/core.k8sgpt.ai_k8sgpts.yaml
@@ -84,6 +84,13 @@ spec:
                 items:
                   type: string
                 type: array
+              imagePullSecrets:
+                items:
+                  properties:
+                    name:
+                      type: string
+                  type: object
+                type: array
               integrations:
                 properties:
                   trivy:

diff --git a/pkg/resources/k8sgpt.go b/pkg/resources/k8sgpt.go
@@ -93,6 +93,13 @@ func GetServiceAccount(config v1alpha1.K8sGPT) (*corev1.ServiceAccount, error) {
 				},
 			},
 		},
+		ImagePullSecrets: []corev1.LocalObjectReference{},
+	}
+	//Add image pull secrets to service account
+	for _, secret := range config.Spec.ImagePullSecrets {
+		serviceAccount.ImagePullSecrets = append(serviceAccount.ImagePullSecrets, corev1.LocalObjectReference{
+			Name: secret.Name,
+		})
 	}
 
 	return &serviceAccount, nil