reShapr Helm Charts

Helm Charts for installing reShapr components on Kubernetes

Build Status

Latest released version is 0.0.6.

Current development version is 0.0.7.

How to use them?

This repository contains two Helm charts:

• The reshapr-control-plane Helm chart is dedicated to the installation of the reShapr control plane. It is distributed as an OCI artifact on https://quay.io/repository/reshapr/reshapr-helm-charts/reshapr-control-plane

• The reshapr-proxy Helm chart is dedicated to the installation of the reShapr proxy. It is distributed as an OCI artifact on https://quay.io/repository/reshapr/reshapr-helm-charts/reshapr-proxy

• The reshapr-web-ui Helm chart is dedicated to the installation of the reShapr control UI. It is distributed as an OCI artifact on https://quay.io/repository/reshapr/reshapr-helm-charts/reshapr-web-ui

reShapr control plane

helm pull oci://quay.io/reshapr/reshapr-helm-charts/reshapr-control-plane --version 0.0.6

helm install reshapr-control-plane oci://quay.io/reshapr/reshapr-helm-charts/reshapr-control-plane --version 0.0.6 \
  --create-namespace --namespace reshapr-system \
  --set postgresql.enabled=true \
  --set postgresql.auth.password=admin \
  --set apiKey.value=dev-api-key-change-me-in-production \
  --set encryptionKey.value=dev-encryption-key-change-me-in-production \
  --set admin.nameValue=admin \
  --set admin.passwordValue=password \
  --set admin.emailValue=reshapr@example.com \
  --set admin.defaultGatewayTokensValue=my-super-secret-token-xyz \
  --set ingress.enabled=true \
  --set ingress.ctrl.host=reshapr.acme.loc

reShapr proxy

helm pull oci://quay.io/reshapr/reshapr-helm-charts/reshapr-proxy --version 0.0.6

helm install reshapr-proxy oci://quay.io/reshapr/reshapr-helm-charts/reshapr-proxy --version 0.0.6 \
  --create-namespace --namespace reshapr-proxies \
  --set gateway.idPrefix=acme \
  --set gateway.labels='env=dev;team=reshapr' \
  --set gateway.fqdns=mcp.acme.loc \
  --set ingress.enabled=true \
  --set 'ingress.hosts[0].host=mcp.acme.loc' \
  --set gateway.controlPlane.host=reshapr-control-plane-ctrl.reshapr-system \
  --set gateway.controlPlane.port=5555 \
  --set gateway.controlPlane.token=reshapr-my-super-secret-token-xyz

reShapr UI

For this one, a TLS ingress is mandatory if you choose to enable TLS. We're using a CertManager ClusterIssuer in example below:

helm pull oci://quay.io/reshapr/reshapr-helm-charts/reshapr-web-ui --version 0.0.6

helm install reshapr-ui oci://quay.io/reshapr/reshapr-helm-charts/reshapr-web-ui --version 0.0.6 \
  --namespace reshapr-system \
  --create-namespace \
  --set apiKey.value=dev-api-key-change-me-in-production \
  --set publicUrl=https://reshapr-ui.acme.loc \
  --set ingress.enabled=true \
  --set ingress.annotations."cert\-manager\.io\/cluster\-issuer"=cert-cluster-issuer \
  --set 'ingress.hosts[0].host=reshapr-ui.acme.loc' \
  --set 'ingress.tls[0].hosts[0]=reshapr-ui.acme.loc' \
  --set 'ingress.tls[0].secretName=reshapr-web-ui-tls'

This reshapr-web-ui is also included as a dependency in the control plane chart. As a consequence, you can install it directly with the control plane in a single command:

helm pull oci://quay.io/reshapr/reshapr-helm-charts/reshapr-control-plane --version 0.0.6

helm install reshapr-control-plane oci://quay.io/reshapr/reshapr-helm-charts/reshapr-control-plane --version 0.0.6 \
  --create-namespace --namespace reshapr-system \
  --set postgresql.enabled=true \
  --set postgresql.auth.password=admin \
  --set apiKey.value=dev-api-key-change-me-in-production \
  --set encryptionKey.value=dev-encryption-key-change-me-in-production \
  --set admin.nameValue=admin \
  --set admin.passwordValue=password \
  --set admin.emailValue=reshapr@example.com \
  --set admin.defaultGatewayTokensValue=my-super-secret-token-xyz \
  --set ingress.enabled=true \
  --set ingress.ctrl.host=reshapr.acme.loc \
  --set reshapr-web-ui.enabled=true \
  --set reshapr-web-ui.publicUrl=https://reshapr-ui.acme.loc \
  --set reshapr-web-ui.ingress.enabled=true \
  --set reshapr-web-ui.ingress.annotations."cert\-manager\.io\/cluster\-issuer"=cert-cluster-issuer \
  --set 'reshapr-web-ui.ingress.hosts[0].host=reshapr-ui.acme.loc' \
  --set 'reshapr-web-ui.ingress.tls[0].hosts[0]=reshapr-ui.acme.loc' \
  --set 'reshapr-web-ui.ingress.tls[0].secretName=reshapr-web-ui-tls'