Skip to content

Commit 38f8060

Browse files
committed
Updated backup/restore steps in architecture.md
1 parent e8abb76 commit 38f8060

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

doc/architecture.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,29 @@ The service provides a round-robin approach to access the nodes in the cluster.
3535
- Persistent volumes for etcd data
3636
- S3 for durable object storage
3737

38+
## Backup/Recovery
39+
All state information for the catalog is maintained in etcd. To back up the ICE REST Catalog state, you can use standard etcd snapshot tools. The official etcd documentation provides guidance on [snapshotting and recovery](https://etcd.io/docs/v3.5/op-guide/recovery/).
40+
41+
**Backup etcd Example**:
42+
```shell
43+
etcdctl --endpoints=<etcd-endpoint> \
44+
--cacert=<trusted-ca-file> \
45+
--cert=<cert-file> \
46+
--key=<key-file> \
47+
snapshot save /path/to/backup.db
48+
```
49+
50+
Replace the arguments as appropriate for your deployment (for example, endpoints, authentication, and TLS options).
51+
52+
**Restore etcd Example**:
53+
```shell
54+
etcdctl snapshot restore /path/to/backup.db \
55+
--data-dir /var/lib/etcd
56+
```
57+
58+
The ICE REST Catalog is designed such that if you restore etcd and point the catalog services at the restored etcd cluster, all catalog state (databases, tables, schemas, snapshots) will be recovered automatically.
59+
60+
**Note:** Data files themselves (table/parquet data) are stored in Object Storage (e.g., S3, MinIO), and should be backed up or protected in accordance with your object storage vendor's recommendations.
3861

3962
### k8s Manifest Files
4063

0 commit comments

Comments
 (0)