From fd7be37b876b76d426b8bb470d77a7b4a84a3bac Mon Sep 17 00:00:00 2001 From: s0ko1ex Date: Fri, 1 Nov 2024 12:56:18 +0300 Subject: [PATCH 1/3] Add a helm chart --- charts/webhook-tester/.helmignore | 23 ++++ charts/webhook-tester/Chart.yaml | 24 ++++ charts/webhook-tester/templates/NOTES.txt | 22 ++++ charts/webhook-tester/templates/_helpers.tpl | 51 +++++++++ .../webhook-tester/templates/deployment.yaml | 83 ++++++++++++++ charts/webhook-tester/templates/ingress.yaml | 61 +++++++++++ charts/webhook-tester/templates/service.yaml | 15 +++ charts/webhook-tester/values.yaml | 103 ++++++++++++++++++ 8 files changed, 382 insertions(+) create mode 100644 charts/webhook-tester/.helmignore create mode 100644 charts/webhook-tester/Chart.yaml create mode 100644 charts/webhook-tester/templates/NOTES.txt create mode 100644 charts/webhook-tester/templates/_helpers.tpl create mode 100644 charts/webhook-tester/templates/deployment.yaml create mode 100644 charts/webhook-tester/templates/ingress.yaml create mode 100644 charts/webhook-tester/templates/service.yaml create mode 100644 charts/webhook-tester/values.yaml diff --git a/charts/webhook-tester/.helmignore b/charts/webhook-tester/.helmignore new file mode 100644 index 00000000..0e8a0eb3 --- /dev/null +++ b/charts/webhook-tester/.helmignore @@ -0,0 +1,23 @@ +# 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/ diff --git a/charts/webhook-tester/Chart.yaml b/charts/webhook-tester/Chart.yaml new file mode 100644 index 00000000..42e0e6d6 --- /dev/null +++ b/charts/webhook-tester/Chart.yaml @@ -0,0 +1,24 @@ +apiVersion: v2 +name: webhook-tester +description: A Helm chart for Kubernetes + +# A chart can be either an 'application' or a 'library' chart. +# +# Application charts are a collection of templates that can be packaged into versioned archives +# to be deployed. +# +# Library charts provide useful utilities or functions for the chart developer. They're included as +# a dependency of application charts to inject those utilities and functions into the rendering +# pipeline. Library charts do not define any templates and therefore cannot be deployed. +type: application + +# This is the chart version. This version number should be incremented each time you make changes +# to the chart and its templates, including the app version. +# Versions are expected to follow Semantic Versioning (https://semver.org/) +version: 0.1.0 + +# This is the version number of the application being deployed. This version number should be +# incremented each time you make changes to the application. Versions are not expected to +# follow Semantic Versioning. They should reflect the version the application is using. +# It is recommended to use it with quotes. +appVersion: "1.16.0" diff --git a/charts/webhook-tester/templates/NOTES.txt b/charts/webhook-tester/templates/NOTES.txt new file mode 100644 index 00000000..d2c82f29 --- /dev/null +++ b/charts/webhook-tester/templates/NOTES.txt @@ -0,0 +1,22 @@ +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 "webhook-tester.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 its status by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "webhook-tester.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "webhook-tester.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 "webhook-tester.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:8080 to use your application" + kubectl --namespace {{ .Release.Namespace }} port-forward $POD_NAME 8080:$CONTAINER_PORT +{{- end }} diff --git a/charts/webhook-tester/templates/_helpers.tpl b/charts/webhook-tester/templates/_helpers.tpl new file mode 100644 index 00000000..3a4b249d --- /dev/null +++ b/charts/webhook-tester/templates/_helpers.tpl @@ -0,0 +1,51 @@ +{{/* +Expand the name of the chart. +*/}} +{{- define "webhook-tester.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 "webhook-tester.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 "webhook-tester.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" }} +{{- end }} + +{{/* +Common labels +*/}} +{{- define "webhook-tester.labels" -}} +helm.sh/chart: {{ include "webhook-tester.chart" . }} +{{ include "webhook-tester.selectorLabels" . }} +{{- if .Chart.AppVersion }} +app.kubernetes.io/version: {{ .Chart.AppVersion | quote }} +{{- end }} +app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- end }} + +{{/* +Selector labels +*/}} +{{- define "webhook-tester.selectorLabels" -}} +app.kubernetes.io/name: {{ include "webhook-tester.name" . }} +app.kubernetes.io/instance: {{ .Release.Name }} +{{- end }} diff --git a/charts/webhook-tester/templates/deployment.yaml b/charts/webhook-tester/templates/deployment.yaml new file mode 100644 index 00000000..da9ad9c3 --- /dev/null +++ b/charts/webhook-tester/templates/deployment.yaml @@ -0,0 +1,83 @@ +apiVersion: apps/v1 +kind: Deployment +metadata: + name: {{ include "webhook-tester.fullname" . }} + labels: + {{- include "webhook-tester.labels" . | nindent 4 }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + {{- include "webhook-tester.selectorLabels" . | nindent 6 }} + template: + metadata: + {{- with .Values.podAnnotations }} + annotations: + {{- toYaml . | nindent 8 }} + {{- end }} + labels: + {{- include "webhook-tester.labels" . | nindent 8 }} + {{- with .Values.podLabels }} + {{- toYaml . | nindent 8 }} + {{- end }} + spec: + {{- with .Values.imagePullSecrets }} + imagePullSecrets: + {{- toYaml . | nindent 8 }} + {{- end }} + securityContext: + {{- toYaml .Values.podSecurityContext | nindent 8 }} + containers: + - name: {{ .Chart.Name }} + securityContext: + {{- toYaml .Values.securityContext | nindent 12 }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: {{ .Values.config.port }} + protocol: TCP + args: + - server + - --port={{ .Values.config.port }} + - --listen="{{ .Values.config.listen }}" + - --max-requests={{ .Values.config.maxRequests }} + - --session-ttl="{{ .Values.config.sessionTTL }}" + {{- range .Values.config.ignoreHeaderPrefix }} + - --ignore-header-prefix="{{ . }}" + {{- end}} + - --max-request-body-size={{ .Values.config.maxRequestBodySize }} + - --redis-dsn="{{ .Values.config.redisDSN }}" + - --storage-driver="{{ .Values.config.storageDriver }}" + - --pubsub-driver="{{ .Values.config.pubsubDriver }}" + - --ws-max-clients={{ .Values.config.wsMaxClients }} + - --ws-max-lifetime="{{ .Values.config.wsMaxLifetime }}" + {{- if .Values.config.createSession }} + - --create-session="{{ .Values.config.createSession }}" + {{- end }} + livenessProbe: + {{- toYaml .Values.livenessProbe | nindent 12 }} + readinessProbe: + {{- toYaml .Values.readinessProbe | nindent 12 }} + resources: + {{- toYaml .Values.resources | nindent 12 }} + {{- with .Values.volumeMounts }} + volumeMounts: + {{- toYaml . | nindent 12 }} + {{- end }} + {{- with .Values.volumes }} + volumes: + {{- toYaml . | nindent 8 }} + {{- 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 }} diff --git a/charts/webhook-tester/templates/ingress.yaml b/charts/webhook-tester/templates/ingress.yaml new file mode 100644 index 00000000..57a195a3 --- /dev/null +++ b/charts/webhook-tester/templates/ingress.yaml @@ -0,0 +1,61 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "webhook-tester.fullname" . -}} +{{- $svcPort := .Values.service.port -}} +{{- if and .Values.ingress.className (not (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion)) }} + {{- if not (hasKey .Values.ingress.annotations "kubernetes.io/ingress.class") }} + {{- $_ := set .Values.ingress.annotations "kubernetes.io/ingress.class" .Values.ingress.className}} + {{- end }} +{{- end }} +{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1 +{{- else if semverCompare ">=1.14-0" .Capabilities.KubeVersion.GitVersion -}} +apiVersion: networking.k8s.io/v1beta1 +{{- else -}} +apiVersion: extensions/v1beta1 +{{- end }} +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + {{- include "webhook-tester.labels" . | nindent 4 }} + {{- with .Values.ingress.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} +spec: + {{- if and .Values.ingress.className (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }} + ingressClassName: {{ .Values.ingress.className }} + {{- end }} + {{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} + {{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ .host | quote }} + http: + paths: + {{- range .paths }} + - path: {{ .path }} + {{- if and .pathType (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }} + pathType: {{ .pathType }} + {{- end }} + backend: + {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} + service: + name: {{ $fullName }} + port: + number: {{ $svcPort }} + {{- else }} + serviceName: {{ $fullName }} + servicePort: {{ $svcPort }} + {{- end }} + {{- end }} + {{- end }} +{{- end }} diff --git a/charts/webhook-tester/templates/service.yaml b/charts/webhook-tester/templates/service.yaml new file mode 100644 index 00000000..72efe051 --- /dev/null +++ b/charts/webhook-tester/templates/service.yaml @@ -0,0 +1,15 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "webhook-tester.fullname" . }} + labels: + {{- include "webhook-tester.labels" . | nindent 4 }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + {{- include "webhook-tester.selectorLabels" . | nindent 4 }} diff --git a/charts/webhook-tester/values.yaml b/charts/webhook-tester/values.yaml new file mode 100644 index 00000000..6a47e340 --- /dev/null +++ b/charts/webhook-tester/values.yaml @@ -0,0 +1,103 @@ +# Default values for webhook-tester. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: tarampampam/webhook-tester + pullPolicy: IfNotPresent + # Overrides the image tag whose default is the chart appVersion. + tag: "1.1.0" + +imagePullSecrets: [] +nameOverride: "" +fullnameOverride: "" + +podAnnotations: {} +podLabels: {} + +podSecurityContext: {} + # fsGroup: 2000 + +securityContext: {} + # capabilities: + # drop: + # - ALL + # readOnlyRootFilesystem: true + # runAsNonRoot: true + # runAsUser: 1000 + +service: + type: ClusterIP + port: 8080 + +ingress: + enabled: false + className: "" + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + hosts: + - host: chart-example.local + paths: + - path: / + pathType: ImplementationSpecific + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +livenessProbe: + httpGet: + path: / + port: http +readinessProbe: + httpGet: + path: / + port: http + +# Additional volumes on the output Deployment definition. +volumes: [] +# - name: foo +# secret: +# secretName: mysecret +# optional: false + +# Additional volumeMounts on the output Deployment definition. +volumeMounts: [] +# - name: foo +# mountPath: "/etc/foo" +# readOnly: true + +nodeSelector: {} + +tolerations: [] + +affinity: {} + +config: + port: 8080 + listen: "0.0.0.0" + maxRequests: 128 + sessionTTL: 168h0m0s + ignoreHeaderPrefix: [] + maxRequestBodySize: 65536 + redisDSN: "redis://127.0.0.1:6379/0" + storageDriver: "memory" + pubsubDriver: "memory" + wsMaxClients: 0 + wsMaxLifetime: 0s + createSession: null From aecab65ae803d636ab5d819e15f4d46d041a3d31 Mon Sep 17 00:00:00 2001 From: s0ko1ex Date: Fri, 1 Nov 2024 12:56:28 +0300 Subject: [PATCH 2/3] Add kubernetes readme section --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 9fc9c169..6309e9d9 100644 --- a/README.md +++ b/README.md @@ -179,12 +179,24 @@ $ app [GLOBAL FLAGS] start healthcheck [COMMAND FLAGS] [ARGUMENTS...] The following flags are supported: + | Name | Description | Default value | Environment variables | |--------------|------------------|:-------------:|:---------------------:| | `--port="…"` | HTTP server port | `8080` | `HTTP_PORT` | +## ☸️ Running it in Kubernetes + +This repository includes a helm chart with basic deployment-service configuration and a possible ingress. To deploy it to your cluster run + +```shell +helm install webhook-tester ./charts/webhook-tester -f custom-values.yaml +``` + +All the binary arguments are configured in the `.Values.config` and are directly mapped to the same-name arguments. + + ## License This is open-sourced software licensed under the [MIT License][link_license]. From acf835179be22daae394105744469ccbc6c40d96 Mon Sep 17 00:00:00 2001 From: s0ko1ex Date: Fri, 1 Nov 2024 14:20:35 +0300 Subject: [PATCH 3/3] Add additional chart config values --- charts/webhook-tester/Chart.yaml | 27 +++++++++------------------ 1 file changed, 9 insertions(+), 18 deletions(-) diff --git a/charts/webhook-tester/Chart.yaml b/charts/webhook-tester/Chart.yaml index 42e0e6d6..bf59a08f 100644 --- a/charts/webhook-tester/Chart.yaml +++ b/charts/webhook-tester/Chart.yaml @@ -1,24 +1,15 @@ apiVersion: v2 name: webhook-tester -description: A Helm chart for Kubernetes +description: | + WebHook Tester allows you to test and debug Webhooks and HTTP requests using unique (random) URLs -# A chart can be either an 'application' or a 'library' chart. -# -# Application charts are a collection of templates that can be packaged into versioned archives -# to be deployed. -# -# Library charts provide useful utilities or functions for the chart developer. They're included as -# a dependency of application charts to inject those utilities and functions into the rendering -# pipeline. Library charts do not define any templates and therefore cannot be deployed. type: application - -# This is the chart version. This version number should be incremented each time you make changes -# to the chart and its templates, including the app version. -# Versions are expected to follow Semantic Versioning (https://semver.org/) version: 0.1.0 +appVersion: "1.1.0" -# This is the version number of the application being deployed. This version number should be -# incremented each time you make changes to the application. Versions are not expected to -# follow Semantic Versioning. They should reflect the version the application is using. -# It is recommended to use it with quotes. -appVersion: "1.16.0" +icon: https://hsto.org/webt/mn/fz/q-/mnfzq-lgdnbmv-3xv-1qm6gn82e.png +sources: + - https://github.com/tarampampam/webhook-tester/ +maintainers: + - name: s0ko1ex + email: s0ko1ex@proton.me