Skip to content

Commit

Permalink
feat: set default vaules on cp-schema-registry
Browse files Browse the repository at this point in the history
  • Loading branch information
ialejandro committed Sep 5, 2024
1 parent 46a5cab commit c33b24c
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 11 deletions.
10 changes: 5 additions & 5 deletions charts/cp-schema-registry/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# cp-schema-registry

A Helm chart with cp-schema-registry for Kubernetes

## Motivation

The original Helm chart for [Confluent Schema Registry](https://github.com/confluentinc/cp-helm-charts/tree/master/charts/cp-schema-registry) has been deprecated, and over time it became too bulky and outdated. That's why I've created a new, lighter, and more up-to-date Helm chart. This new chart is more streamlined and easier to customize.
Expand All @@ -9,8 +11,6 @@ Some of the key changes include:
* Configurations that are compatible with the latest Kubernetes features
* Easier setup, with more modular and flexible options

A Helm chart with cp-schema-registry for Kubernetes

## Maintainers

| Name | Email | Url |
Expand Down Expand Up @@ -69,7 +69,7 @@ helm show values devops-ia/cp-schema-registry
| imagePullSecrets | list | `[]` | Global Docker registry secret names as an array |
| ingress | object | `{"annotations":{},"className":"","enabled":false,"hosts":[{"host":"chart-example.local","paths":[{"path":"/","pathType":"ImplementationSpecific"}]}],"tls":[]}` | Ingress configuration to expose app </br> Ref: https://kubernetes.io/docs/concepts/services-networking/ingress/ |
| initContainers | list | `[]` | Configure additional containers </br> Ref: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ |
| livenessProbe | object | `{"enabled":true,"failureThreshold":3,"initialDelaySeconds":180,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5}` | Configure liveness checker </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes |
| livenessProbe | object | `{"enabled":false,"failureThreshold":3,"initialDelaySeconds":180,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5}` | Configure liveness checker </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes |
| livenessProbeCustom | object | `{}` | Custom livenessProbe |
| metrics | object | `{"enabled":false,"exporter":{"enabled":false,"image":{"pullPolicy":"IfNotPresent","repository":"solsson/kafka-prometheus-jmx-exporter@sha256","tag":"6f82e2b0464f50da8104acd7363fb9b995001ddff77d248379f8788e78946143"},"port":5556,"resources":{}},"port":5555}` | Enable metrics |
| metrics.enabled | bool | `false` | Enable or disable |
Expand All @@ -85,7 +85,7 @@ helm show values devops-ia/cp-schema-registry
| podDisruptionBudget | object | `{"enabled":false,"maxUnavailable":1,"minAvailable":null}` | Pod Disruption Budget </br> Ref: https://kubernetes.io/docs/reference/kubernetes-api/policy-resources/pod-disruption-budget-v1/ |
| podLabels | object | `{}` | Configure labels on Pods |
| podSecurityContext | object | `{}` | Defines privilege and access control settings for a Pod </br> Ref: https://kubernetes.io/docs/concepts/security/pod-security-standards/ </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ |
| readinessProbe | object | `{"enabled":true,"failureThreshold":3,"initialDelaySeconds":10,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1}` | Configure readinessProbe checker </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes |
| readinessProbe | object | `{"enabled":false,"failureThreshold":3,"initialDelaySeconds":10,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":1}` | Configure readinessProbe checker </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes |
| readinessProbeCustom | object | `{}` | Custom readinessProbe |
| replicaCount | int | `1` | Number of replicas Specifies the number of replicas for the service |
| resources | object | `{}` | Resources limits and requested </br> Ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ |
Expand All @@ -98,7 +98,7 @@ helm show values devops-ia/cp-schema-registry
| serviceAccount | object | `{"annotations":{},"automount":true,"create":true,"name":""}` | Enable creation of ServiceAccount |
| serviceMonitor | object | `{"enabled":false,"interval":"30s","metricRelabelings":[],"relabelings":[],"scrapeTimeout":"10s"}` | Enable ServiceMonitor to get metrics </br> Ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api.md#servicemonitor |
| serviceMonitor.enabled | bool | `false` | Enable or disable |
| startupProbe | object | `{"enabled":true,"failureThreshold":30,"initialDelaySeconds":180,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5}` | Configure startupProbe checker </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes |
| startupProbe | object | `{"enabled":false,"failureThreshold":30,"initialDelaySeconds":180,"periodSeconds":10,"successThreshold":1,"timeoutSeconds":5}` | Configure startupProbe checker </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes |
| startupProbeCustom | object | `{}` | Custom startupProbe |
| testConnection | bool | `false` | Enable or disable test connection |
| tolerations | list | `[]` | Tolerations for pod assignment </br> Ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ |
Expand Down
4 changes: 2 additions & 2 deletions charts/cp-schema-registry/README.md.gotmpl
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# {{ template "chart.name" . }}

{{ template "chart.description" . }}

## Motivation

The original Helm chart for [Confluent Schema Registry](https://github.com/confluentinc/cp-helm-charts/tree/master/charts/cp-schema-registry) has been deprecated, and over time it became too bulky and outdated. That's why I've created a new, lighter, and more up-to-date Helm chart. This new chart is more streamlined and easier to customize.
Expand All @@ -9,8 +11,6 @@ Some of the key changes include:
* Configurations that are compatible with the latest Kubernetes features
* Easier setup, with more modular and flexible options

{{ template "chart.description" . }}

{{ template "chart.maintainersSection" . }}

## Prerequisites
Expand Down
7 changes: 6 additions & 1 deletion charts/cp-schema-registry/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ spec:
- name: http
containerPort: {{ .Values.service.targetPort | default .Values.service.port }}
protocol: TCP
{{- if .Values.metrics.exporter.enabled }}
- name: jmx
containerPort: {{ .Values.metrics.port }}
protocol: TCP
{{- end }}
{{- range $port := .Values.service.extraPorts }}
- name: {{ $port.name }}
containerPort: {{ $port.targetPort }}
Expand Down Expand Up @@ -151,7 +156,7 @@ spec:
- -XshowSettings:vm
- -jar
- jmx_prometheus_httpserver.jar
- {{ .Values.metrics.port | quote }}
- {{ .Values.metrics.exporter.port | quote }}
- /etc/jmx-schema-registry/jmx-schema-registry-prometheus.yml
ports:
- name: metrics
Expand Down
6 changes: 3 additions & 3 deletions charts/cp-schema-registry/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ metrics:
# -- Configure liveness checker
# </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes
livenessProbe:
enabled: true
enabled: false
failureThreshold: 3
initialDelaySeconds: 180
periodSeconds: 10
Expand All @@ -145,7 +145,7 @@ livenessProbeCustom: {}
# -- Configure readinessProbe checker
# </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes
readinessProbe:
enabled: true
enabled: false
failureThreshold: 3
initialDelaySeconds: 10
periodSeconds: 10
Expand All @@ -166,7 +166,7 @@ readinessProbeCustom: {}
# -- Configure startupProbe checker
# </br> Ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-startup-probes
startupProbe:
enabled: true
enabled: false
failureThreshold: 30
initialDelaySeconds: 180
periodSeconds: 10
Expand Down

0 comments on commit c33b24c

Please sign in to comment.