Skip to content

Commit 0671536

Browse files
[docs] Document the "Migrate" button in Integration Manager (#282)
Co-authored-by: antoinemzs <antoine.mazeas@filigran.io>
1 parent a153743 commit 0671536

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

  • docs/deployment/ecosystem/integration-manager

docs/deployment/ecosystem/integration-manager/overview.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ To learn more about Xtm Composer architecture, refer to the [dedicated documenta
4343
## Browsing the catalog
4444
- Navigate to **Integrations > Catalog**
4545
- Use the search bar to find collectors, injectors and executors by name or description. You can also apply filters (e.g., by collector, executor or injector type).
46-
- If a collector, injector or executor has already been deployed, it will no longer appear in the Catalog. Instead, youll find it in its associated page (Collectors, Injectors, or Executors).
46+
- If a collector, injector or executor has already been deployed, it will no longer appear in the Catalog. Instead, you'll find it in its associated page (Collectors, Injectors, or Executors).
4747

4848
## Deploying a collector, injector or executor
4949

@@ -70,6 +70,29 @@ To learn more about Xtm Composer architecture, refer to the [dedicated documenta
7070

7171
![Connector started](../../assets/integration-manager/connector-started.png)
7272

73+
## Migrating an existing connector
74+
75+
If you have a connector that was previously deployed manually (outside the Integration Manager), you can **migrate** it so that its settings are managed directly from the UI.
76+
77+
### Prerequisites
78+
79+
- An **Enterprise Edition license** is active
80+
- The **Integration Manager** is running
81+
- The user has the **Manage Platform Settings** permission
82+
- The connector is **external** (not built-in) and has no existing managed instance
83+
84+
### Migration flow
85+
86+
1. Navigate to the connector's card in the Catalog or its detail page. A **Migrate** button is displayed when the conditions above are met.
87+
2. Click **Migrate**. A drawer opens with the configuration form (same fields as a new deployment).
88+
3. Fill in the required configuration options.
89+
4. Click **Migrate** to confirm. The connector is re-registered under the Integration Manager, preserving its existing identifier.
90+
5. You are redirected to the new managed instance view.
91+
92+
After migration, the connector can be fully managed from the UI: start/stop, update configuration, and view logs — just like any other deployed instance.
93+
94+
The initial connector may be shut down at this point. Remove the container, or contact your customer support if the OpenAEV instance is managed by a service provider.
95+
7396
## Managing the instances
7497

7598
- Different injector, collector or executor types are identified in the catalog:

0 commit comments

Comments
 (0)