From d9ecd703ae7f32a0b454f6cff229a99431952658 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Mon, 15 May 2023 18:31:41 +0200 Subject: [PATCH 1/9] Update the landing --- README.md | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index caa0336..95d688f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,20 @@ -![CI](https://github.com/gitkent/helm-charts/actions/workflows/ci.yaml/badge.svg) +![CI](https://github.com/wiremock/helm-charts/actions/workflows/ci.yaml/badge.svg) -# helm-charts -Helm Chart for deployment to Kubernetes. +# WireMock Helm Charts + +Helm Chart for WireMock deployment to Kubernetes. # Quick Start + ## Pre-requisites -1. [Install minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) -2. [Install helm](https://helm.sh/docs/intro/install/) -3. Deploy Wiremock - ```bash - helm upgrade --install ./chart/ - ``` \ No newline at end of file + +1. [Install Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) or use another Kubernetes cluster +2. [Install Helm](https://helm.sh/docs/intro/install/) + +## Install WireMock + +```bash +helm upgrade --install ./chart/ +``` + + From ed3ac16c7af7a809cc8fd9e430da8e8d5e26a6e9 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Mon, 15 May 2023 18:44:48 +0200 Subject: [PATCH 2/9] Prettify the Chart readme, clarify WireMock and holomekc/wiremock differences --- charts/wiremock/README.md | 57 ++++++++++++++++++++++++++------------- 1 file changed, 38 insertions(+), 19 deletions(-) diff --git a/charts/wiremock/README.md b/charts/wiremock/README.md index 4872c67..c2bd208 100644 --- a/charts/wiremock/README.md +++ b/charts/wiremock/README.md @@ -1,26 +1,45 @@ # wiremock-helm -Helm Chart for deployment Wiremock to Kubernetes + +Helm Chart for WireMock deployment to Kubernetes. +It allows deploying the official [WireMock Docker images](https://github.com/wiremock/wiremock-docker) +and also other charts that extend it, +in particular [holomekc/wiremock](https://github.com/holomekc/wiremock) with embedded UI. # Quick Start + ## Pre-requisites -1. [Install minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) + +1. [Install Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) 2. [Install helm](https://helm.sh/docs/intro/install/) -3. Deploy Wiremock - ```bash - helm upgrade --install wiremock ./charts/wiremock - ``` -4. Verify Wiremock deployment - ```bash - $ export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "wiremock.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") - - $ kubectl port-forward $POD_NAME 8080:{{ .Values.service.internalPort}} - ``` - Visit http://127.0.0.1:8080/__admin/webapp on your browser. -5. Verifying a response using Wiremock, run - ``` - $ curl -X POST http://127.0.0.1:8080/v1/hello - ``` +## Deploy WireMock + +Install WireMock using the Helm chart + +```bash +helm upgrade --install wiremock ./charts/wiremock +``` + +Setup port forwarding + +```bash +$ export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "wiremock.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + +$ kubectl port-forward $POD_NAME 8080:{{ .Values.service.internalPort}} +``` + +## Verify Wiremock deployment + +To verify erifying a response using Wiremock, run + +```bash +$ curl -X POST http://127.0.0.1:8080/v1/hello +``` + +To check the web app when using `holomekc/wiremock`, visit http://127.0.0.1:8080/__admin/webapp on your browser. + # References: -* https://github.com/holomekc/wiremock -* https://github.com/tomakehurst/wiremock \ No newline at end of file + +- [WireMock Java Library](https://github.com/tomakehurst/wiremock) +- [Official WireMock Docker Image](https://github.com/wiremock/wiremock-docker) +- [WireMock extended with Web UI](https://github.com/holomekc/wiremock), a project by [(@holomekc]https://github.com/holomekc) From 1fa05e18eba019419a523aa0d05548b2971a4cc4 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Mon, 15 May 2023 18:46:02 +0200 Subject: [PATCH 3/9] Fix WireMock name in Chart.yaml --- charts/wiremock/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/wiremock/Chart.yaml b/charts/wiremock/Chart.yaml index 9e271f7..9c65f4a 100644 --- a/charts/wiremock/Chart.yaml +++ b/charts/wiremock/Chart.yaml @@ -1,5 +1,5 @@ apiVersion: v1 appVersion: "2.32.0.2" -description: A Helm chart for Wiremock deployment on Kubernetes +description: A Helm chart for WireMock deployment on Kubernetes name: wiremock version: 0.1.3 From ea6a746afe28befa6751db060e0596649ad2b9fb Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Mon, 15 May 2023 18:47:24 +0200 Subject: [PATCH 4/9] Add WireMock quickstart information to README too --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 95d688f..42a5d82 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ # WireMock Helm Charts Helm Chart for WireMock deployment to Kubernetes. +It allows deploying the official [WireMock Docker images](https://github.com/wiremock/wiremock-docker) +and also other charts that extend it, +in particular [holomekc/wiremock](https://github.com/holomekc/wiremock) with embedded UI. # Quick Start @@ -17,4 +20,27 @@ Helm Chart for WireMock deployment to Kubernetes. helm upgrade --install ./chart/ ``` +Setup port forwarding + +```bash +$ export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "wiremock.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + +$ kubectl port-forward $POD_NAME 8080:{{ .Values.service.internalPort}} +``` + +## Verify Wiremock deployment + +To verify erifying a response using Wiremock, run + +```bash +$ curl -X POST http://127.0.0.1:8080/v1/hello +``` + +To check the web app when using `holomekc/wiremock`, visit http://127.0.0.1:8080/__admin/webapp on your browser. + +# References: + +- [WireMock Java Library](https://github.com/tomakehurst/wiremock) +- [Official WireMock Docker Image](https://github.com/wiremock/wiremock-docker) +- [WireMock extended with Web UI](https://github.com/holomekc/wiremock), a project by [(@holomekc]https://github.com/holomekc) From e0fe2a2b2a0b348be09af7bc6ba808800255174f Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Mon, 22 May 2023 19:50:12 +0200 Subject: [PATCH 5/9] Update Helm chart version --- charts/wiremock/Chart.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/charts/wiremock/Chart.yaml b/charts/wiremock/Chart.yaml index 9c65f4a..551285f 100644 --- a/charts/wiremock/Chart.yaml +++ b/charts/wiremock/Chart.yaml @@ -2,4 +2,4 @@ apiVersion: v1 appVersion: "2.32.0.2" description: A Helm chart for WireMock deployment on Kubernetes name: wiremock -version: 0.1.3 +version: 0.1.4 From d53ba6eebf5756761e23f9590000c2d1b55f4fce Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Mon, 22 May 2023 19:59:18 +0200 Subject: [PATCH 6/9] Add maintainers to Chart.yaml --- charts/wiremock/Chart.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/charts/wiremock/Chart.yaml b/charts/wiremock/Chart.yaml index 551285f..5a0b816 100644 --- a/charts/wiremock/Chart.yaml +++ b/charts/wiremock/Chart.yaml @@ -3,3 +3,8 @@ appVersion: "2.32.0.2" description: A Helm chart for WireMock deployment on Kubernetes name: wiremock version: 0.1.4 +maintainers: + - name: "kent.io" + url: "https://github.com/gitkent" + - name: "Oleg Nenashev" + url: "https://github.com/oleg-nenashev" From e375f2f20bf27d84c178ad226d1fd31363f01ecf Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Mon, 22 May 2023 20:03:45 +0200 Subject: [PATCH 7/9] Add documentation metadata to Chart.yaml --- charts/wiremock/Chart.yaml | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/charts/wiremock/Chart.yaml b/charts/wiremock/Chart.yaml index 5a0b816..762214d 100644 --- a/charts/wiremock/Chart.yaml +++ b/charts/wiremock/Chart.yaml @@ -8,3 +8,16 @@ maintainers: url: "https://github.com/gitkent" - name: "Oleg Nenashev" url: "https://github.com/oleg-nenashev" +icon: "https://wiremock.org/images/logos/wiremock/logo_square.svg" +home: "https://wiremock.org" +sources: + - "https://github.com/wiremock/helm-charts" + - "https://github.com/wiremock/wiremock-docker" + - "https://github.com/wiremock/wiremock" +keywords: + - wiremock + - api + - openapi + - api-testing + - rest-api + - api-mocking From 5fa7690f7302b82472971660880d03bd3608a919 Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Mon, 22 May 2023 20:05:27 +0200 Subject: [PATCH 8/9] Address lint errors in Chart.yaml --- charts/wiremock/Chart.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/charts/wiremock/Chart.yaml b/charts/wiremock/Chart.yaml index 762214d..416fd04 100644 --- a/charts/wiremock/Chart.yaml +++ b/charts/wiremock/Chart.yaml @@ -4,7 +4,7 @@ description: A Helm chart for WireMock deployment on Kubernetes name: wiremock version: 0.1.4 maintainers: - - name: "kent.io" + - name: "Kent Lee" url: "https://github.com/gitkent" - name: "Oleg Nenashev" url: "https://github.com/oleg-nenashev" @@ -13,7 +13,7 @@ home: "https://wiremock.org" sources: - "https://github.com/wiremock/helm-charts" - "https://github.com/wiremock/wiremock-docker" - - "https://github.com/wiremock/wiremock" + - "https://github.com/wiremock/wiremock" keywords: - wiremock - api From 97712bdd442ca11683458daf29e8fa86fbd955ff Mon Sep 17 00:00:00 2001 From: Oleg Nenashev Date: Mon, 22 May 2023 20:09:55 +0200 Subject: [PATCH 9/9] Maintainer name is actually GitHub ID for the checker --- charts/wiremock/Chart.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/charts/wiremock/Chart.yaml b/charts/wiremock/Chart.yaml index 416fd04..345ce52 100644 --- a/charts/wiremock/Chart.yaml +++ b/charts/wiremock/Chart.yaml @@ -4,9 +4,9 @@ description: A Helm chart for WireMock deployment on Kubernetes name: wiremock version: 0.1.4 maintainers: - - name: "Kent Lee" + - name: "gitkent" url: "https://github.com/gitkent" - - name: "Oleg Nenashev" + - name: "oleg-nenashev" url: "https://github.com/oleg-nenashev" icon: "https://wiremock.org/images/logos/wiremock/logo_square.svg" home: "https://wiremock.org"