-
Notifications
You must be signed in to change notification settings - Fork 86
docs: explain upgrading the Node-RED version via Stacks #7444
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+75
−0
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
d8f924d
docs: explain upgrading the Node-RED version via Stacks
robmarcer b847370
docs: trim Node-RED version upgrade page to match docs style
robmarcer 5362d5a
Update docs/upgrade/nodered-version.md
robmarcer 1e72829
Update docs/upgrade/nodered-version.md
robmarcer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| --- | ||
| navTitle: Upgrading the Node-RED version | ||
| meta: | ||
| description: Upgrade the Node-RED version your self-hosted FlowFuse Instances run by creating a new Stack and moving Instances onto it. | ||
| tags: | ||
| - nodered | ||
| - stack | ||
| - upgrade | ||
| - flowfuse | ||
| - self-hosted | ||
| --- | ||
|
|
||
| # Upgrading the Node-RED version | ||
|
|
||
| A new major version of Node-RED - such as Node-RED 5.0 - does **not** arrive | ||
| through an in-editor or in-platform "update" button. The version of Node-RED an | ||
| Instance runs is defined by its [Stack](../user/concepts.md#stack). To move to a | ||
| new major version you add it as a new Stack, then point your Instances at it. | ||
|
|
||
| This page uses the move to **Node-RED 5.0** as an example, but the same steps | ||
| apply to any major Node-RED version upgrade. | ||
|
|
||
| ## Why there's no update button | ||
|
|
||
| The notification and one-click upgrade you may have seen applies to new *versions | ||
| of an existing Stack* (see [Managing Stacks](../admin/introduction.md#managing-stacks)). | ||
| Crossing a major Node-RED version is different: you create a new Stack that pins | ||
| the new container, rather than upgrading the existing Stack in place. This keeps | ||
| the two versions side by side so you can move Instances over at your own pace. | ||
| It also ensures major version upgrades are not automatically applied by the | ||
| Scheduled Maintenance feature. | ||
|
|
||
| ## Before you start | ||
|
|
||
| - You will need access to **Admin Settings**. | ||
| - Add the new Node-RED version as a **distinct new Stack** rather than editing your | ||
| existing Stack. Keeping them separate means your current Instances stay on their | ||
| existing version until you choose to move them, and you can switch back from an | ||
| Instance's settings if needed. | ||
|
|
||
| ## Create the new Stack | ||
|
|
||
| 1. Go to **Admin Settings → Stacks**. | ||
| 2. Click **Create Stack**. | ||
| 3. Set the **Container Location** to the image for the new Node-RED version. The | ||
| exact value depends on your deployment model - see the deployment-specific | ||
| guides below. For Node-RED 5.0 on Docker or Kubernetes this is | ||
| `flowfuse/node-red:2.31.2-5.0.x`; the full list of pre-built tags is on | ||
| [Docker Hub](https://hub.docker.com/r/flowfuse/node-red/tags). | ||
|
robmarcer marked this conversation as resolved.
|
||
| (tags are of the form [FlowFuse Version]-[Node-RED Version]) | ||
| 4. Save the Stack. It is now available when you create or migrate Instances. | ||
|
|
||
| For the details of how the Container Location is specified for each deployment | ||
| model, see: | ||
|
|
||
| - [Local Stacks](../contribute/local/stacks.md) | ||
| - [Docker Stacks](../install/docker/stacks.md) | ||
| - [Kubernetes Stacks](../install/kubernetes/stacks.md) | ||
|
|
||
| ## Use the new Stack | ||
|
|
||
| ### For a new Instance | ||
|
|
||
| Select the new Stack when you create the Instance. It starts on the new Node-RED | ||
| version right away. | ||
|
|
||
| ### For an existing Instance | ||
|
|
||
| Move the Instance onto the new Stack by following | ||
| [Changing the Stack](../user/changestack.md): open the Instance's **Settings** | ||
| tab and use **Change Instance Stack** to select the new Stack. The Instance | ||
| restarts on the new Stack. | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.