feat: Add possibility to customize domain for MQTT broker #359
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hardillb
reviewed
Apr 5, 2024
helm/flowforge/README.md
Outdated
| @@ -85,6 +85,7 @@ To use STMP to send email | |||
| - `forge.broker.enabled` (default `false`) | |||
| - `forge.broker.url` URL to access the broker from inside the cluster (default `mqtt://flowforge-broker.[namespace]:1883`) | |||
| - `forge.broker.public_url` URL to access the broker from outside the cluster (default `ws://mqtt.[forge.domain]`, uses `wss://` if `forge.https` is `true`) | |||
| - `forge.broker.domain` the domain the broker will be hosted on (default `mgtt.[forge.domain]`) | |||
There was a problem hiding this comment.
My only thought here is that we use forge.domain to mean a domain we will append hostnames to, where as here we are using forge.broker.domain to mean a fully qualified hostname.
There was a problem hiding this comment.
I see the point. How about renaming to forge.broker.subdomain as a subdomain of forge.domain ? It will be less confusing and will probably prevent questions about self-hosting MQTT broker separately from the FlowFuse platform.
There was a problem hiding this comment.
I'm tempted to say forge.broker.hostname and label it as needing to be a FQDN (and possibility improve the forge.entrypoint doc as that is similar and very vague)
hardillb
approved these changes
Apr 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds the
forge.broker.domainconfiguration option to allow running the MQTT broker on a custom domain. It also includes updates to the chart's schema and the documentation update.The example of the FlowFuse Platform running with the broker on custom domain is available here.
Related Issue(s)
Closes #295
Checklist
flowforge.yml?FlowFuse/helmto update ConfigMap TemplateFlowFuse/CloudProjectto update values for Staging/ProductionLabels
backportlabelarea:migrationlabel