Skip to content

Commit

Permalink
Mirror kafbat/kafka-ui
Browse files Browse the repository at this point in the history
  • Loading branch information
@lachlan-smith
lachlan-smith committed Oct 25, 2024
1 parent 9252ee1 commit eb738fc
Show file tree
Hide file tree
Showing 18 changed files with 968 additions and 0 deletions.
25 changes: 25 additions & 0 deletions charts/kafka-ui/.helmignore
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Patterns to ignore when building packages.
# This supports shell glob matching, relative path matching, and
# negation (prefixed with !). Only one pattern per line.
.DS_Store
# Common VCS dirs
.git/
.gitignore
.bzr/
.bzrignore
.hg/
.hgignore
.svn/
# Common backup files
*.swp
*.bak
*.tmp
*.orig
*~
# Various IDEs
.project
.idea/
*.tmproj
.vscode/
example/
README.md
7 changes: 7 additions & 0 deletions charts/kafka-ui/Chart.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
apiVersion: v2
name: kafka-ui
description: A Helm chart for kafka-UI
type: application
version: 1.4.9
appVersion: v1.0.0
icon: https://raw.githubusercontent.com/kafbat/kafka-ui/main/documentation/images/logo_new.png
89 changes: 89 additions & 0 deletions charts/kafka-ui/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
## Parameters

### Common

| Name | Description | Value |
| ------------------ | ------------------------------------------ | ----- |
| `replicaCount` | Number of Kafka-UI replicas to deploy | `1` |
| `image.registry` | image registry | `""` |
| `image.repository` | image repository | `""` |
| `image.pullPolicy` | image pull policy | `""` |
| `image.tag` | image tag (immutable tags are recommended) | `""` |
| `imagePullSecrets` | Docker registry secret names as an array | `[]` |
| `nameOverride` | String to partially override chart name | `""` |
| `fullnameOverride` | String to fully override app name | `""` |

### ServiceAccount configuration

| Name | Description | Value |
| ---------------------------- | ---------------------------------------------------- | ------ |
| `serviceAccount.name` | The name of the ServiceAccount to use. | `""` |
| `serviceAccount.create` | Specifies whether a ServiceAccount should be created | `true` |
| `serviceAccount.annotations` | Additional Service Account annotations | `{}` |

### Application configuration

| Name | Description | Value |
| -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| `existingConfigMap` | Name of the existing ConfigMap with kafbat-ui environment variables | `""` |
| `yamlApplicationConfig` | Kafbat-UI config in Yaml format | `{}` |
| `yamlApplicationConfigConfigMap` | Map with name and keyName keys, name refers to the existing ConfigMap, keyName refers to the ConfigMap key with Kafbat-UI config in Yaml format | `{}` |
| `yamlApplicationConfigSecret` | Secret with name and keyName keys, name refers to the existing ConfigMap, keyName refers to the ConfigMap key with Kafbat-UI config in Yaml format | `{}` |
| `existingSecret` | Name of the existing Secret with Kafbat-UI environment variables | `""` |
| `envs.secret` | Set of the sensitive environment variables to pass to Kafbat-UI | `{}` |
| `envs.config` | Set of the environment variables to pass to Kafbat-UI | `{}` |
| `envs.secretMappings` | The mapping of existing secret to env variable. | `{}` |
| `envs.configMappings` | The mapping of configmap and keyName to get env variable. | `{}` |
| `env` | Envs to be added to the Kafka-UI container | `{}` |
| `resources` | Set Kafka-UI container requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |
| `initContainers` | Add additional init containers to the Kafka-UI pods | `{}` |
| `volumeMounts` | Optionally specify additional volumeMounts for the kafka-UI container | `{}` |
| `volumes` | Optionally specify additional volumes for the Kafka-UI pods | `{}` |
| `hostAliases` | Kafka-UI pods host aliases | `{}` |
| `extraContainers` | Specify additional containers in extraContainers. | `""` |

### Network Policies

| Name | Description | Value |
| ----------------------- | --------------------------------------------------------- | ------- |
| `networkPolicy.enabled` | Specifies whether a NetworkPolicy should be created | `false` |
| `podAnnotations` | Annotations for Kafka-UI pods | `{}` |
| `podLabels` | Extra labels for Kafka-UI pods | `{}` |
| `annotations` | Annotations to be added to kafka-ui Deployment | `{}` |
| `labels` | Labels to be added to kafka-ui Deployment | `{}` |
| `probes.useHttpsScheme` | Set field schema as HTTPS for readines and liveness probe | `false` |

### Security Context

| Name | Description | Value |
| -------------------- | ----------------------------------------------------------------------------------- | ----- |
| `podSecurityContext` | The security settings that you specify for a Pod apply to all Containers in the Pod | `{}` |
| `securityContext` | The security settings that you specify for a Kafka-UI container | `{}` |

### Traffic Exposure Parameters

| Name | Description | Value |
| -------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| `service.type` | Kafka-UI service type | `ClusterIP` |
| `service.port` | Kafka-UI pod port number | `80` |
| `ingress.enabled` | Enable ingress record generation for Kafka-UI | `""` |
| `ingress.annotations` | Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations. | `{}` |
| `ingress.labels` | Labels for the Ingress | `{}` |
| `ingress.ingressClassName` | IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) | `""` |
| `ingress.path` | Default path for the ingress record | `/` |
| `ingress.pathType` | Ingress path type | `Prefix` |
| `ingress.host` | Default hostname for the ingress record | `""` |
| `ingress.tls.enabled` | Enable TLS configuration for the host defined at `ingress.host` parameter | `false` |
| `ingress.tls.secretName` | The name of a pre-created Secret containing a TLS private key and certificate | `""` |
| `ingress.precedingPaths` | HTTP paths to add to the Ingress before the default path | `[]` |
| `ingress.succeedingPaths` | Http paths to add to the Ingress after the default path | `[]` |
| `resources` | Set Kafka-UI pod requests and limits for different resources like CPU or memory (essential for production workloads) | `{}` |

