Skip to content

Commit c165091

Browse files
oleg-nenashevoleg-nenashev
authored
Merge pull request #20 from wiremock/documentation-refresh
Documentation refresh after the migration
2 parents 1b34a12 + 97712bd commit c165091

File tree

3 files changed

+100
-30
lines changed

3 files changed

+100
-30
lines changed

‎README.md

+42-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,46 @@
1-
![CI](https://github.com/gitkent/helm-charts/actions/workflows/ci.yaml/badge.svg)
1+
![CI](https://github.com/wiremock/helm-charts/actions/workflows/ci.yaml/badge.svg)
22

3-
# helm-charts
4-
Helm Chart for deployment to Kubernetes.
3+
# WireMock Helm Charts
4+
5+
Helm Chart for WireMock deployment to Kubernetes.
6+
It allows deploying the official [WireMock Docker images](https://github.com/wiremock/wiremock-docker)
7+
and also other charts that extend it,
8+
in particular [holomekc/wiremock](https://github.com/holomekc/wiremock) with embedded UI.
59

610
# Quick Start
11+
712
## Pre-requisites
8-
1. [Install minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)
9-
2. [Install helm](https://helm.sh/docs/intro/install/)
10-
3. Deploy Wiremock
11-
```bash
12-
helm upgrade --install <release_name> ./chart/<chart_name>
13-
```
13+
14+
1. [Install Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) or use another Kubernetes cluster
15+
2. [Install Helm](https://helm.sh/docs/intro/install/)
16+
17+
## Install WireMock
18+
19+
```bash
20+
helm upgrade --install <release_name> ./chart/<chart_name>
21+
```
22+
23+
Setup port forwarding
24+
25+
```bash
26+
$ 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}")
27+
28+
$ kubectl port-forward $POD_NAME 8080:{{ .Values.service.internalPort}}
29+
```
30+
31+
## Verify Wiremock deployment
32+
33+
To verify erifying a response using Wiremock, run
34+
35+
```bash
36+
$ curl -X POST http://127.0.0.1:8080/v1/hello
37+
```
38+
39+
To check the web app when using `holomekc/wiremock`, visit http://127.0.0.1:8080/__admin/webapp on your browser.
40+
41+
# References:
42+
43+
- [WireMock Java Library](https://github.com/tomakehurst/wiremock)
44+
- [Official WireMock Docker Image](https://github.com/wiremock/wiremock-docker)
45+
- [WireMock extended with Web UI](https://github.com/holomekc/wiremock), a project by [(@holomekc]https://github.com/holomekc)
46+

‎charts/wiremock/Chart.yaml

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
apiVersion: v1
22
appVersion: "2.32.0.2"
3-
description: A Helm chart for Wiremock deployment on Kubernetes
3+
description: A Helm chart for WireMock deployment on Kubernetes
44
name: wiremock
5-
version: 0.1.3
5+
version: 0.1.4
6+
maintainers:
7+
- name: "gitkent"
8+
url: "https://github.com/gitkent"
9+
- name: "oleg-nenashev"
10+
url: "https://github.com/oleg-nenashev"
11+
icon: "https://wiremock.org/images/logos/wiremock/logo_square.svg"
12+
home: "https://wiremock.org"
13+
sources:
14+
- "https://github.com/wiremock/helm-charts"
15+
- "https://github.com/wiremock/wiremock-docker"
16+
- "https://github.com/wiremock/wiremock"
17+
keywords:
18+
- wiremock
19+
- api
20+
- openapi
21+
- api-testing
22+
- rest-api
23+
- api-mocking

‎charts/wiremock/README.md

+38-19
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,45 @@
11
# wiremock-helm
2-
Helm Chart for deployment Wiremock to Kubernetes
2+
3+
Helm Chart for WireMock deployment to Kubernetes.
4+
It allows deploying the official [WireMock Docker images](https://github.com/wiremock/wiremock-docker)
5+
and also other charts that extend it,
6+
in particular [holomekc/wiremock](https://github.com/holomekc/wiremock) with embedded UI.
37

48
# Quick Start
9+
510
## Pre-requisites
6-
1. [Install minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)
11+
12+
1. [Install Minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/)
713
2. [Install helm](https://helm.sh/docs/intro/install/)
8-
3. Deploy Wiremock
9-
```bash
10-
helm upgrade --install wiremock ./charts/wiremock
11-
```
12-
4. Verify Wiremock deployment
13-
```bash
14-
$ 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}")
15-
16-
$ kubectl port-forward $POD_NAME 8080:{{ .Values.service.internalPort}}
17-
```
18-
Visit http://127.0.0.1:8080/__admin/webapp on your browser.
19-
5. Verifying a response using Wiremock, run
20-
```
21-
$ curl -X POST http://127.0.0.1:8080/v1/hello
22-
```
2314

15+
## Deploy WireMock
16+
17+
Install WireMock using the Helm chart
18+
19+
```bash
20+
helm upgrade --install wiremock ./charts/wiremock
21+
```
22+
23+
Setup port forwarding
24+
25+
```bash
26+
$ 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}")
27+
28+
$ kubectl port-forward $POD_NAME 8080:{{ .Values.service.internalPort}}
29+
```
30+
31+
## Verify Wiremock deployment
32+
33+
To verify erifying a response using Wiremock, run
34+
35+
```bash
36+
$ curl -X POST http://127.0.0.1:8080/v1/hello
37+
```
38+
39+
To check the web app when using `holomekc/wiremock`, visit http://127.0.0.1:8080/__admin/webapp on your browser.
40+
2441
# References:
25-
* https://github.com/holomekc/wiremock
26-
* https://github.com/tomakehurst/wiremock
42+
43+
- [WireMock Java Library](https://github.com/tomakehurst/wiremock)
44+
- [Official WireMock Docker Image](https://github.com/wiremock/wiremock-docker)
45+
- [WireMock extended with Web UI](https://github.com/holomekc/wiremock), a project by [(@holomekc]https://github.com/holomekc)

0 commit comments

Comments
 (0)