-
Notifications
You must be signed in to change notification settings - Fork 18
[FEAT] Add WarpStream Helm Chart - Cloud-Native Kafka Alternative Support zopdev [IEEE] #218
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
Open
biswas2200
wants to merge
2
commits into
zopdev:main
Choose a base branch
from
biswas2200:feature/add-warpstream-support
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| apiVersion: v2 | ||
| name: warpstream | ||
| description: A Helm chart for WarpStream - a cloud-native, Kafka-compatible streaming platform | ||
| type: application | ||
| version: 0.0.1 | ||
| appVersion: "latest" | ||
| keywords: | ||
| - kafka | ||
| - streaming | ||
| - warpstream | ||
| - data | ||
| - messaging | ||
| - byoc | ||
| home: https://www.warpstream.com/ | ||
| sources: | ||
| - https://github.com/warpstreamlabs/charts | ||
| - https://github.com/warpstreamlabs/warpstream-docker-compose-example | ||
| maintainers: | ||
| - name: zopdev | ||
| url: https://zop.dev | ||
| - name: warpstream | ||
| url: https://www.warpstream.com | ||
| annotations: | ||
| # REQUIRED: zop.dev integration annotation | ||
| type: "application" | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| 1. Get the application URL by running these commands: | ||
| {{- if .Values.ingress.enabled }} | ||
| {{- range $host := .Values.ingress.hosts }} | ||
| {{- range .paths }} | ||
| http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- else if contains "NodePort" .Values.service.type }} | ||
| export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "warpstream.fullname" . }}) | ||
| export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") | ||
| echo "Kafka endpoint: $NODE_IP:$NODE_PORT" | ||
| {{- else if contains "LoadBalancer" .Values.service.type }} | ||
| NOTE: It may take a few minutes for the LoadBalancer IP to be available. | ||
| You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "warpstream.fullname" . }}' | ||
| export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "warpstream.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}") | ||
| echo "Kafka endpoint: $SERVICE_IP:{{ .Values.service.port }}" | ||
| {{- else if contains "ClusterIP" .Values.service.type }} | ||
| export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "warpstream.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") | ||
| export CONTAINER_PORT=$(kubectl get pod --namespace {{ .Release.Namespace }} $POD_NAME -o jsonpath="{.spec.containers[0].ports[0].containerPort}") | ||
| echo "Visit http://127.0.0.1:9092 to use your WarpStream cluster" | ||
| kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 9092:$CONTAINER_PORT | ||
| {{- end }} | ||
|
|
||
| 2. Connect your Kafka clients to: | ||
| Bootstrap servers: {{ include "warpstream.fullname" . }}.{{ .Release.Namespace }}.svc.cluster.local:{{ .Values.service.port }} | ||
|
|
||
| 3. Monitor your WarpStream cluster: | ||
| Metrics endpoint: {{ include "warpstream.fullname" . }}.{{ .Release.Namespace }}.svc.cluster.local:{{ .Values.service.metricsPort }} | ||
|
|
||
| 4. Schema Registry endpoint: | ||
| {{ include "warpstream.fullname" . }}.{{ .Release.Namespace }}.svc.cluster.local:{{ .Values.service.schemaRegistryPort }} | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| {{/* | ||
| Expand the name of the chart. | ||
| */}} | ||
| {{- define "warpstream.name" -}} | ||
| {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }} | ||
| {{- end }} | ||
|
|
||
| {{/* | ||
| Create a default fully qualified app name. | ||
| */}} | ||
| {{- define "warpstream.fullname" -}} | ||
| {{- if .Values.fullnameOverride }} | ||
| {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" }} | ||
| {{- else }} | ||
| {{- $name := default .Chart.Name .Values.nameOverride }} | ||
| {{- if contains $name .Release.Name }} | ||
| {{- .Release.Name | trunc 63 | trimSuffix "-" }} | ||
| {{- else }} | ||
| {{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" }} | ||
| {{- end }} | ||
| {{- end }} | ||
| {{- end }} | ||
|
|
||
| {{/* | ||
| Create chart name and version as used by the chart label. | ||
| */}} | ||
| {{- define "warpstream.chart" -}} | ||
| {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} | ||
| {{- end }} | ||
|
|
||
| {{/* | ||
| Common labels | ||
| */}} | ||
| {{- define "warpstream.labels" -}} | ||
| helm.sh/chart: {{ include "warpstream.chart" . }} | ||
| {{ include "warpstream.selectorLabels" . }} | ||
| {{- if .Chart.AppVersion }} | ||
| app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} | ||
| {{- end }} | ||
| app.kubernetes.io/managed-by: {{ .Release.Service }} | ||
| {{- end }} | ||
|
|
||
| {{/* | ||
| Selector labels | ||
| */}} | ||
| {{- define "warpstream.selectorLabels" -}} | ||
| app.kubernetes.io/name: {{ include "warpstream.name" . }} | ||
| app.kubernetes.io/instance: {{ .Release.Name }} | ||
| {{- end }} | ||
|
|
||
| {{/* | ||
| Create the name of the service account to use | ||
| */}} | ||
| {{- define "warpstream.serviceAccountName" -}} | ||
| {{- if .Values.serviceAccount.create }} | ||
| {{- default (include "warpstream.fullname" .) .Values.serviceAccount.name }} | ||
| {{- else }} | ||
| {{- default "default" .Values.serviceAccount.name }} | ||
| {{- end }} | ||
| {{- end }} | ||
|
|
||
| {{/* | ||
| WarpStream agent roles as comma-separated string | ||
| */}} | ||
| {{- define "warpstream.roles" -}} | ||
| {{- join "," .Values.warpstream.agent.roles }} | ||
| {{- end }} | ||
|
|
||
| {{/* | ||
| WarpStream command args | ||
| */}} | ||
| {{- define "warpstream.args" -}} | ||
| - "agent" | ||
| {{- if .Values.warpstream.storage.bucketURL }} | ||
| - "-bucketURL" | ||
| - {{ .Values.warpstream.storage.bucketURL | quote }} | ||
| {{- end }} | ||
| - "-defaultVirtualClusterID" | ||
| - {{ .Values.warpstream.agent.virtualClusterId | quote }} | ||
| - "-region" | ||
| - {{ .Values.warpstream.agent.region | quote }} | ||
| {{- if .Values.warpstream.agent.agentPoolId }} | ||
| - "-agentPoolID" | ||
| - {{ .Values.warpstream.agent.agentPoolId | quote }} | ||
| {{- end }} | ||
| - "-roles" | ||
| - {{ include "warpstream.roles" . | quote }} | ||
| {{- end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| {{- if .Values.monitoring.alerts.enabled }} | ||
| apiVersion: v1 | ||
| kind: ConfigMap | ||
| metadata: | ||
| name: {{ include "warpstream.fullname" . }}-alerts | ||
| labels: | ||
| {{- include "warpstream.labels" . | nindent 4 }} | ||
| grafana_alert: "1" | ||
| data: | ||
| warpstream-alerts.yaml: | | ||
| groups: | ||
| - name: warpstream | ||
| rules: | ||
| - alert: WarpStreamDown | ||
| expr: up{job="{{ include "warpstream.fullname" . }}"} == 0 | ||
| for: 2m | ||
| labels: | ||
| severity: critical | ||
| annotations: | ||
| summary: "WarpStream agent is down" | ||
| description: "WarpStream agent {{ "{{ $labels.instance }}" }} has been down for more than 2 minutes." | ||
|
|
||
| - alert: WarpStreamHighMemoryUsage | ||
| expr: (container_memory_usage_bytes{pod=~"{{ include "warpstream.fullname" . }}.*"} / container_spec_memory_limit_bytes) > 0.85 | ||
| for: 5m | ||
| labels: | ||
| severity: warning | ||
| annotations: | ||
| summary: "WarpStream agent high memory usage" | ||
| description: "WarpStream agent {{ "{{ $labels.pod }}" }} memory usage is above 85%." | ||
|
|
||
| - alert: WarpStreamHighCPUUsage | ||
| expr: (rate(container_cpu_usage_seconds_total{pod=~"{{ include "warpstream.fullname" . }}.*"}[5m]) / container_spec_cpu_quota * container_spec_cpu_period) > 0.85 | ||
| for: 5m | ||
| labels: | ||
| severity: warning | ||
| annotations: | ||
| summary: "WarpStream agent high CPU usage" | ||
| description: "WarpStream agent {{ "{{ $labels.pod }}" }} CPU usage is above 85%." | ||
| {{- end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| metadata: | ||
| name: {{ include "warpstream.fullname" . }} | ||
| labels: | ||
| {{- include "warpstream.labels" . | nindent 4 }} | ||
| spec: | ||
| {{- if not .Values.autoscaling.enabled }} | ||
| replicas: {{ .Values.replicaCount }} | ||
| {{- end }} | ||
| selector: | ||
| matchLabels: | ||
| {{- include "warpstream.selectorLabels" . | nindent 6 }} | ||
| template: | ||
| metadata: | ||
| {{- with .Values.podAnnotations }} | ||
| annotations: | ||
| {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| labels: | ||
| {{- include "warpstream.selectorLabels" . | nindent 8 }} | ||
| spec: | ||
| {{- with .Values.imagePullSecrets }} | ||
| imagePullSecrets: | ||
| {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| serviceAccountName: {{ include "warpstream.serviceAccountName" . }} | ||
| securityContext: | ||
| {{- toYaml .Values.podSecurityContext | nindent 8 }} | ||
| {{- with .Values.topologySpreadConstraints }} | ||
| topologySpreadConstraints: | ||
| {{- range . }} | ||
| - {{- toYaml . | nindent 10 }} | ||
| labelSelector: | ||
| matchLabels: | ||
| {{- include "warpstream.selectorLabels" $ | nindent 14 }} | ||
| {{- end }} | ||
| {{- end }} | ||
| containers: | ||
| - name: {{ .Chart.Name }} | ||
| securityContext: | ||
| {{- toYaml .Values.securityContext | nindent 12 }} | ||
| image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" | ||
| imagePullPolicy: {{ .Values.image.pullPolicy }} | ||
| args: | ||
| {{- include "warpstream.args" . | nindent 12 }} | ||
| ports: | ||
| - name: kafka | ||
| containerPort: 9092 | ||
| protocol: TCP | ||
| - name: metrics | ||
| containerPort: 8080 | ||
| protocol: TCP | ||
| - name: schema-registry | ||
| containerPort: 9094 | ||
| protocol: TCP | ||
| env: | ||
| - name: WARPSTREAM_API_KEY | ||
| valueFrom: | ||
| secretKeyRef: | ||
| name: {{ include "warpstream.fullname" . }}-secret | ||
| key: api-key | ||
| - name: WARPSTREAM_LOG_LEVEL | ||
| value: {{ .Values.warpstream.agent.logLevel | quote }} | ||
| {{- if .Values.warpstream.agent.availabilityZone }} | ||
| - name: WARPSTREAM_AVAILABILITY_ZONE | ||
| value: {{ .Values.warpstream.agent.availabilityZone | quote }} | ||
| {{- end }} | ||
| {{- if .Values.warpstream.performance.gomaxprocs }} | ||
| - name: GOMAXPROCS | ||
| value: {{ .Values.warpstream.performance.gomaxprocs | quote }} | ||
| {{- end }} | ||
| {{- range .Values.warpstream.extraEnvVars }} | ||
| - name: {{ .name }} | ||
| value: {{ .value | quote }} | ||
| {{- end }} | ||
| livenessProbe: | ||
| httpGet: | ||
| path: /metrics | ||
| port: metrics | ||
| initialDelaySeconds: 30 | ||
| periodSeconds: 30 | ||
| readinessProbe: | ||
| httpGet: | ||
| path: /metrics | ||
| port: metrics | ||
| initialDelaySeconds: 5 | ||
| periodSeconds: 10 | ||
| resources: | ||
| {{- toYaml .Values.resources | nindent 12 }} | ||
| {{- if .Values.persistence.enabled }} | ||
| volumeMounts: | ||
| - name: data | ||
| mountPath: /tmp/warpstream | ||
| {{- end }} | ||
| {{- if .Values.persistence.enabled }} | ||
| volumes: | ||
| - name: data | ||
| persistentVolumeClaim: | ||
| claimName: {{ include "warpstream.fullname" . }}-pvc | ||
| {{- end }} | ||
| {{- with .Values.nodeSelector }} | ||
| nodeSelector: | ||
| {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| {{- with .Values.affinity }} | ||
| affinity: | ||
| {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
| {{- with .Values.tolerations }} | ||
| tolerations: | ||
| {{- toYaml . | nindent 8 }} | ||
| {{- end }} | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| {{- if .Values.autoscaling.enabled }} | ||
| apiVersion: autoscaling/v2 | ||
| kind: HorizontalPodAutoscaler | ||
| metadata: | ||
| name: {{ include "warpstream.fullname" . }} | ||
| labels: | ||
| {{- include "warpstream.labels" . | nindent 4 }} | ||
| spec: | ||
| scaleTargetRef: | ||
| apiVersion: apps/v1 | ||
| kind: Deployment | ||
| name: {{ include "warpstream.fullname" . }} | ||
| minReplicas: {{ .Values.autoscaling.minReplicas }} | ||
| maxReplicas: {{ .Values.autoscaling.maxReplicas }} | ||
| metrics: | ||
| {{- if .Values.autoscaling.targetCPUUtilizationPercentage }} | ||
| - type: Resource | ||
| resource: | ||
| name: cpu | ||
| target: | ||
| type: Utilization | ||
| averageUtilization: {{ .Values.autoscaling.targetCPUUtilizationPercentage }} | ||
| {{- end }} | ||
| {{- if .Values.autoscaling.targetMemoryUtilizationPercentage }} | ||
| - type: Resource | ||
| resource: | ||
| name: memory | ||
| target: | ||
| type: Utilization | ||
| averageUtilization: {{ .Values.autoscaling.targetMemoryUtilizationPercentage }} | ||
| {{- end }} | ||
| {{- end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| {{- if .Values.podDisruptionBudget.enabled }} | ||
| apiVersion: policy/v1 | ||
| kind: PodDisruptionBudget | ||
| metadata: | ||
| name: {{ include "warpstream.fullname" . }} | ||
| labels: | ||
| {{- include "warpstream.labels" . | nindent 4 }} | ||
| spec: | ||
| {{- if .Values.podDisruptionBudget.minAvailable }} | ||
| minAvailable: {{ .Values.podDisruptionBudget.minAvailable }} | ||
| {{- end }} | ||
| {{- if .Values.podDisruptionBudget.maxUnavailable }} | ||
| maxUnavailable: {{ .Values.podDisruptionBudget.maxUnavailable }} | ||
| {{- end }} | ||
| selector: | ||
| matchLabels: | ||
| {{- include "warpstream.selectorLabels" . | nindent 6 }} | ||
| {{- end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| {{- if .Values.rbac.create -}} | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: ClusterRole | ||
| metadata: | ||
| name: {{ include "warpstream.fullname" . }} | ||
| labels: | ||
| {{- include "warpstream.labels" . | nindent 4 }} | ||
| rules: | ||
| - apiGroups: [""] | ||
| resources: ["nodes"] | ||
| verbs: ["get", "list"] | ||
| --- | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: ClusterRoleBinding | ||
| metadata: | ||
| name: {{ include "warpstream.fullname" . }} | ||
| labels: | ||
| {{- include "warpstream.labels" . | nindent 4 }} | ||
| roleRef: | ||
| apiGroup: rbac.authorization.k8s.io | ||
| kind: ClusterRole | ||
| name: {{ include "warpstream.fullname" . }} | ||
| subjects: | ||
| - kind: ServiceAccount | ||
| name: {{ include "warpstream.serviceAccountName" . }} | ||
| namespace: {{ .Release.Namespace }} | ||
| {{- end }} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| {{- if .Values.warpstream.agent.apiKey }} | ||
| apiVersion: v1 | ||
| kind: Secret | ||
| metadata: | ||
| name: {{ include "warpstream.fullname" . }}-secret | ||
| labels: | ||
| {{- include "warpstream.labels" . | nindent 4 }} | ||
| type: Opaque | ||
| data: | ||
| api-key: {{ .Values.warpstream.agent.apiKey | b64enc }} | ||
| {{- end }} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Refactor it so that sources and keywords are not mandatory (check in the existing chart)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
okay