chore: add crds to helm and update README file. (#156)

* chore: add crds to helm and update README file. Signed-off-by: Aris Boutselis <arisboutselis08@gmail.com> * chore: update frigate gen Signed-off-by: Aris Boutselis <arisboutselis08@gmail.com> --------- Signed-off-by: Aris Boutselis <arisboutselis08@gmail.com> Co-authored-by: Aris Boutselis <arisboutselis08@gmail.com>
k8sgpt-ai · Jun 19, 2023 · 705c61c · 705c61c
1 parent 4880645
commit 705c61c
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -44,6 +44,9 @@ spec:
   enableAI: true
   # filters:
   #   - Ingress
+  # sink:
+  #   type: slack
+  #   webhook: <webhook-url>
   # extraOptions:
   #   backstage:
   #     enabled: true

diff --git a/chart/operator/README.md b/chart/operator/README.md
@@ -1,43 +1,48 @@
 
-K8sGPT Operator
+K8sgpt-operator
 ===========
-This Operator is designed to enable K8sGPT within a Kubernetes cluster. It will allow you to create a custom resource that defines the behaviour and scope of a managed K8sGPT workload. Analysis and outputs will also be configurable to enable integration into existing workflows.
+
+Automatic SRE Superpowers within your Kubernetes cluster
 
 
 ## Configuration
 
 The following table lists the configurable parameters of the K8sgpt-operator chart and their default values.
 
 <!---x-release-please-start-version-->
-
-| Parameter                                                                           | Description | Default                                                                       |
-|-------------------------------------------------------------------------------------|-------------|-------------------------------------------------------------------------------|
-| `serviceMonitor.enabled`                                                            |             | `false`                                                                       |
-| `serviceMonitor.additionalLabels`                                                   |             | `{}`
-| `controllerManager.kubeRbacProxy.containerSecurityContext.allowPrivilegeEscalation` |             | `false`                                                                       |
-| `controllerManager.kubeRbacProxy.containerSecurityContext.capabilities.drop`        |             | `["ALL"]`                                                                     |
-| `controllerManager.kubeRbacProxy.image.repository`                                  |             | `"gcr.io/kubebuilder/kube-rbac-proxy"`                                        |
-| `controllerManager.kubeRbacProxy.image.tag`                                         |             | `"v0.0.17"`                                                                   |
-| `controllerManager.kubeRbacProxy.resources.limits.cpu`                              |             | `"500m"`                                                                      |
-| `controllerManager.kubeRbacProxy.resources.limits.memory`                           |             | `"128Mi"`                                                                     |
-| `controllerManager.kubeRbacProxy.resources.requests.cpu`                            |             | `"5m"`                                                                        |
-| `controllerManager.kubeRbacProxy.resources.requests.memory`                         |             | `"64Mi"`                                                                      |
-| `controllerManager.manager.containerSecurityContext.allowPrivilegeEscalation`       |             | `false`                                                                       |
-| `controllerManager.manager.containerSecurityContext.capabilities.drop`              |             | `["ALL"]`                                                                     |
-| `controllerManager.manager.image.repository`                                        |             | `"ghcr.io/k8sgpt-ai/k8sgpt-operator"`                                         |
-| `controllerManager.manager.image.tag`                                               |             | `"v0.0.17"`                                                                    |
-| `controllerManager.manager.resources.limits.cpu`                                    |             | `"500m"`                                                                      |
-| `controllerManager.manager.resources.limits.memory`                                 |             | `"128Mi"`                                                                     |
-| `controllerManager.manager.resources.requests.cpu`                                  |             | `"10m"`                                                                       |
-| `controllerManager.manager.resources.requests.memory`                               |             | `"64Mi"`                                                                      |
-| `controllerManager.replicas`                                                        |             | `1`                                                                           |
-| `kubernetesClusterDomain`                                                           |             | `"cluster.local"`                                                             |
-| `metricsService.ports`                                                              |             | `[{"name": "https", "port": 8443, "protocol": "TCP", "targetPort": "https"}]` |
-| `metricsService.type`                                                               |             | `"ClusterIP"`                                                                 |
+| Parameter                | Description             | Default        |
+| ------------------------ | ----------------------- | -------------- |
+| `serviceMonitor.enabled` |  | `false` |
+| `serviceMonitor.additionalLabels` |  | `{}` |
+| `grafanaDashboard.enabled` |  | `false` |
+| `grafanaDashboard.folder.annotation` |  | `"grafana_folder"` |
+| `grafanaDashboard.folder.name` |  | `"ai"` |
+| `grafanaDashboard.label.key` |  | `"grafana_dashboard"` |
+| `grafanaDashboard.label.value` |  | `"1"` |
+| `controllerManager.kubeRbacProxy.containerSecurityContext.allowPrivilegeEscalation` |  | `false` |
+| `controllerManager.kubeRbacProxy.containerSecurityContext.capabilities.drop` |  | `["ALL"]` |
+| `controllerManager.kubeRbacProxy.image.repository` |  | `"gcr.io/kubebuilder/kube-rbac-proxy"` |
+| `controllerManager.kubeRbacProxy.image.tag` |  | `"v0.14.1"` |
+| `controllerManager.kubeRbacProxy.resources.limits.cpu` |  | `"500m"` |
+| `controllerManager.kubeRbacProxy.resources.limits.memory` |  | `"128Mi"` |
+| `controllerManager.kubeRbacProxy.resources.requests.cpu` |  | `"5m"` |
+| `controllerManager.kubeRbacProxy.resources.requests.memory` |  | `"64Mi"` |
+| `controllerManager.manager.sinkWebhookTimeout` |  | `"30s"` |
+| `controllerManager.manager.containerSecurityContext.allowPrivilegeEscalation` |  | `false` |
+| `controllerManager.manager.containerSecurityContext.capabilities.drop` |  | `["ALL"]` |
+| `controllerManager.manager.image.repository` |  | `"ghcr.io/k8sgpt-ai/k8sgpt-operator"` |
+| `controllerManager.manager.image.tag` | x-release-please-version | `"v0.0.17"` |
+| `controllerManager.manager.resources.limits.cpu` |  | `"500m"` |
+| `controllerManager.manager.resources.limits.memory` |  | `"128Mi"` |
+| `controllerManager.manager.resources.requests.cpu` |  | `"10m"` |
+| `controllerManager.manager.resources.requests.memory` |  | `"64Mi"` |
+| `controllerManager.replicas` |  | `1` |
+| `kubernetesClusterDomain` |  | `"cluster.local"` |
+| `metricsService.ports` |  | `[{"name": "https", "port": 8443, "protocol": "TCP", "targetPort": "https"}]` |
+| `metricsService.type` |  | `"ClusterIP"` |
 
 <!---x-release-please-end-->
 
-
 ---
 _Documentation generated by [Frigate](https://frigate.readthedocs.io)._
 
diff --git a/chart/operator/templates/k8sgpt-crd.yaml b/chart/operator/templates/k8sgpt-crd.yaml
@@ -72,6 +72,15 @@ spec:
                   name:
                     type: string
                 type: object
+              sink:
+                properties:
+                  type:
+                    enum:
+                    - slack
+                    type: string
+                  webhook:
+                    type: string
+                type: object
               version:
                 type: string
             type: object

diff --git a/chart/operator/templates/result-crd.yaml b/chart/operator/templates/result-crd.yaml
@@ -70,6 +70,11 @@ spec:
             type: object
           status:
             description: ResultStatus defines the observed state of Result
+            properties:
+              lifecycle:
+                type: string
+              webhook:
+                type: string
             type: object
         type: object
     served: true
@@ -81,4 +86,4 @@ status:
     kind: ""
     plural: ""
   conditions: []
-  storedVersions: []
+  storedVersions: []