Skip to content

Commit cbec56f

Browse files
committed
chore: prepare release 0.17.0
1 parent 255e63b commit cbec56f

File tree

4 files changed

+50
-42
lines changed

4 files changed

+50
-42
lines changed

caddy/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ replace github.com/dunglas/mercure => ../
1414
require (
1515
github.com/MicahParks/keyfunc/v3 v3.3.5
1616
github.com/caddyserver/caddy/v2 v2.8.4
17-
github.com/dunglas/mercure v0.16.3
17+
github.com/dunglas/mercure v0.17.0
1818
github.com/prometheus/client_golang v1.20.5
1919
github.com/stretchr/testify v1.9.0
2020
go.uber.org/zap v1.27.0

charts/mercure/Chart.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ keywords:
1212
- streaming-api
1313
- async-api
1414
type: application
15-
version: 0.16.3
16-
appVersion: "v0.16.3"
15+
version: 0.17.0
16+
appVersion: "v0.17.0"
1717
maintainers:
1818
- name: dunglas
1919

charts/mercure/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- markdownlint-disable -->
22
# Mercure Chart for Kubernetes
33

4-
![Version: 0.16.3](https://img.shields.io/badge/Version-0.16.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.16.3](https://img.shields.io/badge/AppVersion-v0.16.3-informational?style=flat-square)
4+
![Version: 0.17.0](https://img.shields.io/badge/Version-0.17.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.17.0](https://img.shields.io/badge/AppVersion-v0.17.0-informational?style=flat-square)
55

66
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.
77

@@ -25,6 +25,7 @@ To install the chart with the release name `my-release`, run the following comma
2525
| dev | bool | `false` | Enable the development mode, including the debug UI and the demo. |
2626
| existingSecret | string | `""` | Allows to pass an existing secret name, the above values will be used if empty. |
2727
| extraDirectives | string | `""` | Inject extra Mercure directives in the Caddyfile. |
28+
| extraEnvs | list | `[]` | Additional environment variables to set |
2829
| fullnameOverride | string | `""` | A name to substitute for the full names of resources. |
2930
| globalOptions | string | `""` | Inject global options in the Caddyfile. |
3031
| image.pullPolicy | string | `"IfNotPresent"` | [Image pull policy](https://kubernetes.io/docs/concepts/containers/images/#updating-images) for updating already existing images on a node. |
@@ -37,6 +38,14 @@ To install the chart with the release name `my-release`, run the following comma
3738
| ingress.hosts | list | See [values.yaml](values.yaml). | Ingress host configuration. |
3839
| ingress.tls | list | See [values.yaml](values.yaml). | Ingress TLS configuration. |
3940
| license | string | `""` | The license key for [the High Availability version](https://mercure.rocks/docs/hub/cluster) (not necessary is you use the FOSS version). |
41+
| metrics.enabled | bool | `false` | Enable metrics. You must also add a `servers` block with a [`metrics` directive](https://caddyserver.com/docs/caddyfile/options#metrics) in the `globalOptions` value. servers { metrics } |
42+
| metrics.port | int | `2019` | The port to use for exposing the metrics. |
43+
| metrics.serviceMonitor.enabled | bool | `false` | Whether to create a ServiceMonitor for Prometheus Operator. |
44+
| metrics.serviceMonitor.honorLabels | bool | `false` | Specify honorLabels parameter to add the scrape endpoint |
45+
| metrics.serviceMonitor.interval | string | `"15s"` | The interval to use for the ServiceMonitor to scrape the metrics. |
46+
| metrics.serviceMonitor.relabelings | list | `[]` | RelabelConfigs to apply to samples before scraping |
47+
| metrics.serviceMonitor.scrapeTimeout | string | `""` | Timeout after which the scrape is ended |
48+
| metrics.serviceMonitor.selector | object | `{}` | Additional labels that can be used so ServiceMonitor will be discovered by Prometheus |
4049
| nameOverride | string | `""` | A name in place of the chart name for `app:` labels. |
4150
| nodeSelector | object | `{}` | [Node selector](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector) configuration. |
4251
| persistence | object | `{"accessMode":"ReadWriteOnce","enabled":false,"existingClaim":"","size":"1Gi","storageClass":""}` | Enable persistence using [Persistent Volume Claims](http://kubernetes.io/docs/user-guide/persistent-volumes/), only useful if you the BoltDB transport. |
@@ -51,8 +60,8 @@ To install the chart with the release name `my-release`, run the following comma
5160
| resources | object | No requests or limits. | Container resource [requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/). See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#resources) for details. |
5261
| securityContext | object | `{}` | Container [security context](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container). See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#security-context-1) for details. |
5362
| service.annotations | object | `{}` | |
63+
| service.nodePort | string | `nil` | Set this, to pin the external nodePort in case `service.type` is `NodePort`. |
5464
| service.port | int | `80` | Service port. |
55-
| service.nodePort | int | 0 | The exposed nodePort. Required when `service.type` is [`"NodePort"`](https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport). |
5665
| service.targetPort | int | `80` | Service target port. |
5766
| service.type | string | `"ClusterIP"` | Kubernetes [service type](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types). |
5867
| serviceAccount.annotations | object | `{}` | Annotations to add to the service account. |
@@ -61,5 +70,5 @@ To install the chart with the release name `my-release`, run the following comma
6170
| subscriberJwtAlg | string | `"HS256"` | The JWT algorithm to use for subscribers. |
6271
| subscriberJwtKey | string | `""` | The JWT key to use for subscribers, a random key will be generated if empty. |
6372
| tolerations | list | `[]` | [Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/) for node taints. See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#scheduling) for details. |
64-
| transportUrl | string | `"bolt:///data/mercure.db"` | The URL representation of the transport to use. |
73+
| transportUrl | string | `""` | Deprecated: The URL representation of the transport to use. |
6574

examples/chat/chart/mercure-example-chat/README.md

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,40 @@ A minimalist chat system, using Mercure and the Flask microframework to handle c
66

77
## Values
88

9-
| Key | Type | Default | Description |
10-
| ------------------------------------------ | ------ | -------------------------------------------------- | ----------- |
11-
| affinity | object | `{}` | |
12-
| autoscaling.enabled | bool | `false` | |
13-
| autoscaling.maxReplicas | int | `100` | |
14-
| autoscaling.minReplicas | int | `1` | |
15-
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
16-
| cookieDomain | string | `".mercure.rocks"` | |
17-
| fullnameOverride | string | `""` | |
18-
| hubUrl | string | `"https://demo.mercure.rocks/.well-known/mercure"` | |
19-
| image.pullPolicy | string | `"Always"` | |
20-
| image.repository | string | `"dunglas/mercure-example-chat"` | |
21-
| image.tag | string | `"latest"` | |
22-
| imagePullSecrets | list | `[]` | |
23-
| ingress.annotations | object | `{}` | |
24-
| ingress.enabled | bool | `false` | |
25-
| ingress.hosts[0].host | string | `"chart-example.local"` | |
26-
| ingress.hosts[0].paths | list | `[]` | |
27-
| ingress.tls | list | `[]` | |
28-
| jwtKey | string | `"!ChangeThisMercureHubJWTSecretKey!"` | |
29-
| messageUriTemplate | string | `"https://chat.example.com/messages/{id}"` | |
30-
| nameOverride | string | `""` | |
31-
| nodeSelector | object | `{}` | |
32-
| podAnnotations | object | `{}` | |
33-
| podSecurityContext | object | `{}` | |
34-
| replicaCount | int | `1` | |
35-
| resources | object | `{}` | |
36-
| securityContext | object | `{}` | |
37-
| service.port | int | `80` | |
38-
| service.type | string | `"ClusterIP"` | |
39-
| serviceAccount.annotations | object | `{}` | |
40-
| serviceAccount.create | bool | `true` | |
41-
| serviceAccount.name | string | `""` | |
42-
| tolerations | list | `[]` | |
43-
44-
---
9+
| Key | Type | Default | Description |
10+
|-----|------|---------|-------------|
11+
| affinity | object | `{}` | |
12+
| autoscaling.enabled | bool | `false` | |
13+
| autoscaling.maxReplicas | int | `100` | |
14+
| autoscaling.minReplicas | int | `1` | |
15+
| autoscaling.targetCPUUtilizationPercentage | int | `80` | |
16+
| cookieDomain | string | `".mercure.rocks"` | |
17+
| fullnameOverride | string | `""` | |
18+
| hubUrl | string | `"https://demo.mercure.rocks/.well-known/mercure"` | |
19+
| image.pullPolicy | string | `"Always"` | |
20+
| image.repository | string | `"dunglas/mercure-example-chat"` | |
21+
| image.tag | string | `"latest"` | |
22+
| imagePullSecrets | list | `[]` | |
23+
| ingress.annotations | object | `{}` | |
24+
| ingress.enabled | bool | `false` | |
25+
| ingress.hosts[0].host | string | `"chart-example.local"` | |
26+
| ingress.hosts[0].paths | list | `[]` | |
27+
| ingress.tls | list | `[]` | |
28+
| jwtKey | string | `"!ChangeThisMercureHubJWTSecretKey!"` | |
29+
| messageUriTemplate | string | `"https://chat.example.com/messages/{id}"` | |
30+
| nameOverride | string | `""` | |
31+
| nodeSelector | object | `{}` | |
32+
| podAnnotations | object | `{}` | |
33+
| podSecurityContext | object | `{}` | |
34+
| replicaCount | int | `1` | |
35+
| resources | object | `{}` | |
36+
| securityContext | object | `{}` | |
37+
| service.port | int | `80` | |
38+
| service.type | string | `"ClusterIP"` | |
39+
| serviceAccount.annotations | object | `{}` | |
40+
| serviceAccount.create | bool | `true` | |
41+
| serviceAccount.name | string | `""` | |
42+
| tolerations | list | `[]` | |
4543

44+
----------------------------------------------
4645
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

0 commit comments

Comments
 (0)