docs(influxdb3): Procedures to upgrade Core to Enterprise and change license type #6758
Conversation
changing license type: 1. **Expand existing license.md page** with new sections: - "Upgrade from InfluxDB 3 Core to Enterprise" - "Change your Enterprise license type" 2. Add installation method tabs (Manual/Docker/DEB-RPM) for each workflow 3. Add cross-links in install and upgrade guides for Core and Enterprise
jstirnaman
requested review from
a team,
garylfowler and
peterbarnett03
as code owners
jstirnaman
requested review from
hiltontj,
jdstrand and
sanderson
and removed request for
a team and
garylfowler
|
@suyashcjoshi FYI |
|
PR Preview
Pages included in this preview
Preview auto-deploys on push. Will be cleaned up when PR closes. |
jdstrand
left a comment
jdstrand
left a comment
There was a problem hiding this comment.
Thanks for this PR! I think it reads well overall (but please have Product also review). While I didn't manually go through all the new instructions, I did provide some feedback (with a focus on DEB/RPM).
| ## Upgrade from InfluxDB 3 Core | ||
|
|
||
| If you're running InfluxDB 3 Core and want to upgrade to {{< product-name >}}, | ||
| follow these instructions. Your existing data is compatible with Enterprise--no |
There was a problem hiding this comment.
s/existing data is/existing data and plugins are/
| before upgrading. For more information, see [Back up and restore data](/influxdb3/core/admin/backup-restore/). | ||
|
|
||
| 2. **Note your current configuration**: Record your Core startup options, | ||
| including `--data-dir`, `--object-store`, and any other configuration. |
There was a problem hiding this comment.
Suggestion: add --plugin-dir to this list (not a blocker)
| source: ~/.influxdb3/data # Same path as Core | ||
| target: /var/lib/influxdb3/data | ||
| - type: bind | ||
| source: ~/.influxdb3/plugins |
There was a problem hiding this comment.
This should also have the # Same path as Core comment.
| - --node-id=node0 | ||
| - --cluster-id=cluster0 | ||
| - --object-store=file | ||
| - --data-dir=/var/lib/influxdb3/data |
There was a problem hiding this comment.
It's curious that volumes (below) lists the plugin directory, but it isn't listed here. I guess that is because we are allowing people to opt into it? Not a blocker, just an observation.
|
|
||
| <!-- pytest.mark.skip --> | ||
| ```bash | ||
| sudo apt-get update && sudo apt-get install influxdb3-enterprise |
There was a problem hiding this comment.
You need to first remove influxdb3-core for both DEB and RPM because the packages are not co-installable (by design to be able to share the data and plugin directories). The apt command is:
sudo apt-get remove influxdb3-core # preserves /var/lib/influxdb3 and /etc/influxdb3
The yum command is:
sudo yum remove influxdb3-core # preserves /var/lib/influxdb3 and /etc/influxdb3
Once done, then you can install influxdb3-enterprise.
| plugin-dir = "/var/lib/influxdb3/plugins" | ||
|
|
||
| # Add Enterprise-specific settings | ||
| cluster-id = "cluster0" |
There was a problem hiding this comment.
Similarly, the installation default for Enterprise DEB/RPM sets this to primary-cluster to match the default of running influxdb3 serve without the --cluster-id option.
|
|
||
| # Add Enterprise-specific settings | ||
| cluster-id = "cluster0" | ||
| license-email = "your-email@example.com" |
There was a problem hiding this comment.
If you decided to use the sed command that I gave above, you might want to talk about 'verifying' the changes rather than 'adding' (though, the user will need to adjust license-email either way).
| <!-- pytest.mark.skip --> | ||
| ```bash | ||
| sudo systemctl disable influxdb3-core | ||
| ``` |
There was a problem hiding this comment.
With the required uninstall of influxdb3-core, this is no longer needed (the systemd unit is removed when removing these packages).
| ```bash { placeholders="EMAIL" } | ||
| influxdb3 serve \ | ||
| --license-email EMAIL \ | ||
| # ... other options |
There was a problem hiding this comment.
While this technically works with the DEB/RPM installs, it is starting the service outside of systemd, starts as the user (not the influxdb3 user), doesn't use the launcher, etc, etc. I suggest breaking this up into 3 parts, like you did above for upgrading to Enterprise: quickstart, docker and DEB/RPM.
| <!-- pytest.mark.skip --> | ||
| ```bash | ||
| influxdb3 serve \ | ||
| --license-file /path/to/commercial-license.jwt \ |
There was a problem hiding this comment.
This is also possible with the DEB/RPM. It is fine to focus on --license-email for it, but I think this section should call out this is specifically for quick start and that docker and DEB/RPM are handled differently.
changing license type:
Closes #6745
Closes influxdata/dar/issues/596