Skip to content

Commit 36b242f

Browse files
committed
docs: add user guide for UTMStack migration tool
1 parent df2846f commit 36b242f

1 file changed

Lines changed: 83 additions & 0 deletions

File tree

README.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# UTMStack Migration Tool — User Guide
2+
3+
This guide walks you through migrating an UTMStack V10 installation to V11.
4+
5+
## Installation
6+
7+
1. Download the binary from the official releases page.
8+
2. Make it executable:
9+
10+
```bash
11+
chmod +x utmstack_migration_tool
12+
```
13+
14+
3. Verify it runs:
15+
16+
```bash
17+
sudo ./utmstack_migration_tool --help
18+
```
19+
20+
You should see a list of commands. If you do, the binary is ready.
21+
22+
---
23+
24+
## Recommended workflow
25+
26+
Most users only need two commands, in this exact order:
27+
28+
```bash
29+
# Step 1: Stage the migration agent on every UTMStack agent.
30+
sudo ./utmstack_migration_tool prepare-agents
31+
32+
# Step 2: Upgrade the backend itself.
33+
sudo ./utmstack_migration_tool upgrade
34+
```
35+
36+
Run **`prepare-agents` first**, then `upgrade`. The `upgrade` command checks that
37+
`prepare-agents` already ran and refuses to start otherwise. This is on purpose:
38+
it prevents agents from being orphaned in V10 after the backend moves to V11.
39+
40+
---
41+
42+
## Commands
43+
44+
### `prepare-agents` — Stage the migration agent
45+
46+
Before upgrading the instance, every UTMStack agent must receive the
47+
`migrate_agent` binary. This command takes care of that and remembers its
48+
progress, so you can interrupt it (Ctrl+C) and resume later without losing work.
49+
50+
#### How to run it
51+
52+
On the V10 server itself:
53+
54+
```bash
55+
sudo ./utmstack_migration_tool prepare-agents
56+
```
57+
58+
### `upgrade` — In-place V10 → V11 upgrade
59+
60+
This command upgrades the intance on the same server. It is **destructive**:
61+
V10 is removed and V11 is installed in its place. There is no automatic rollback.
62+
63+
#### How to run it
64+
65+
On the V10 server itself:
66+
67+
```bash
68+
sudo ./utmstack_migration_tool upgrade
69+
```
70+
71+
72+
## Common workflows
73+
74+
### Workflow 1 — Local in-place upgrade (simplest)
75+
76+
You are sitting on the V10 server and want to upgrade it to V11 in place.
77+
78+
```bash
79+
ssh utmstack@v10-server
80+
sudo ./utmstack_migration_tool prepare-agents
81+
# wait until all agents are deployed (or Ctrl+C and accept skip)
82+
sudo ./utmstack_migration_tool upgrade
83+
```

0 commit comments

Comments
 (0)