Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Jun 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@ spec:
enableAI: true
# filters:
# - Ingress
# sink:
# type: slack
# webhook: <webhook-url>
# extraOptions:
# backstage:
# enabled: true
Expand Down
61 changes: 33 additions & 28 deletions chart/operator/README.md
Original file line number Diff line number Diff line change
@@ -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)._

9 changes: 9 additions & 0 deletions chart/operator/templates/k8sgpt-crd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 6 additions & 1 deletion chart/operator/templates/result-crd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -81,4 +86,4 @@ status:
kind: ""
plural: ""
conditions: []
storedVersions: []
storedVersions: []