### Scheduling

| Name | Description | Value |
| ---------------------- | ----------------------------------------------------------------------- | ----- |
| `nodeSelector` | Node labels for Kafka-UI pods assignment | `{}` |
| `tolerations` | Tolerations for Kafka-UI pods assignment | `[]` |
| `affinity` | Affinity for Kafka-UI pods assignment | `{}` |
| `revisionHistoryLimit` | Specify how many old ReplicaSets for this Deployment you want to retain | `nil` |
15 changes: 15 additions & 0 deletions charts/kafka-ui/artifacthub-repo.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Artifact Hub repository metadata file
#
# Some settings like the verified publisher flag or the ignored packages won't
# be applied until the next time the repository is processed. Please keep in
# mind that the repository won't be processed if it has not changed since the
# last time it was processed. Depending on the repository kind, this is checked
# in a different way. For Helm http based repositories, we consider it has
# changed if the `index.yaml` file changes. For git based repositories, it does
# when the hash of the last commit in the branch you set up changes. This does
# NOT apply to ownership claim operations, which are processed immediately.
#
repositoryID: 243d43a8-9c5f-42b8-8173-c23350ed1e7a
owners:
- name: maintainers.kafbat
email: [email protected]
3 changes: 3 additions & 0 deletions charts/kafka-ui/index.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
apiVersion: v1
entries: {}
generated: "2021-11-11T12:26:08.479581+03:00"
21 changes: 21 additions & 0 deletions charts/kafka-ui/templates/NOTES.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
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 }}{{ . }}
{{- 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 "kafka-ui.fullname" . }})
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
echo http://$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 "kafka-ui.fullname" . }}'
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "kafka-ui.fullname" . }} --template "{{"{{ range (index .status.loadBalancer.ingress 0) }}{{.}}{{ end }}"}}")
echo http://$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 "kafka-ui.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
echo "Visit http://127.0.0.1:8080 to use your application"
kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:8080
{{- end }}
84 changes: 84 additions & 0 deletions charts/kafka-ui/templates/_helpers.tpl
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
{{/* vim: set filetype=mustache: */}}
{{/*
Expand the name of the chart.
*/}}
{{- define "kafka-ui.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" }}
{{- end }}

{{/*
Create a default fully qualified app name.
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
If release name contains chart name it will be used as a full name.
*/}}
{{- define "kafka-ui.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 "kafka-ui.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }}
{{- end }}

{{/*
Common labels
*/}}
{{- define "kafka-ui.labels" -}}
helm.sh/chart: {{ include "kafka-ui.chart" . }}
{{ include "kafka-ui.selectorLabels" . }}
{{- if .Chart.AppVersion }}
app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
{{- end }}
app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- end }}

{{/*
Selector labels
*/}}
{{- define "kafka-ui.selectorLabels" -}}
app.kubernetes.io/name: {{ include "kafka-ui.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }}
{{- end }}

{{/*
Create the name of the service account to use
*/}}
{{- define "kafka-ui.serviceAccountName" -}}
{{- if .Values.serviceAccount.create }}
{{- default (include "kafka-ui.fullname" .) .Values.serviceAccount.name }}
{{- else }}
{{- default "default" .Values.serviceAccount.name }}
{{- end }}
{{- end }}


{{/*
This allows us to check if the registry of the image is specified or not.
*/}}
{{- define "kafka-ui.imageName" -}}
{{- $registryName := .Values.image.registry -}}
{{- if .Values.global }}
{{- if .Values.global.imageRegistry }}
{{- $registryName = .Values.global.imageRegistry -}}
{{- end -}}
{{- end -}}
{{- $repository := .Values.image.repository -}}
{{- $tag := .Values.image.tag | default .Chart.AppVersion -}}
{{- if $registryName }}
{{- printf "%s/%s:%s" $registryName $repository $tag -}}
{{- else }}
{{- printf "%s:%s" $repository $tag -}}
{{- end }}
{{- end -}}

11 changes: 11 additions & 0 deletions charts/kafka-ui/templates/configmap.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{{- if .Values.envs.config -}}
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ include "kafka-ui.fullname" . }}
namespace: {{ .Release.Namespace }}
labels:
{{- include "kafka-ui.labels" . | nindent 4 }}
data:
{{- toYaml .Values.envs.config | nindent 2 }}
{{- end -}}
12 changes: 12 additions & 0 deletions charts/kafka-ui/templates/configmap_fromValues.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{{- if .Values.yamlApplicationConfig -}}
apiVersion: v1
kind: ConfigMap
metadata:
name: {{ include "kafka-ui.fullname" . }}-fromvalues
namespace: {{ .Release.Namespace }}
labels:
{{- include "kafka-ui.labels" . | nindent 4 }}
data:
config.yml: |-
{{- tpl (toYaml .Values.yamlApplicationConfig) . | nindent 4}}
{{ end }}
Loading

0 comments on commit eb738fc

Please sign in to comment.