Changes impacting Self-Hosted Octopus instances with no license key configured #9828
Description
Prerequisites
- I have searched open and closed issues to make sure it isn't already requested
- My team has started working on this issue
- I have written a descriptive issue title
Breaking Changes
If your self-hosted Octopus instance doesn’t have a license key configured, upgrades can fail and leave the instance in an unstartable state. The sections below explain what changed, who is impacted, and how to recover.
Mitigation
Before upgrading, configure a license key in your Octopus instance.
You can find your license key on your subscription’s Overview page in Control Center. If you don’t have a license key, create a new subscription.
Windows
New Installation
No change. Configuring a license key is already a mandatory step during setup.
Version Upgrade
During the upgrade, Octopus reconfiguration may fail with a non-compliant license error.
Fix
If you upgrade an instance that doesn’t have a license key configured, the instance will be in an unstartable state.
To recover:
- Open Octopus Server Manager.
- Select the impacted instance.
- Select Configure license.
- Paste your license key, and click Apply.
You can find your license key on your subscription’s Overview page in Control Center. If you don’t have a license key, create a new subscription.
Linux (Docker)
New Installation
No change. The license key is still an optional env parameter in the Docker run command. However, the instance will not be usable until a license key is configured. In your instance, follow the new Add Licence Key prompt to apply your license key.
You can find your license key on your subscription’s Overview page in Control Center. If you don’t have a license key, create a new subscription.
Version Upgrade
During the upgrade, Octopus reconfiguration may fail with a non-compliant license error.
Fix
If you upgrade an instance that doesn’t have a license key configured, the instance will be in an unstartable state.
To recover, supply the OCTOPUS_SERVER_BASE64_LICENSE env parameter for the Docker run command. For information on Octopus Server Linux Container, please refer to the Octopus Documentation.