From 99c55f2afb28cb674e87148ff50c7c0b249e2051 Mon Sep 17 00:00:00 2001 From: Thomas Schuetz <38893055+thschue@users.noreply.github.com> Date: Fri, 28 Apr 2023 22:31:45 +0200 Subject: [PATCH] docs: add artifacthub badge and chart readme (#45) * docs: added artifacthub badge Signed-off-by: Thomas Schuetz * feat: update readme Signed-off-by: Thomas Schuetz * feat: update readme Signed-off-by: Thomas Schuetz * feat: update readme Signed-off-by: Thomas Schuetz --------- Signed-off-by: Thomas Schuetz --- README.md | 2 ++ chart/operator/Chart.yaml | 2 +- chart/operator/README.md | 42 ++++++++++++++++++++++++++++++++++++++ release-please-config.json | 1 + 4 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 chart/operator/README.md diff --git a/README.md b/README.md index 3494c4b8..15e38b6f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/k8sgpt)](https://artifacthub.io/packages/search?repo=k8sgpt) + 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. diff --git a/chart/operator/Chart.yaml b/chart/operator/Chart.yaml index 92a62981..a246bd33 100644 --- a/chart/operator/Chart.yaml +++ b/chart/operator/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 name: k8sgpt-operator -description: A Helm chart for Kubernetes +description: Automatic SRE Superpowers within your Kubernetes cluster maintainers: - name: "The K8sGPT Authors" email: "noreply@k8sgpt.ai" diff --git a/chart/operator/README.md b/chart/operator/README.md new file mode 100644 index 00000000..dbcab7ea --- /dev/null +++ b/chart/operator/README.md @@ -0,0 +1,42 @@ + +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. + + +## Configuration + +The following table lists the configurable parameters of the K8sgpt-operator chart and their default values. + + + +| Parameter | Description | Default | +|-------------------------------------------------------------------------------------|-------------|-------------------------------------------------------------------------------| +| `serviceMonitor.enabled` | | `false` | +| `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.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.8"` | +| `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"` | + + + + +--- +_Documentation generated by [Frigate](https://frigate.readthedocs.io)._ + diff --git a/release-please-config.json b/release-please-config.json index 241f6e2c..a8967a70 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -12,6 +12,7 @@ "deploy/manifest.yaml", "chart/operator/Chart.yaml", "chart/operator/values.yaml", + "chart/operator/README.md", "container/manifests/deployment.yaml" ], "changelog-sections": [