This Helm chart provides an easy-2-go API mock or proxy using Stoplight Prism.
Currently, the Helm chart supports:
- Spec as a local file (using
--set-fileor inline) - Publicly hosted spec on Git
- Privately hosted spec on Github, using a Github App
- Github App provided through ExternalSecret
- Support fetch from S3
- Support fetch from HTTP(s)
- Improve the
service.originso it contains an absolute path - Harden the init container
Helm must be installed and initialized to use the charts. Please refer to Helm's documentation to get started.
Once Helm is set up properly, add the repo as follows. Make sure to replace <Version> with one of the version available down bellow:
$ helm repo add stint-opensource https://raw.githubusercontent.com/stintco/stoplight-prism-helm/<Version>/| Version | Description | Suggestion |
|---|---|---|
v1.0.0-RC4 (Stable) |
This is the most stable release, however, it won't come with any support! | Recommended for any live product |
main (Unstable) |
This is the latest version of the library. It is likely to contain breaking changes as it grows! | Recommended for early development or PoC which are likely to take a certain time before being consider stable. Make sure to use the stable tag once your project becomes stable! |
v1.0.0 (Unavailable yet) |
This version is scheduled to be released when the chart will be used widely and we have gained confidence on its stability. | - |
| <branchName> | You can use any branch name. | When working on a fix or a new feature, this is the easier way to test your library within the project which is depending of this change. |
To install the chart with the release name my-service-mock:
$ helm install my-service-mock stoplight-prismHere is a complete example:
$ helm repo add stint-opensource https://raw.githubusercontent.com/stintco/stoplight-prism-helm/main/
$ helm repo update
# -- Using a spec file
$ helm install my-service-mock stint-opensource/stoplight-prism --namespace my-namespace \
--create-namespace --wait --timeout 5m \
--set imagePullSecrets[0].name=docker-config-default \
--set service.name=my-service \
--set service.probe=/pets \
--set-file service.openapi.content=/path/to/my/swagger.yml \
--set ingress.host=service.internal
# -- Using a public repo
$ helm install my-service-mock stint-opensource/stoplight-prism --namespace my-namespace \
--create-namespace --wait --timeout 5m \
--set imagePullSecrets[0].name=docker-config-default \
--set service.name=my-service \
--set service.origin=github.com/stintco/stoplight-prism-helm.git \
--set service.specPath=examples/openapi.yaml \
--set service.branch=main \
--set service.probe=/pets \
--set ingress.host=service.internal
# -- Using a private repo and a GH app with access to it
$ helm install my-service-mock stint-opensource/stoplight-prism --namespace my-namespace \
--create-namespace --wait --timeout 5m \
--set imagePullSecrets[0].name=docker-config-default \
--set service.name=my-service \
--set service.origin=github.com/stintco/stoplight-prism-helm.git \
--set service.specPath=examples/openapi.yaml \
--set service.branch=main \
--set service.probe=/pets \
--set github.appId=123456 \
--set github.installId=12345678 \
--set github.secret.type=external-secret \
--set github.secret.backend=systemManager \
--set github.secret.name=/my/ssm/with/app_private_key \
--set ingress.host=service.internalTo uninstall the chart with the release name my-service-mock:
$ helm uninstall my-service-mock| Parameter | Description | Default |
|---|---|---|
image.repository |
The Stoplight Prism docker repo to use | stoplight/prism |
image.tag |
The Docker image tag | 4 |
image.pullPolicy |
The k8s pull policy | IfNotPresent |
imagePullSecrets |
The Docker secrets to use. Must be an array of object with the attribute name set. |
[] |
deployment.annotations |
The deployment annotations | {} |
resources.limits.cpu |
The Prism container CPU limit | "150m" |
resources.limits.memory |
The Prism container RAM limit | "250Mi" |
resources.requests.cpu |
The Prism container CPU request | "50m" |
resources.requests.memory |
The Prism container RAM request | "100Mi" |
github.appId |
The Github App ID. Note: If provided, make sure to comple the Github values. (Optional) | |
github.installId |
The Github App installation ID. Can be found using the Github documentation (Optional) | |
github.secret.type |
The type of secret. This correspond to the kind in K8S API. Only external-secret is supported at the moment. |
|
github.secret.backend |
The type of backend when using external-secret. Refer to the documentation for further details. |
|
github.secret.name |
The secret name. Vary depending of the use backend | |
github.secret.role |
The role to use when fetching the external secret. (Optional) | |
github.secret.region |
The region in which to fetch the external secret. (Optional) | |
service.mode |
The Prism mode to use, either mock or proxy |
mock |
service.upstream |
If using proxy, the upstream API endpoint, ignored otherwise. |
|
service.name |
The service nickname | service |
service.probe |
The path can be GET on the API to probe readiness and liveness. Must return a status code < 400. DIsabled if not provided. (Optional) |
|
service.openapi.content |
The inline content of the OpenAPI YAML spec to use. You can pass a local file using set-file. (Optional) |
|
service.origin |
The Git remote address. Only https is supported, but you need not to include https://. This is because the access token will be injected before the domain. |
|
service.specPath |
The path to the OA3 spec | openapi.yaml |
service.branch |
The branch where to find it | master |
ingress.enabled |
Whether or not to create an ingress. Will only create a service otherwise, which can be used for in-cluster mocking. | false |
ingress.host |
The ingress host. The TLS certificate must be available without explicit secret. You can set a wildcard to achieve this. |
service.internal |
ingress.ingressClassName |
The ingress class name to use | "" |
ingress.annotations |
The ingress annotations | {} |
labels |
Labels to put on each resources created by this chart | {} |