Skip to content

Commit 55e5916

Browse files
committed
Migration docs
1 parent 8638fc1 commit 55e5916

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

content/docs/updating.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ breaking changes, and adjust steps accordingly!** {{< /callout >}}
1111
1. Backup your database
1212

1313
```bash
14-
sudo docker compose run --rm -v $(pwd)/backup:/backup arangodb arangodump --server.endpoint tcp://a
14+
docker compose run --rm -v $(pwd)/backup:/backup arangodb arangodump --server.endpoint tcp://a
1515
rangodb:8529 --server.database yeti --output-directory /backup --overwrite true
1616
```
1717

1818
2. Backup your configuration file
1919

2020
```bash
21-
sudo docker cp api:/app/yeti.conf /path/to/backup
21+
docker cp api:/app/yeti.conf /path/to/backup
2222
```
2323

2424
3. Stop the containers
2525

2626
```bash
27-
cd yeti-docker/prod && sudo docker compose down
27+
cd yeti-docker/prod && docker compose down
2828
```
2929

3030
3. Update
@@ -38,30 +38,41 @@ cd yeti-docker/prod && sudo docker compose down
3838

3939
```bash
4040
git pull
41-
sudo docker compose pull
41+
docker compose pull
4242
```
4343

44-
4. Start the containers
44+
4. Run migrations
45+
46+
Sometimes the database schema changes between versions, and you need to run a
47+
migration command to sync the database schema and the code that Yeti is running.
48+
49+
To do so:
50+
51+
```
52+
docker compose run --rm api /docker-entrypoint.sh arangodb-migrate
53+
```
54+
55+
5. Start the containers
4556

4657
```bash
47-
sudo docker compose up -d
58+
docker compose up -d
4859
```
4960

50-
5. _(optional)_ Restore database
61+
6. _(optional)_ Restore database
5162

5263
```bash
53-
sudo docker compose run --rm -v $(pwd)/backup:/backup arangodb arangorestore --server.endpoint tcp://arangodb:8529 --input-directory /backup --server.database yeti --overwrite true
64+
docker compose run --rm -v $(pwd)/backup:/backup arangodb arangorestore --server.endpoint tcp://arangodb:8529 --input-directory /backup --server.database yeti --overwrite true
5465
```
5566

56-
6. Restore configuration file
67+
7. Restore configuration file
5768

5869
```bash
59-
sudo docker ps yeti.conf api:/app/
60-
sudo docker ps yeti.conf tasks:/app/
70+
docker ps yeti.conf api:/app/
71+
docker ps yeti.conf tasks:/app/
6172
```
6273

63-
7. Restart containers
74+
8. Restart containers
6475

6576
```bash
66-
sudo docker compose restarts tasks api
77+
docker compose restarts tasks api
6778
```

0 commit comments

Comments
 (0)