Skip to content

Commit 57afbae

Browse files
SC 4 to 5 upgrade guide: Added guidance on how to migrate away from endpoint-oriented topology (#7174)
Co-authored-by: Poornima Nayar <[email protected]>
1 parent 1e4f126 commit 57afbae

File tree

1 file changed

+35
-2
lines changed

1 file changed

+35
-2
lines changed

servicecontrol/upgrades/4to5/index.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Upgrading ServiceControl from version 4 to version 5 is a major upgrade and requ
1616
* The ServiceControl PowerShell module is no longer installed with ServiceControl. Instead, the PowerShell module can be [installed from the PowerShell Gallery](https://www.powershellgallery.com/packages/Particular.ServiceControl.Management/).
1717
* The [ServiceControl PowerShell module](https://www.powershellgallery.com/packages/Particular.ServiceControl.Management/) requires PowerShell 7.2 or greater to run.
1818
* PowerShell: The `Transport` parameter no longer accepts the DisplayName descriptions but only the Name code. See [PowerShell Transport argument](#powershell-transport-argument)
19-
20-
* ServiceControl instances using **Azure Service Bus - Endpoint-oriented topology (Legacy)** as the message transport cannot be upgraded to ServiceControl version 5. Systems using this deprecated configuration must first use the upgrade steps documented in [Azure Service Bus Transport (Legacy) Upgrade Version 9 to 9.1](/transports/upgrades/asb-9to9.1.md). After this process is complete, a ServiceControl 4.x instance can be switched to the supported **Azure Service Bus** transport, and then an upgrade to ServiceControl 5 can occur.
19+
* ServiceControl instances using **Azure Service Bus - Endpoint-oriented topology (Legacy)** as the message transport cannot be upgraded to ServiceControl version 5.
20+
* [Migrating Azure Service Bus](#migrating-azure-service-bus)
2121
* `!disable` is no longer supported as an error and/or audit queue names. Instead, dedicated settings i.e. [`ServiceControl/IngestErrorMessages`](/servicecontrol/servicecontrol-instances/configuration.md#transport-servicecontrolingesterrormessages) and [`ServiceControl/IngestAuditMessages`](/servicecontrol/audit-instances/configuration.md#transport-servicecontrolingestauditmessages) should be used to control the message ingestion process. These settings are useful for upgrade scenarios, such as the one that will be described later in this article.
2222
* The setting `IndexStoragePath` is no longer supported. Use [symbolic links (soft links) to map any storage subfolder](https://ravendb.net/docs/article-page/5.4/csharp/server/storage/customizing-raven-data-files-locations) to other physical drives.
2323
* The [`ServiceControl.Audit/RavenDBLogLevel`](/servicecontrol/audit-instances/configuration.md#host-settings-servicecontrol-auditravendbloglevel) and [`ServiceControl/RavenDBLogLevel`](/servicecontrol/servicecontrol-instances/configuration.md#host-settings-servicecontrolravendbloglevel) settings use new values. The previous values are mapped to new values native to RavenDB5.
@@ -189,3 +189,36 @@ Invoke-ServiceControlInstanceUpgrade -Name <InstanceName> -Force
189189
## Support for version 4
190190

191191
Version 4 is supported for one year after version 5 is released as defined by the [ServiceControl support policy](/servicecontrol/upgrades/support-policy.md). The ServiceControl support end-date is available at [ServiceControl supported versions](/servicecontrol/upgrades/supported-versions.md).
192+
193+
194+
## Migrating Azure Service Bus
195+
196+
ServiceControl instances using **Azure Service Bus – Endpoint-oriented topology (Legacy)** cannot be directly upgraded to version 5.
197+
198+
To upgrade, follow these steps:
199+
200+
### 1. Upgrade the Transport
201+
202+
> [!NOTE]
203+
> This step is only required if there are subscribers for [ServiceControl integration events](/servicecontrol/contracts.md).
204+
205+
Migrate those subscribers to the supported **Azure Service Bus (Forwarding Topology)** transport using the following guide:
206+
207+
- [Azure Service Bus Transport (Legacy) Upgrade Version 9 to 9.1](/transports/upgrades/asb-9to9.1.md)
208+
209+
### 2. Reconfigure ServiceControl 4.x
210+
211+
After completing the transport upgrade:
212+
213+
- Upgrade the ServiceControl instance to **v4.33.5**.
214+
- Note the **instance name** and **database folder path**.
215+
- Remove the instance via the 🔧 (advanced options), leave the "Remove DB subdirectory and data" unchecked in the Remove instance dialog.
216+
- Recreate a **new v4.33.5 instance**:
217+
- Use the **same instance name**.
218+
- Use the **same database path**.
219+
- Select the **Azure Service Bus (Forwarding Topology)** transport.
220+
221+
### 3. Upgrade to ServiceControl v5
222+
223+
Once the instance is reconfigured and running with the supported transport, you can safely upgrade to **ServiceControl v5**.
224+
With the instance now using the supported transport, you can [upgrade your error instance to **ServiceControl v5**](#upgrading-to-version-5)

0 commit comments

Comments
 (0)