Skip to content

Latest commit

History

History
61 lines (52 loc) 路 6.86 KB

README.md

File metadata and controls

61 lines (52 loc) 路 6.86 KB

Mercure Chart for Kubernetes

Version: 0.12.2 Type: application AppVersion: v0.12.2

A Helm chart to install a Mercure Hub in a Kubernetes cluster. Mercure is a protocol to push data updates to web browsers and other HTTP clients in a convenient, fast, reliable and battery-efficient way.

Learn more about Mercure.

Installing the Chart

To install the chart with the release name my-release, run the following commands:

helm repo add mercure https://charts.mercure.rocks
helm install my-release mercure/mercure

Values

Key Type Default Description
affinity object {} Affinity configuration. See the API reference for details.
autoscaling object Disabled by default. Autoscaling must not be enabled unless you are using the High Availability version (see values.yaml for details).
debug bool false Enable the debug mode.
dev bool false Enable the development mode, including the debug UI and the demo.
extraDirectives string "" Extra Mercure directives to include in the Caddyfile.
fullnameOverride string "" A name to substitute for the full names of resources.
image.pullPolicy string "IfNotPresent" Image pull policy for updating already existing images on a node.
image.repository string "dunglas/mercure" Name of the image repository to pull the container image from.
image.tag string "" Overrides the image tag whose default is the chart appVersion.
imagePullSecrets list [] Reference to one or more secrets to be used when pulling images (from private registries).
ingress.annotations object {} Annotations to be added to the ingress.
ingress.className string "" Ingress class name.
ingress.enabled bool false Enable ingress.
ingress.hosts[0].host string "mercure-example.local"
ingress.hosts[0].paths[0].path string "/"
ingress.hosts[0].paths[0].pathType string "ImplementationSpecific"
ingress.tls list See values.yaml. Ingress TLS configuration.
license string "" The license key for the High Availability version (not necessary is you use the FOSS version).
nameOverride string "" A name in place of the chart name for app: labels.
nodeSelector object {} Node selector configuration.
persistence object {"accessMode":"ReadWriteOnce","enabled":false,"existingClaim":"","size":"1Gi","storageClass":""} Enable persistence using Persistent Volume Claims, only useful if you the BoltDB transport.
persistence.accessMode string "ReadWriteOnce" A manually managed Persistent Volume and Claim. Requires persistence.enabled: true If defined, PVC must be created manually before volume will be bound.
persistence.existingClaim string "" a manually managed Persistent Volume Claim -- Requires persistence.enabled: true -- If defined, PVC must be created manually before volume will be bound
persistence.storageClass string "" Mercure Data Persistent Volume Storage Class. If defined, storageClassName: <storageClass> If set to "-"``, storageClassName: ""``, which disables dynamic provisioning. If undefined (the default) or set to null, no `storageClassName` spec is set, choosing the default provisioner.
podAnnotations object {} Annotations to be added to pods.
podSecurityContext object {} Pod security context. See the API reference for details.
publisherJwtAlg string "HS256" The JWT algorithm to use for publishers.
publisherJwtKey string "" The JWT key to use for publishers, a random key will be generated if empty.
replicaCount int 1 The number of replicas (pods) to launch, must be 1 unless you are using the High Availability version.
resources object No requests or limits. Container resource requests and limits. See the API reference for details.
securityContext object {} Container security context. See the API reference for details.
service.annotations object {}
service.port int 80 Service port.
service.type string "ClusterIP" Kubernetes service type.
serviceAccount.annotations object {} Annotations to add to the service account.
serviceAccount.create bool true Specifies whether a service account should be created.
serviceAccount.name string "" The name of the service account to use. If not set and create is true, a name is generated using the fullname template.
subscriberJwtAlg string "HS256" The JWT algorithm to use for subscribers.
subscriberJwtKey string "" The JWT key to use for subscribers, a random key will be generated if empty.
tolerations list [] Tolerations for node taints. See the API reference for details.
transportUrl string "bolt:///data/mercure.db" The URL representation of the transport to use.